Download OpenAPI specification:Download
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 |
A FHIR resource
"{\n \"resourceType\": \"CapabilityStatement\"\n}"| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
A FHIR resource
"{\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.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-allergyintolerance.html
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 |
| clinical-status | string active | inactive | resolved |
| patient | string Who the sensitivity is for |
A FHIR resource
{ }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 |
| clinical-status | string active | inactive | resolved |
| patient | string Who the sensitivity is for |
A FHIR resource
{ }The CarePlan FHIR resource type
Base profile: http://hl7.org/fhir/R4/careplan.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-careplan.html
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 |
A FHIR resource
{ }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 |
A FHIR resource
{ }The CareTeam FHIR resource type
Base profile: http://hl7.org/fhir/R4/careteam.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-careteam.html
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 |
A FHIR resource
{ }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 |
A FHIR resource
{ }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 |
A FHIR 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 |
A FHIR resource
{ }The Device FHIR resource type
Base profile: http://hl7.org/fhir/R4/device.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-implantable-device.html
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 |
| type | string The type of the device |
| patient | string Patient information, if the resource is affixed to a person |
A FHIR resource
{ }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 |
| type | string The type of the device |
| patient | string Patient information, if the resource is affixed to a person |
A FHIR resource
{ }The DiagnosticReport FHIR resource type
Base profile: http://hl7.org/fhir/R4/diagnosticreport.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-diagnosticreport-lab.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-diagnosticreport-note.html
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 |
A FHIR resource
{ }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 |
A FHIR resource
{ }The DocumentReference FHIR resource type
Base profile: http://hl7.org/fhir/R4/documentreference.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-documentreference.html
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 The ID of the resource |
| category | string Categorization of document |
| status | string current | superseded | entered-in-error |
A FHIR resource
{ }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 The ID of the resource |
| category | string Categorization of document |
| status | string current | superseded | entered-in-error |
A FHIR resource
{ }The Encounter FHIR resource type
Base profile: http://hl7.org/fhir/R4/encounter.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-encounter.html
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 The ID of the resource |
| class | string Classification of patient encounter |
| status | string planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
A FHIR resource
{ }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 The ID of the resource |
| class | string Classification of patient encounter |
| status | string planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
A FHIR resource
{ }The Goal FHIR resource type
Base profile: http://hl7.org/fhir/R4/goal.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-goal.html
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 |
A FHIR resource
{ }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 |
A FHIR resource
{ }The Group FHIR resource type
Base profile: http://hl7.org/fhir/R4/group.html
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 |
A FHIR resource
{ }| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
A FHIR resource
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 |
A FHIR resource
{ }| 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 |
| _typeFilter | string |
| _typePostFetchFilterUrl | string |
| _exportId | string |
| _mdm | string |
| patient | string |
A FHIR resource
{ }| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| id required | string >= 1 Example: 123 The resource ID |
A FHIR resource
"{\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\": \"_typeFilter\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_typePostFetchFilterUrl\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_exportId\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_mdm\",\n \"valueBoolean\": false\n }, {\n \"name\": \"patient\",\n \"valueString\": \"example\"\n } ]\n}"{ }The Immunization FHIR resource type
Base profile: http://hl7.org/fhir/R4/immunization.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-immunization.html
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 |
A FHIR resource
{ }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 |
A FHIR resource
{ }The Location FHIR resource type
Base profile: http://hl7.org/fhir/R4/location.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-location.html
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 |
A FHIR resource
{ }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 |
A FHIR resource
{ }The Medication FHIR resource type
Base profile: http://hl7.org/fhir/R4/medication.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-medication.html
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string Returns medications with this external identifier |
A FHIR resource
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| identifier | string Returns medications with this external identifier |
A FHIR resource
{ }The MedicationRequest FHIR resource type
Base profile: http://hl7.org/fhir/R4/medicationrequest.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-medicationrequest.html
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 |
A FHIR resource
{ }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 |
A FHIR resource
{ }The Observation FHIR resource type
Note: Smoking status, 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 |
A FHIR 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 |
A FHIR resource
{ }The Organization FHIR resource type
Base profile: http://hl7.org/fhir/R4/organization.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-organization.html
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 |
A FHIR resource
{ }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 |
A FHIR resource
{ }The Patient FHIR resource type
Base profile: http://hl7.org/fhir/R4/patient.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-patient.html
Supported profile: https://hl7.org/fhir/us/core/STU6/StructureDefinition-us-core-patient.html - genderIdentity Extension
This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| given | string A portion of the given name of the patient |
| identifier | string A patient identifier |
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 The ID of the resource |
| family | string A portion of the family name of the patient |
A FHIR resource
{ }This is a search type
| tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
| given | string A portion of the given name of the patient |
| identifier | string A patient identifier |
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 The ID of the resource |
| family | string A portion of the family name of the patient |
A FHIR resource
{ }The Practitioner FHIR resource type
Base profile: http://hl7.org/fhir/R4/practitioner.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitioner.html
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 The ID of the resource |
A FHIR resource
{ }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 The ID of the resource |
A FHIR resource
{ }The Procedure FHIR resource type
Base profile: http://hl7.org/fhir/R4/procedure.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-procedure.html
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 |
A FHIR resource
{ }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 |
A FHIR resource
{ }The Provenance FHIR resource type
Base profile: http://hl7.org/fhir/R4/provenance.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-provenance.html
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) |
A FHIR resource
{ }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) |
A FHIR resource
{ }