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}"
null
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 | any External ids for this item |
clinical-status | any active | inactive | resolved
|
lastUpdated | any |
versionId | any |
patient | any Who the sensitivity is for |
tag | any |
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
identifier | any External ids for this item |
clinical-status | any active | inactive | resolved
|
lastUpdated | any |
versionId | any |
patient | any Who the sensitivity is for |
tag | any |
A FHIR resource
null
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 |
date | any Time period plan covers |
identifier | any External Ids for this plan |
lastUpdated | any |
versionId | any |
patient | any Who the care plan is for |
tag | any |
category | any Type of plan
|
status | any draft | active | on-hold | revoked | completed | entered-in-error | unknown
|
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
date | any Time period plan covers |
identifier | any External Ids for this plan |
lastUpdated | any |
versionId | any |
patient | any Who the care plan is for |
tag | any |
category | any Type of plan
|
status | any draft | active | on-hold | revoked | completed | entered-in-error | unknown
|
A FHIR resource
null
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 | any External Ids for this team |
lastUpdated | any |
versionId | any |
patient | any Who care team is for |
tag | any |
status | any proposed | active | suspended | inactive | entered-in-error
|
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
identifier | any External Ids for this team |
lastUpdated | any |
versionId | any |
patient | any Who care team is for |
tag | any |
status | any proposed | active | suspended | inactive | entered-in-error
|
A FHIR resource
null
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 | any A unique identifier of the condition record |
code | any Code for the condition |
clinical-status | any The clinical status of the condition
|
encounter | any Encounter created as part of |
onset-date | any Date related onsets (dateTime and Period)
|
lastUpdated | any |
security | any |
versionId | any |
patient | any Who has the condition? |
tag | any |
category | any The category of the condition
|
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
identifier | any A unique identifier of the condition record |
code | any Code for the condition |
clinical-status | any The clinical status of the condition
|
encounter | any Encounter created as part of |
onset-date | any Date related onsets (dateTime and Period)
|
lastUpdated | any |
security | any |
versionId | any |
patient | any Who has the condition? |
tag | any |
category | any The category of the condition
|
A FHIR resource
null
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 | any Instance id from manufacturer, owner, and others |
type | any The type of the device
|
lastUpdated | any |
versionId | any |
patient | any Patient information, if the resource is affixed to a person
|
tag | any |
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
identifier | any Instance id from manufacturer, owner, and others |
type | any The type of the device
|
lastUpdated | any |
versionId | any |
patient | any Patient information, if the resource is affixed to a person
|
tag | any |
A FHIR resource
null
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 |
date | any The clinically relevant time of the report |
identifier | any An identifier for the report |
code | any 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 |
lastUpdated | any |
versionId | any |
patient | any The subject of the report if a patient |
tag | any |
category | any Which diagnostic discipline/department created the report
|
status | any The status of the report
|
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
date | any The clinically relevant time of the report |
identifier | any An identifier for the report |
code | any 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 |
lastUpdated | any |
versionId | any |
patient | any The subject of the report if a patient |
tag | any |
category | any Which diagnostic discipline/department created the report
|
status | any The status of the report
|
A FHIR resource
null
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 |
date | any When this document reference was created
|
identifier | any Master Version Specific Identifier |
period | any 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 | any Kind of document (LOINC if possible) |
lastUpdated | any |
versionId | any |
patient | any Who/what is the subject of the document |
tag | any |
_id | any The ID of the resource |
category | any Categorization of document
|
status | any current | superseded | entered-in-error
|
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
date | any When this document reference was created
|
identifier | any Master Version Specific Identifier |
period | any 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 | any Kind of document (LOINC if possible) |
lastUpdated | any |
versionId | any |
patient | any Who/what is the subject of the document |
tag | any |
_id | any The ID of the resource |
category | any Categorization of document
|
status | any current | superseded | entered-in-error
|
A FHIR resource
null
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 |
date | any A date within the period the Encounter lasted |
identifier | any Identifier(s) by which this encounter is known |
type | any Specific type of encounter |
lastUpdated | any |
versionId | any |
patient | any The patient or group present at the encounter |
tag | any |
_id | any The ID of the resource |
class | any Classification of patient encounter
|
status | any planned | arrived | triaged | in-progress | onleave | finished | cancelled +
|
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
date | any A date within the period the Encounter lasted |
identifier | any Identifier(s) by which this encounter is known |
type | any Specific type of encounter |
lastUpdated | any |
versionId | any |
patient | any The patient or group present at the encounter |
tag | any |
_id | any The ID of the resource |
class | any Classification of patient encounter
|
status | any planned | arrived | triaged | in-progress | onleave | finished | cancelled +
|
A FHIR resource
null
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 | any External Ids for this goal |
lastUpdated | any |
versionId | any |
lifecycle-status | any proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
|
patient | any Who this goal is intended for |
tag | any |
target-date | any Reach goal on or before
|
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
identifier | any External Ids for this goal |
lastUpdated | any |
versionId | any |
lifecycle-status | any proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
|
patient | any Who this goal is intended for |
tag | any |
target-date | any Reach goal on or before
|
A FHIR resource
null
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 | any Descriptive or actual |
identifier | any Unique id |
managing-entity | any Entity that is the custodian of the Group's definition |
code | any The kind of resources contained |
type | any The type of resources the group contains |
characteristic | any Kind of characteristic |
lastUpdated | any |
security | any |
versionId | any |
member | any Reference to the group member |
exclude | any Group includes or excludes |
tag | any |
value | any Value held by characteristic |
A FHIR resource
null
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
A FHIR resource
A FHIR resource
"{\n \"resourceType\": \"Group\"\n}"
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
actual | any Descriptive or actual |
identifier | any Unique id |
managing-entity | any Entity that is the custodian of the Group's definition |
code | any The kind of resources contained |
type | any The type of resources the group contains |
characteristic | any Kind of characteristic |
lastUpdated | any |
security | any |
versionId | any |
member | any Reference to the group member |
exclude | any Group includes or excludes |
tag | any |
value | any Value held by characteristic |
A FHIR resource
null
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
id required | string >= 1 Example: 123 The resource ID |
_outputFormat | any |
_type | any |
_since | any |
_typeFilter | any |
_typePostFetchFilterUrl | any |
_exportId | any |
_mdm | any |
patient | any |
A FHIR resource
null
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}"
null
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 |
date | any Vaccination (non)-Administration Date |
identifier | any Business identifier |
lastUpdated | any |
versionId | any |
patient | any The patient for the vaccination record |
tag | any |
status | any Immunization event status
|
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
date | any Vaccination (non)-Administration Date |
identifier | any Business identifier |
lastUpdated | any |
versionId | any |
patient | any The patient for the vaccination record |
tag | any |
status | any Immunization event status
|
A FHIR resource
null
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 | any An identifier for the location |
address | any A (part of the) address of the location
|
address-state | any A state specified in an address
|
address-postalcode | any A postal code specified in an address
|
lastUpdated | any |
versionId | any |
name | any A portion of the location's name or alias
|
tag | any |
address-city | any A city specified in an address
|
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
identifier | any An identifier for the location |
address | any A (part of the) address of the location
|
address-state | any A state specified in an address
|
address-postalcode | any A postal code specified in an address
|
lastUpdated | any |
versionId | any |
name | any A portion of the location's name or alias
|
tag | any |
address-city | any A city specified in an address
|
A FHIR resource
null
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 | any Returns medications with this external identifier |
lastUpdated | any |
versionId | any |
tag | any |
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
identifier | any Returns medications with this external identifier |
lastUpdated | any |
versionId | any |
tag | any |
A FHIR resource
null
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 | any Return prescriptions with this external identifier |
authoredon | any Return prescriptions written on this date
|
medication | any Return prescriptions for this medication reference |
encounter | any Return prescriptions with this encounter identifier
|
intent | any Returns prescriptions with different intents
|
lastUpdated | any |
versionId | any |
patient | any Returns prescriptions for a specific patient |
tag | any |
status | any Status of the prescription |
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
identifier | any Return prescriptions with this external identifier |
authoredon | any Return prescriptions written on this date
|
medication | any Return prescriptions for this medication reference |
encounter | any Return prescriptions with this encounter identifier
|
intent | any Returns prescriptions with different intents
|
lastUpdated | any |
versionId | any |
patient | any Returns prescriptions for a specific patient |
tag | any |
status | any Status of the prescription |
A FHIR resource
null
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 |
date | any Obtained date/time. If the obtained element is a period, a date that falls in the period |
identifier | any The unique id for a particular observation |
code | any The code of the observation type |
lastUpdated | any |
versionId | any |
patient | any The subject that the observation is about (if patient) |
tag | any |
category | any The classification of the type of observation
|
status | any The status of the observation
|
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
date | any Obtained date/time. If the obtained element is a period, a date that falls in the period |
identifier | any The unique id for a particular observation |
code | any The code of the observation type |
lastUpdated | any |
versionId | any |
patient | any The subject that the observation is about (if patient) |
tag | any |
category | any The classification of the type of observation
|
status | any The status of the observation
|
A FHIR resource
null
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 | any A portion of the organization's identifier
|
address | any 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
|
lastUpdated | any |
versionId | any |
name | any A portion of the organization's name or alias
|
tag | any |
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
identifier | any A portion of the organization's identifier
|
address | any 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
|
lastUpdated | any |
versionId | any |
name | any A portion of the organization's name or alias
|
tag | any |
A FHIR resource
null
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
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
identifier | any A patient identifier
|
given | any A portion of the given name of the patient |
birthdate | any The patient's date of birth |
gender | any Gender of the patient |
general-practitioner | any Patient's nominated general practitioner, not the organization that manages the record |
lastUpdated | any |
versionId | any |
organization | any The organization that is the custodian of the patient record |
name | any A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
|
tag | any |
_id | any The ID of the resource |
family | any A portion of the family name of the patient |
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
identifier | any A patient identifier
|
given | any A portion of the given name of the patient |
birthdate | any The patient's date of birth |
gender | any Gender of the patient |
general-practitioner | any Patient's nominated general practitioner, not the organization that manages the record |
lastUpdated | any |
versionId | any |
organization | any The organization that is the custodian of the patient record |
name | any A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
|
tag | any |
_id | any The ID of the resource |
family | any A portion of the family name of the patient |
A FHIR resource
null
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 | any A practitioner's Identifier
|
lastUpdated | any |
versionId | any |
name | any A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
|
tag | any |
_id | any The ID of the resource |
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
identifier | any A practitioner's Identifier
|
lastUpdated | any |
versionId | any |
name | any A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
|
tag | any |
_id | any The ID of the resource |
A FHIR resource
null
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 |
date | any When the procedure was performed |
identifier | any A unique identifier for a procedure |
code | any A code to identify a procedure |
lastUpdated | any |
versionId | any |
patient | any Search by subject - a patient |
tag | any |
status | any preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
|
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
date | any When the procedure was performed |
identifier | any A unique identifier for a procedure |
code | any A code to identify a procedure |
lastUpdated | any |
versionId | any |
patient | any Search by subject - a patient |
tag | any |
status | any preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
|
A FHIR resource
null
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 |
target | any Target Reference(s) (usually version specific) |
lastUpdated | any |
versionId | any |
patient | any Target Reference(s) (usually version specific) |
tag | any |
A FHIR resource
null
This is a search type
tenantId required | string >= 1 Example: DEFAULT The name of the tenant to target |
target | any Target Reference(s) (usually version specific) |
lastUpdated | any |
versionId | any |
patient | any Target Reference(s) (usually version specific) |
tag | any |
A FHIR resource
null