Download OpenAPI specification:
API Error Codes:
400 Bad Request
401 Client Unauthorized
403 Forbidden
404 Not Found
500 Internal Error
405 Method Not Allowed
501 Not Implemented
422 Unprocessable Entity
409 Conflict
410 Gone
412 Precondition Failed
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
"{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"_jobId\",\n \"valueString\": \"example\"\n } ]\n}"{ }The AllergyIntolerance FHIR resource type
Base profile: http://hl7.org/fhir/R4/allergyintolerance
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance|3.1.1
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance|6.1.0
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string External ids for this item |
| patient | string Who the sensitivity is for |
| clinical-status | string active | inactive | resolved |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string External ids for this item |
| patient | string Who the sensitivity is for |
| clinical-status | string active | inactive | resolved |
{ }The CarePlan FHIR resource type
Base profile: http://hl7.org/fhir/R4/careplan
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan|3.1.1
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
string or string Time period plan covers | |
| identifier | string External Ids for this plan |
| patient | string Who the care plan is for |
| category | string Type of plan |
| status | string draft | active | on-hold | revoked | completed | entered-in-error | unknown |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
string or string Time period plan covers | |
| identifier | string External Ids for this plan |
| patient | string Who the care plan is for |
| category | string Type of plan |
| status | string draft | active | on-hold | revoked | completed | entered-in-error | unknown |
{ }The CareTeam FHIR resource type
Base profile: http://hl7.org/fhir/R4/careteam
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam|3.1.1
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam|6.1.0
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string External Ids for this team |
| patient | string Who care team is for |
| status | string proposed | active | suspended | inactive | entered-in-error |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string External Ids for this team |
| patient | string Who care team is for |
| status | string proposed | active | suspended | inactive | entered-in-error |
{ }The Condition FHIR resource type
Note: Health concerns and Problem lists are available through the Condition resource
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string A unique identifier of the condition record |
| code | string Code for the condition |
| clinical-status | string The clinical status of the condition |
| encounter | string Encounter created as part of |
string or string Date related onsets (dateTime and Period) | |
| patient | string Who has the condition? |
| category | string The category of the condition |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string A unique identifier of the condition record |
| code | string Code for the condition |
| clinical-status | string The clinical status of the condition |
| encounter | string Encounter created as part of |
string or string Date related onsets (dateTime and Period) | |
| patient | string Who has the condition? |
| category | string The category of the condition |
{ }The Coverage FHIR resource type
Base profile: http://hl7.org/fhir/R4/coverage
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-coverage|6.1.0
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string The primary identifier of the insured and the coverage |
| patient | string Retrieve coverages for a patient |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string The primary identifier of the insured and the coverage |
| patient | string Retrieve coverages for a patient |
{ }The Device FHIR resource type
Base profile: http://hl7.org/fhir/R4/device
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device|3.1.1
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device|6.1.0
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string Instance id from manufacturer, owner, and others |
| patient | string Patient information, if the resource is affixed to a person |
| type | string The type of the device |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string Instance id from manufacturer, owner, and others |
| patient | string Patient information, if the resource is affixed to a person |
| type | string The type of the device |
{ }The DiagnosticReport FHIR resource type
Base profile: http://hl7.org/fhir/R4/diagnosticreport
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab|3.1.1
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note|3.1.1
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
string or string The clinically relevant time of the report | |
| identifier | string An identifier for the report |
| code | string The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result |
| patient | string The subject of the report if a patient |
| category | string Which diagnostic discipline/department created the report |
| status | string The status of the report |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
string or string The clinically relevant time of the report | |
| identifier | string An identifier for the report |
| code | string The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result |
| patient | string The subject of the report if a patient |
| category | string Which diagnostic discipline/department created the report |
| status | string The status of the report |
{ }The DocumentReference FHIR resource type
Base profile: http://hl7.org/fhir/R4/documentreference
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference|3.1.1
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference|6.1.0
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
string or string When this document reference was created | |
| identifier | string Master Version Specific Identifier |
string or string Time of service that is being documented When used for searching for CCD documents (type=http://loinc.org|34133-9 OR type=34133-9), a subset of the FHIR specification is allowed:
| |
| type | string Kind of document (LOINC if possible) |
| patient | string Who/what is the subject of the document |
| _id | string Logical id of this artifact |
| category | string Categorization of document |
| status | string current | superseded | entered-in-error |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
string or string When this document reference was created | |
| identifier | string Master Version Specific Identifier |
string or string Time of service that is being documented When used for searching for CCD documents (type=http://loinc.org|34133-9 OR type=34133-9), a subset of the FHIR specification is allowed:
| |
| type | string Kind of document (LOINC if possible) |
| patient | string Who/what is the subject of the document |
| _id | string Logical id of this artifact |
| category | string Categorization of document |
| status | string current | superseded | entered-in-error |
{ }The Encounter FHIR resource type
Base profile: http://hl7.org/fhir/R4/encounter
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter|3.1.1
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
string or string A date within the period the Encounter lasted | |
| identifier | string Identifier(s) by which this encounter is known |
| type | string Specific type of encounter |
| patient | string The patient or group present at the encounter |
| _id | string Logical id of this artifact |
| class | string Classification of patient encounter |
| status | string planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
string or string A date within the period the Encounter lasted | |
| identifier | string Identifier(s) by which this encounter is known |
| type | string Specific type of encounter |
| patient | string The patient or group present at the encounter |
| _id | string Logical id of this artifact |
| class | string Classification of patient encounter |
| status | string planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
{ }The Goal FHIR resource type
Base profile: http://hl7.org/fhir/R4/goal
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal|3.1.1
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal|6.1.0
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string External Ids for this goal |
| lifecycle-status | string proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected |
| patient | string Who this goal is intended for |
string or string Reach goal on or before |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string External Ids for this goal |
| lifecycle-status | string proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected |
| patient | string Who this goal is intended for |
string or string Reach goal on or before |
{ }The Group FHIR resource type
Base profile: http://hl7.org/fhir/R4/group
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| actual | string Descriptive or actual |
| identifier | string Unique id |
| managing-entity | string Entity that is the custodian of the Group's definition |
| code | string The kind of resources contained |
| type | string The type of resources the group contains |
| characteristic | string Kind of characteristic |
| member | string Reference to the group member |
| exclude | string Group includes or excludes |
| value | string Value held by characteristic |
{ }| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
A FHIR resource
"{\n \"resourceType\": \"Group\"\n}"{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| actual | string Descriptive or actual |
| identifier | string Unique id |
| managing-entity | string Entity that is the custodian of the Group's definition |
| code | string The kind of resources contained |
| type | string The type of resources the group contains |
| characteristic | string Kind of characteristic |
| member | string Reference to the group member |
| exclude | string Group includes or excludes |
| value | string Value held by characteristic |
{ }| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| id required | string >= 1 Example: 123 The resource ID |
| _outputFormat | string |
| _type | string |
| _since | string |
| _until | string |
| _typeFilter | string |
| _typePostFetchFilterUrl | string |
| _exportId | string |
| _includeHistory | string |
| _mdm | string |
{ }| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| id required | string >= 1 Example: 123 The resource ID |
"{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"_outputFormat\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_type\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_since\"\n }, {\n \"name\": \"_until\"\n }, {\n \"name\": \"_typeFilter\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_typePostFetchFilterUrl\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_exportId\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_includeHistory\",\n \"valueBoolean\": false\n }, {\n \"name\": \"_mdm\",\n \"valueBoolean\": false\n }, {\n \"name\": \"patient\"\n } ]\n}"{ }The Immunization FHIR resource type
Base profile: http://hl7.org/fhir/R4/immunization
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization|3.1.1
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization|6.1.0
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
string or string Vaccination (non)-Administration Date | |
| identifier | string Business identifier |
| patient | string The patient for the vaccination record |
| status | string Immunization event status |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
string or string Vaccination (non)-Administration Date | |
| identifier | string Business identifier |
| patient | string The patient for the vaccination record |
| status | string Immunization event status |
{ }The Location FHIR resource type
Base profile: http://hl7.org/fhir/R4/location
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-location|3.1.1
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-location|6.1.0
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string An identifier for the location |
| address | string A (part of the) address of the location |
| address-state | string A state specified in an address |
| address-postalcode | string A postal code specified in an address |
| name | string A portion of the location's name or alias |
| address-city | string A city specified in an address |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string An identifier for the location |
| address | string A (part of the) address of the location |
| address-state | string A state specified in an address |
| address-postalcode | string A postal code specified in an address |
| name | string A portion of the location's name or alias |
| address-city | string A city specified in an address |
{ }The Medication FHIR resource type
Base profile: http://hl7.org/fhir/R4/medication
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication|3.1.1
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication|6.1.0
The MedicationDispense FHIR resource type
Base profile: http://hl7.org/fhir/R4/medicationdispense
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense|6.1.0
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string Returns dispenses with this external identifier |
| patient | string The identity of a patient to list dispenses for |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string Returns dispenses with this external identifier |
| patient | string The identity of a patient to list dispenses for |
{ }The MedicationRequest FHIR resource type
Base profile: http://hl7.org/fhir/R4/medicationrequest
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest|3.1.1
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest|6.1.0
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string Return prescriptions with this external identifier |
string or string Return prescriptions written on this date | |
| medication | string Return prescriptions for this medication reference |
| encounter | string Multiple Resources:
|
| intent | string Returns prescriptions with different intents |
| patient | string Returns prescriptions for a specific patient |
| status | string Status of the prescription |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string Return prescriptions with this external identifier |
string or string Return prescriptions written on this date | |
| medication | string Return prescriptions for this medication reference |
| encounter | string Multiple Resources:
|
| intent | string Returns prescriptions with different intents |
| patient | string Returns prescriptions for a specific patient |
| status | string Status of the prescription |
{ }The Observation FHIR resource type
Note: Smoking status, Occupation, Sexual Orientation, Vital signs, and Lab results are available through the Observation resource
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
string or string Obtained date/time. If the obtained element is a period, a date that falls in the period | |
| identifier | string The unique id for a particular observation |
| code | string The code of the observation type |
| patient | string The subject that the observation is about (if patient) |
| category | string The classification of the type of observation |
| status | string The status of the observation |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
string or string Obtained date/time. If the obtained element is a period, a date that falls in the period | |
| identifier | string The unique id for a particular observation |
| code | string The code of the observation type |
| patient | string The subject that the observation is about (if patient) |
| category | string The classification of the type of observation |
| status | string The status of the observation |
{ }The Organization FHIR resource type
Base profile: http://hl7.org/fhir/R4/organization
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization|3.1.1
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization|6.1.0
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string Any identifier for the organization (not the accreditation issuer's identifier) |
| address | string A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
| name | string A portion of the organization's name or alias |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string Any identifier for the organization (not the accreditation issuer's identifier) |
| address | string A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
| name | string A portion of the organization's name or alias |
{ }The Patient FHIR resource type
Base profile: http://hl7.org/fhir/R4/patient
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|3.1.1
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|6.1.0
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string A patient identifier |
| given | string A portion of the given name of the patient |
string or string The patient's date of birth | |
| gender | string Gender of the patient |
| general-practitioner | string Patient's nominated general practitioner, not the organization that manages the record |
| organization | string The organization that is the custodian of the patient record |
| name | string A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
| _id | string Logical id of this artifact |
| family | string A portion of the family name of the patient |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string A patient identifier |
| given | string A portion of the given name of the patient |
string or string The patient's date of birth | |
| gender | string Gender of the patient |
| general-practitioner | string Patient's nominated general practitioner, not the organization that manages the record |
| organization | string The organization that is the custodian of the patient record |
| name | string A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
| _id | string Logical id of this artifact |
| family | string A portion of the family name of the patient |
{ }The Practitioner FHIR resource type
Base profile: http://hl7.org/fhir/R4/practitioner
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|3.1.1
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|6.1.0
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string A practitioner's Identifier |
| name | string A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
| _id | string Logical id of this artifact |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string A practitioner's Identifier |
| name | string A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
| _id | string Logical id of this artifact |
{ }The PractitionerRole FHIR resource type
Base profile: http://hl7.org/fhir/R4/practitionerrole
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole|6.1.0
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string A practitioner's Identifier |
| endpoint | string Technical endpoints providing access to services operated for the practitioner with this role |
| specialty | string The practitioner has this specialty at an organization |
| practitioner | string Practitioner that is able to provide the defined services for the organization |
| _id | string Logical id of this artifact |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string A practitioner's Identifier |
| endpoint | string Technical endpoints providing access to services operated for the practitioner with this role |
| specialty | string The practitioner has this specialty at an organization |
| practitioner | string Practitioner that is able to provide the defined services for the organization |
| _id | string Logical id of this artifact |
{ }The Procedure FHIR resource type
Base profile: http://hl7.org/fhir/R4/procedure
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure|3.1.1
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
string or string When the procedure was performed | |
| identifier | string A unique identifier for a procedure |
| code | string A code to identify a procedure |
| patient | string Search by subject - a patient |
| status | string preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
string or string When the procedure was performed | |
| identifier | string A unique identifier for a procedure |
| code | string A code to identify a procedure |
| patient | string Search by subject - a patient |
| status | string preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
{ }The Provenance FHIR resource type
Base profile: http://hl7.org/fhir/R4/provenance
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance|3.1.1
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance|6.1.0
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| patient | string Target Reference(s) (usually version specific) |
| target | string Target Reference(s) (usually version specific) |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| patient | string Target Reference(s) (usually version specific) |
| target | string Target Reference(s) (usually version specific) |
{ }The RelatedPerson FHIR resource type
Base profile: http://hl7.org/fhir/R4/relatedperson
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson|6.1.0
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string An Identifier of the RelatedPerson |
| patient | string The patient this related person is related to |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string An Identifier of the RelatedPerson |
| patient | string The patient this related person is related to |
{ }The ServiceRequest FHIR resource type
Base profile: http://hl7.org/fhir/R4/servicerequest
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-servicerequest|6.1.0
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
string or string Date request signed | |
| identifier | string Identifiers assigned to this order |
| code | string What is being requested/ordered |
| patient | string Search by subject - a patient |
| category | string Classification of service |
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
string or string Date request signed | |
| identifier | string Identifiers assigned to this order |
| code | string What is being requested/ordered |
| patient | string Search by subject - a patient |
| category | string Classification of service |
{ }The Specimen FHIR resource type
Base profile: http://hl7.org/fhir/R4/specimen
Supported profile: http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen|6.1.0