FHIRBase (Preview)
Microsoft FHIR Server Connector for FHIR R4 Base resources.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Microsoft Health |
| URL | https://github.com/microsoft/health-architectures |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
| Website | https://www.microsoft.com |
| Privacy Policy | https://privacy.microsoft.com/privacystatement |
| Categories | Data |
The healthcare industry is rapidly transforming health data to the emerging standard of FHIR (Fast Healthcare Interoperability Resources). FHIR enables a robust, extensible data model with standardized semantics and data exchange that enables all systems using FHIR to work together.
The Microsoft FHIRBase Connector works with:
Azure API for FHIR - A PaaS offering in Azure, easily provisioned in the Azure portal and managed by Microsoft. https://docs.microsoft.com/azure/healthcare-apis/fhir-paas-portal-quickstart
FHIR Server for Azure - An open-source project that can be deployed into your Azure subscription, available on GitHub at https://github.com/Microsoft/fhir-server.
Prerequisites
You will need the following to proceed:
- An Azure subscription
- Microsoft FHIR Service (either API for FHIR or FHIR Server for Azure)
How to authenticate
FHIR Connectors work with Microsoft Entra ID and OAuth authentication. For OSS deployments an API App for authentication is needed. For more information and templates see https://microsoft.github.io/health-architectures/
Known issues and limitations
FHIR Connectors are limited to essential Resources only, ie Patient, Appointments, etc. For a list of supported FHIR resources visit https://microsoft.github.io/health-architectures/
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| URL of the FHIR Server | string | FHIR server. | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Appointment Response |
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection. |
| Delete Appointment ID |
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). |
|
Delete Appointment |
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection. |
| Delete Device ID |
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. |
| Delete Encounter ID |
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. |
| DELETE Flag ID |
Prospective warnings of potential issues when providing care to the patient. |
| Delete Location ID |
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. |
| Delete Patient ID |
Demographics and other administrative information about an individual or animal receiving care or other health-related services. |
| Delete Person ID |
Demographics and administrative information about a person independent of a specific health-related context. |
| Delete Practitioner ID |
A person who is directly or indirectly involved in the provisioning of healthcare. |
| Get Appointment |
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). |
| Get Appointment History |
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection. |
| Get Appointment History |
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). |
| Get Appointment ID |
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). |
| Get Appointment ID History |
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). |
| Get Appointment ID History |
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). |
| Get Appointment Response History |
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection. |
|
Get Appointment |
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection. |
| Get Device |
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. |
| Get Device History |
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. |
| Get Device ID |
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. |
| Get Device ID History |
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. |
| Get Device ID Version |
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. |
| Get Encounter |
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. |
| Get Encounter ID |
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. |
| Get Encounter ID History |
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. |
| Get Encounter ID Version |
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. |
| Get Enouncter History |
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. |
| Get Flag |
Prospective warnings of potential issues when providing care to the patient. |
| Get Flag History |
Prospective warnings of potential issues when providing care to the patient. |
| Get Flag ID |
Prospective warnings of potential issues when providing care to the patient. |
| Get Flag ID History |
Prospective warnings of potential issues when providing care to the patient. |
| Get Flag ID Version |
Prospective warnings of potential issues when providing care to the patient. |
| Get Location |
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. |
| Get Location History |
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. |
| Get Location ID |
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. |
| Get Location ID History |
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. |
| Get Location Version |
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. |
| Get Patient |
Demographics and other administrative information about an individual or animal receiving care or other health-related services. |
| Get Patient History |
Demographics and other administrative information about an individual or animal receiving care or other health-related services. |
| Get Patient ID |
Demographics and other administrative information about an individual or animal receiving care or other health-related services. |
| Get Patient ID History |
Demographics and other administrative information about an individual or animal receiving care or other health-related services. |
| Get Patient ID Version |
Demographics and other administrative information about an individual or animal receiving care or other health-related services. |
| Get Person |
Demographics and administrative information about a person independent of a specific health-related context. |
| Get Person History |
Demographics and administrative information about a person independent of a specific health-related context. |
| Get Person ID |
Demographics and administrative information about a person independent of a specific health-related context. |
| Get Person ID History |
Demographics and administrative information about a person independent of a specific health-related context. |
| Get Person ID Version |
Demographics and administrative information about a person independent of a specific health-related context. |
| Get Pracitioner ID History |
A person who is directly or indirectly involved in the provisioning of healthcare. |
| Get Practitioner |
A person who is directly or indirectly involved in the provisioning of healthcare. |
| Get Practitioner History |
A person who is directly or indirectly involved in the provisioning of healthcare. |
| Get Practitioner ID |
A person who is directly or indirectly involved in the provisioning of healthcare. |
| Get Practitioner ID Version |
A person who is directly or indirectly involved in the provisioning of healthcare. |
| Post Appointment |
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). |
| Post Appointment Response |
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection. |
| Post Appointment Response ID |
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection. |
| Post Device |
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. |
| Post Encounter |
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. |
| Post Flag |
Prospective warnings of potential issues when providing care to the patient. |
| Post Location |
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. |
| Post Patient |
Demographics and other administrative information about an individual or animal receiving care or other health-related services. |
| Post Person |
Demographics and administrative information about a person independent of a specific health-related context. |
| Post Practitioner |
A person who is directly or indirectly involved in the provisioning of healthcare. |
| Put Appointment ID |
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). |
|
Put Appointment |
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection. |
| Put Device ID |
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. |
| Put Encounter ID |
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. |
| Put Flag ID |
Prospective warnings of potential issues when providing care to the patient. |
| Put Location ID |
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. |
| Put Patient ID |
Demographics and other administrative information about an individual or animal receiving care or other health-related services. |
| Put Person ID |
Demographics and administrative information about a person independent of a specific health-related context. |
| Put Practitioner ID |
A person who is directly or indirectly involved in the provisioning of healthcare. |
Appointment Response
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
count
|
_count | string |
results returned in a series of pages |
|
|
sort
|
_sort | string |
order to return the results by using the parameter |
|
|
search
|
patient |
clinical-patient |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
type
|
type | string |
type |
|
link
|
link | array of object |
link |
|
relation
|
link.relation | string |
relation |
|
url
|
link.url | string |
url |
Delete Appointment ID
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
versionId
|
versionId | string |
versionId |
|
|
lastUpdated
|
lastUpdated | string |
lastUpdated |
|
|
status
|
status | string |
status |
|
|
div
|
div | string |
div |
|
|
status
|
status | string |
status |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
required
|
required | string |
required |
|
|
status
|
status | string |
status |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
status
|
status | string |
status |
|
participant
|
participant | array of object |
participant |
|
reference
|
participant.actor.reference | string |
reference |
|
display
|
participant.actor.display | string |
display |
|
required
|
participant.required | string |
required |
|
status
|
participant.status | string |
status |
|
type
|
participant.type | array of object |
type |
|
coding
|
participant.type.coding | array of object |
coding |
|
system
|
participant.type.coding.system | string |
system |
|
code
|
participant.type.coding.code | string |
code |
Delete AppointmentResponse ID
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
versionId
|
versionId | string |
versionId |
|
|
lastUpdated
|
lastUpdated | string |
lastUpdated |
|
|
status
|
status | string |
status |
|
|
div
|
div | string |
div |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
participantStatus
|
participantStatus | string |
participantStatus |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
reference
|
appointment.reference | string |
reference |
|
display
|
appointment.display | string |
display |
|
reference
|
actor.reference | string |
reference |
|
display
|
actor.display | string |
display |
|
participantStatus
|
participantStatus | string |
participantStatus |
Delete Device ID
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
versionId
|
versionId | string |
versionId |
|
|
lastUpdated
|
lastUpdated | string |
lastUpdated |
|
|
status
|
status | string |
status |
|
|
div
|
div | string |
div |
|
|
system
|
system | string |
system |
|
|
value
|
value | string |
value |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
identifier
|
identifier | array of object |
identifier |
|
system
|
identifier.system | string |
system |
|
value
|
identifier.value | string |
value |
Delete Encounter ID
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
versionId
|
versionId | string |
versionId |
|
|
lastUpdated
|
lastUpdated | string |
lastUpdated |
|
|
status
|
status | string |
status |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
|
|
display
|
display | string |
display |
|
|
text
|
text | string |
text |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
start
|
start | string |
start |
|
|
end
|
end | string |
end |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
status | string |
status |
|
system
|
class.system | string |
system |
|
code
|
class.code | string |
code |
|
type
|
type | array of object |
type |
|
coding
|
type.coding | array of object |
coding |
|
system
|
type.coding.system | string |
system |
|
code
|
type.coding.code | string |
code |
|
display
|
type.coding.display | string |
display |
|
text
|
type.text | string |
text |
|
reference
|
subject.reference | string |
reference |
|
display
|
subject.display | string |
display |
|
participant
|
participant | array of object |
participant |
|
reference
|
participant.individual.reference | string |
reference |
|
display
|
participant.individual.display | string |
display |
|
start
|
period.start | string |
start |
|
end
|
period.end | string |
end |
|
reference
|
serviceProvider.reference | string |
reference |
|
display
|
serviceProvider.display | string |
display |
DELETE Flag ID
Prospective warnings of potential issues when providing care to the patient.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
status
|
status | string |
status |
|
|
div
|
div | string |
div |
|
|
value
|
value | string |
value |
|
|
status
|
status | string |
status |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
|
|
display
|
display | string |
display |
|
|
text
|
text | string |
text |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
|
|
display
|
display | string |
display |
|
|
text
|
text | string |
text |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
start
|
start | string |
start |
|
|
end
|
end | string |
end |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
identifier
|
identifier | array of object |
identifier |
|
value
|
identifier.value | string |
value |
|
status
|
status | string |
status |
|
category
|
category | array of object |
category |
|
coding
|
category.coding | array of object |
coding |
|
system
|
category.coding.system | string |
system |
|
code
|
category.coding.code | string |
code |
|
display
|
category.coding.display | string |
display |
|
text
|
category.text | string |
text |
|
coding
|
code.coding | array of object |
coding |
|
system
|
code.coding.system | string |
system |
|
code
|
code.coding.code | string |
code |
|
display
|
code.coding.display | string |
display |
|
text
|
code.text | string |
text |
|
reference
|
subject.reference | string |
reference |
|
display
|
subject.display | string |
display |
|
start
|
period.start | string |
start |
|
end
|
period.end | string |
end |
|
reference
|
author.reference | string |
reference |
|
display
|
author.display | string |
display |
Delete Location ID
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
status
|
status | string |
status |
|
|
div
|
div | string |
div |
|
|
status
|
status | string |
status |
|
|
name
|
name | string |
name |
|
|
mode
|
mode | string |
mode |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
status
|
status | string |
status |
|
name
|
name | string |
name |
|
mode
|
mode | string |
mode |
|
reference
|
partOf.reference | string |
reference |
|
display
|
partOf.display | string |
display |
Delete Patient ID
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
active
|
active | boolean |
active |
|
|
use
|
use | string |
use |
|
|
family
|
family | string |
family |
|
|
given
|
given | array of string |
given |
|
|
use
|
use | string |
use |
|
|
system
|
system | string |
system |
|
|
value
|
value | string |
value |
|
|
rank
|
rank | integer |
rank |
|
|
gender
|
gender | string |
gender |
|
|
birthDate
|
birthDate | string |
birthDate |
|
|
deceasedBoolean
|
deceasedBoolean | boolean |
deceasedBoolean |
|
|
use
|
use | string |
use |
|
|
type
|
type | string |
type |
|
|
text
|
text | string |
text |
|
|
line
|
line | array of string |
line |
|
|
city
|
city | string |
city |
|
|
district
|
district | string |
district |
|
|
state
|
state | string |
state |
|
|
postalCode
|
postalCode | string |
postalCode |
|
|
start
|
start | string |
start |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
active
|
active | boolean |
active |
|
name
|
name | array of object |
name |
|
use
|
name.use | string |
use |
|
family
|
name.family | string |
family |
|
given
|
name.given | array of string |
given |
|
telecom
|
telecom | array of object |
telecom |
|
use
|
telecom.use | string |
use |
|
system
|
telecom.system | string |
system |
|
value
|
telecom.value | string |
value |
|
rank
|
telecom.rank | integer |
rank |
|
gender
|
gender | string |
gender |
|
birthDate
|
birthDate | string |
birthDate |
|
deceasedBoolean
|
deceasedBoolean | boolean |
deceasedBoolean |
|
address
|
address | array of object |
address |
|
use
|
address.use | string |
use |
|
type
|
address.type | string |
type |
|
text
|
address.text | string |
text |
|
line
|
address.line | array of string |
line |
|
city
|
address.city | string |
city |
|
district
|
address.district | string |
district |
|
state
|
address.state | string |
state |
|
postalCode
|
address.postalCode | string |
postalCode |
|
start
|
address.period.start | string |
start |
Delete Person ID
Demographics and administrative information about a person independent of a specific health-related context.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
use
|
use | string |
use |
|
|
family
|
family | string |
family |
|
|
given
|
given | array of string |
given |
|
|
system
|
system | string |
system |
|
|
value
|
value | string |
value |
|
|
use
|
use | string |
use |
|
|
gender
|
gender | string |
gender |
|
|
birthDate
|
birthDate | string |
birthDate |
|
|
use
|
use | string |
use |
|
|
line
|
line | array of string |
line |
|
|
city
|
city | string |
city |
|
|
state
|
state | string |
state |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
active
|
active | boolean |
active |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
assurance
|
assurance | string |
assurance |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
name
|
name | array of object |
name |
|
use
|
name.use | string |
use |
|
family
|
name.family | string |
family |
|
given
|
name.given | array of string |
given |
|
telecom
|
telecom | array of object |
telecom |
|
system
|
telecom.system | string |
system |
|
value
|
telecom.value | string |
value |
|
use
|
telecom.use | string |
use |
|
gender
|
gender | string |
gender |
|
birthDate
|
birthDate | string |
birthDate |
|
address
|
address | array of object |
address |
|
use
|
address.use | string |
use |
|
line
|
address.line | array of string |
line |
|
city
|
address.city | string |
city |
|
state
|
address.state | string |
state |
|
reference
|
managingOrganization.reference | string |
reference |
|
display
|
managingOrganization.display | string |
display |
|
active
|
active | boolean |
active |
|
link
|
link | array of object |
link |
|
reference
|
link.target.reference | string |
reference |
|
display
|
link.target.display | string |
display |
|
assurance
|
link.assurance | string |
assurance |
Delete Practitioner ID
A person who is directly or indirectly involved in the provisioning of healthcare.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
versionId
|
versionId | string |
versionId |
|
|
lastUpdated
|
lastUpdated | string |
lastUpdated |
|
|
system
|
system | string |
system |
|
|
value
|
value | string |
value |
|
|
active
|
active | boolean |
active |
|
|
family
|
family | string |
family |
|
|
given
|
given | array of string |
given |
|
|
prefix
|
prefix | array of string |
prefix |
|
|
system
|
system | string |
system |
|
|
value
|
value | string |
value |
|
|
use
|
use | string |
use |
|
|
line
|
line | array of string |
line |
|
|
city
|
city | string |
city |
|
|
state
|
state | string |
state |
|
|
postalCode
|
postalCode | string |
postalCode |
|
|
country
|
country | string |
country |
|
|
gender
|
gender | string |
gender |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
identifier
|
identifier | array of object |
identifier |
|
system
|
identifier.system | string |
system |
|
value
|
identifier.value | string |
value |
|
active
|
active | boolean |
active |
|
name
|
name | array of object |
name |
|
family
|
name.family | string |
family |
|
given
|
name.given | array of string |
given |
|
prefix
|
name.prefix | array of string |
prefix |
|
address
|
address | array of object |
address |
|
use
|
address.use | string |
use |
|
line
|
address.line | array of string |
line |
|
city
|
address.city | string |
city |
|
state
|
address.state | string |
state |
|
postalCode
|
address.postalCode | string |
postalCode |
|
qualification
|
qualification | array of object |
qualification |
|
identifier
|
qualification.identifier | array of object |
identifier |
|
system
|
qualification.identifier.system | string |
system |
|
value
|
qualification.identifier.value | string |
value |
|
coding
|
qualification.code.coding | array of object |
coding |
|
system
|
qualification.code.coding.system | string |
system |
|
code
|
qualification.code.coding.code | string |
code |
|
display
|
qualification.code.coding.display | string |
display |
|
text
|
qualification.code.text | string |
text |
|
start
|
qualification.period.start | string |
start |
|
display
|
qualification.issuer.display | string |
display |
Get Appointment
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
search
|
patient |
clinical-patient |
||
|
count
|
_count | string |
choose to return the results in a series of pages |
|
|
sort
|
_sort | string |
order to return the results by using the parameter |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
type
|
type | string |
type |
|
link
|
link | array of object |
link |
|
relation
|
link.relation | string |
relation |
|
url
|
link.url | string |
url |
|
entry
|
entry | array of object |
entry |
|
fullUrl
|
entry.fullUrl | string |
fullUrl |
|
resourceType
|
entry.resource.resourceType | string |
resourceType |
|
id
|
entry.resource.id | string |
id |
|
versionId
|
entry.resource.meta.versionId | string |
versionId |
|
lastUpdated
|
entry.resource.meta.lastUpdated | string |
lastUpdated |
|
status
|
entry.resource.text.status | string |
status |
|
div
|
entry.resource.text.div | string |
div |
|
status
|
entry.resource.status | string |
status |
|
serviceCategory
|
entry.resource.serviceCategory | array of object |
serviceCategory |
|
coding
|
entry.resource.serviceCategory.coding | array of object |
coding |
|
system
|
entry.resource.serviceCategory.coding.system | string |
system |
|
code
|
entry.resource.serviceCategory.coding.code | string |
code |
|
display
|
entry.resource.serviceCategory.coding.display | string |
display |
|
serviceType
|
entry.resource.serviceType | array of object |
serviceType |
|
coding
|
entry.resource.serviceType.coding | array of object |
coding |
|
code
|
entry.resource.serviceType.coding.code | string |
code |
|
display
|
entry.resource.serviceType.coding.display | string |
display |
|
specialty
|
entry.resource.specialty | array of object |
specialty |
|
coding
|
entry.resource.specialty.coding | array of object |
coding |
|
system
|
entry.resource.specialty.coding.system | string |
system |
|
code
|
entry.resource.specialty.coding.code | string |
code |
|
display
|
entry.resource.specialty.coding.display | string |
display |
|
coding
|
entry.resource.appointmentType.coding | array of object |
coding |
|
system
|
entry.resource.appointmentType.coding.system | string |
system |
|
code
|
entry.resource.appointmentType.coding.code | string |
code |
|
display
|
entry.resource.appointmentType.coding.display | string |
display |
|
reasonReference
|
entry.resource.reasonReference | array of object |
reasonReference |
|
reference
|
entry.resource.reasonReference.reference | string |
reference |
|
display
|
entry.resource.reasonReference.display | string |
display |
|
priority
|
entry.resource.priority | integer |
priority |
|
description
|
entry.resource.description | string |
description |
|
start
|
entry.resource.start | string |
start |
|
end
|
entry.resource.end | string |
end |
|
created
|
entry.resource.created | string |
created |
|
comment
|
entry.resource.comment | string |
comment |
|
basedOn
|
entry.resource.basedOn | array of object |
basedOn |
|
reference
|
entry.resource.basedOn.reference | string |
reference |
|
participant
|
entry.resource.participant | array of object |
participant |
|
reference
|
entry.resource.participant.actor.reference | string |
reference |
|
display
|
entry.resource.participant.actor.display | string |
display |
|
required
|
entry.resource.participant.required | string |
required |
|
status
|
entry.resource.participant.status | string |
status |
|
type
|
entry.resource.participant.type | array of object |
type |
|
coding
|
entry.resource.participant.type.coding | array of object |
coding |
|
system
|
entry.resource.participant.type.coding.system | string |
system |
|
code
|
entry.resource.participant.type.coding.code | string |
code |
|
mode
|
entry.search.mode | string |
mode |
Get Appointment History
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
reference
|
appointment.reference | string |
reference |
|
display
|
appointment.display | string |
display |
|
reference
|
actor.reference | string |
reference |
|
display
|
actor.display | string |
display |
|
participantStatus
|
participantStatus | string |
participantStatus |
Get Appointment History
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
search
|
patient |
clinical-patient |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
status
|
status | string |
status |
|
participant
|
participant | array of object |
participant |
|
reference
|
participant.actor.reference | string |
reference |
|
display
|
participant.actor.display | string |
display |
|
required
|
participant.required | string |
required |
|
status
|
participant.status | string |
status |
|
type
|
participant.type | array of object |
type |
|
coding
|
participant.type.coding | array of object |
coding |
|
system
|
participant.type.coding.system | string |
system |
|
code
|
participant.type.coding.code | string |
code |
Get Appointment ID
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
status
|
status | string |
status |
|
participant
|
participant | array of object |
participant |
|
reference
|
participant.actor.reference | string |
reference |
|
display
|
participant.actor.display | string |
display |
|
required
|
participant.required | string |
required |
|
status
|
participant.status | string |
status |
|
type
|
participant.type | array of object |
type |
|
coding
|
participant.type.coding | array of object |
coding |
|
system
|
participant.type.coding.system | string |
system |
|
code
|
participant.type.coding.code | string |
code |
Get Appointment ID History
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
status
|
status | string |
status |
|
participant
|
participant | array of object |
participant |
|
reference
|
participant.actor.reference | string |
reference |
|
display
|
participant.actor.display | string |
display |
|
required
|
participant.required | string |
required |
|
status
|
participant.status | string |
status |
|
type
|
participant.type | array of object |
type |
|
coding
|
participant.type.coding | array of object |
coding |
|
system
|
participant.type.coding.system | string |
system |
|
code
|
participant.type.coding.code | string |
code |
Get Appointment ID History
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
history
|
vid | True | string |
Changes made to the Value Set Definition over time |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
status
|
status | string |
status |
|
participant
|
participant | array of object |
participant |
|
reference
|
participant.actor.reference | string |
reference |
|
display
|
participant.actor.display | string |
display |
|
required
|
participant.required | string |
required |
|
status
|
participant.status | string |
status |
|
type
|
participant.type | array of object |
type |
|
coding
|
participant.type.coding | array of object |
coding |
|
system
|
participant.type.coding.system | string |
system |
|
code
|
participant.type.coding.code | string |
code |
Get Appointment Response History
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
reference
|
appointment.reference | string |
reference |
|
display
|
appointment.display | string |
display |
|
reference
|
actor.reference | string |
reference |
|
display
|
actor.display | string |
display |
|
participantStatus
|
participantStatus | string |
participantStatus |
Get AppointmentResponse ID Version
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
history
|
vid | True | string |
Changes made to the Value Set Definition over time |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
reference
|
appointment.reference | string |
reference |
|
display
|
appointment.display | string |
display |
|
reference
|
actor.reference | string |
reference |
|
display
|
actor.display | string |
display |
|
participantStatus
|
participantStatus | string |
participantStatus |
Get Device
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
count
|
_count | string |
results returned in a series of pages |
|
|
sort
|
_sort | string |
order to return the results by using the parameter |
|
|
patient query
|
patient |
One of the individuals of the appointment is this patient |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
type
|
type | string |
type |
|
link
|
link | array of object |
link |
|
relation
|
link.relation | string |
relation |
|
url
|
link.url | string |
url |
|
entry
|
entry | array of object |
entry |
|
fullUrl
|
entry.fullUrl | string |
fullUrl |
|
resourceType
|
entry.resource.resourceType | string |
resourceType |
|
id
|
entry.resource.id | string |
id |
|
versionId
|
entry.resource.meta.versionId | string |
versionId |
|
lastUpdated
|
entry.resource.meta.lastUpdated | string |
lastUpdated |
|
udiCarrier
|
entry.resource.udiCarrier | array of object |
udiCarrier |
|
deviceIdentifier
|
entry.resource.udiCarrier.deviceIdentifier | string |
deviceIdentifier |
|
carrierHRF
|
entry.resource.udiCarrier.carrierHRF | string |
carrierHRF |
|
status
|
entry.resource.status | string |
status |
|
distinctIdentifier
|
entry.resource.distinctIdentifier | string |
distinctIdentifier |
|
manufactureDate
|
entry.resource.manufactureDate | string |
manufactureDate |
|
expirationDate
|
entry.resource.expirationDate | string |
expirationDate |
|
lotNumber
|
entry.resource.lotNumber | string |
lotNumber |
|
serialNumber
|
entry.resource.serialNumber | string |
serialNumber |
|
deviceName
|
entry.resource.deviceName | array of object |
deviceName |
|
name
|
entry.resource.deviceName.name | string |
name |
|
type
|
entry.resource.deviceName.type | string |
type |
|
coding
|
entry.resource.type.coding | array of object |
coding |
|
system
|
entry.resource.type.coding.system | string |
system |
|
code
|
entry.resource.type.coding.code | string |
code |
|
display
|
entry.resource.type.coding.display | string |
display |
|
text
|
entry.resource.type.text | string |
text |
|
reference
|
entry.resource.patient.reference | string |
reference |
|
status
|
entry.resource.text.status | string |
status |
|
div
|
entry.resource.text.div | string |
div |
|
identifier
|
entry.resource.identifier | array of object |
identifier |
|
system
|
entry.resource.identifier.system | string |
system |
|
value
|
entry.resource.identifier.value | string |
value |
|
mode
|
entry.search.mode | string |
mode |
Get Device History
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
identifier
|
identifier | array of object |
identifier |
|
system
|
identifier.system | string |
system |
|
value
|
identifier.value | string |
value |
Get Device ID
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
udiCarrier
|
udiCarrier | array of object |
udiCarrier |
|
deviceIdentifier
|
udiCarrier.deviceIdentifier | string |
deviceIdentifier |
|
carrierHRF
|
udiCarrier.carrierHRF | string |
carrierHRF |
|
status
|
status | string |
status |
|
distinctIdentifier
|
distinctIdentifier | string |
distinctIdentifier |
|
manufactureDate
|
manufactureDate | string |
manufactureDate |
|
expirationDate
|
expirationDate | string |
expirationDate |
|
lotNumber
|
lotNumber | string |
lotNumber |
|
serialNumber
|
serialNumber | string |
serialNumber |
|
deviceName
|
deviceName | array of object |
deviceName |
|
name
|
deviceName.name | string |
name |
|
type
|
deviceName.type | string |
type |
|
coding
|
type.coding | array of object |
coding |
|
system
|
type.coding.system | string |
system |
|
code
|
type.coding.code | string |
code |
|
display
|
type.coding.display | string |
display |
|
text
|
type.text | string |
text |
|
reference
|
patient.reference | string |
reference |
Get Device ID History
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
identifier
|
identifier | array of object |
identifier |
|
system
|
identifier.system | string |
system |
|
value
|
identifier.value | string |
value |
Get Device ID Version
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
history
|
vid | True | string |
Changes made to the Value Set Definition over time |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
identifier
|
identifier | array of object |
identifier |
|
system
|
identifier.system | string |
system |
|
value
|
identifier.value | string |
value |
Get Encounter
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
count
|
_count | string |
results returned in a series of pages |
|
|
sort
|
_sort | string |
order to return the results by using the parameter |
|
|
search
|
patient |
clinical-patient |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
type
|
type | string |
type |
|
link
|
link | array of object |
link |
|
relation
|
link.relation | string |
relation |
|
url
|
link.url | string |
url |
|
entry
|
entry | array of object |
entry |
|
fullUrl
|
entry.fullUrl | string |
fullUrl |
|
resourceType
|
entry.resource.resourceType | string |
resourceType |
|
id
|
entry.resource.id | string |
id |
|
versionId
|
entry.resource.meta.versionId | string |
versionId |
|
lastUpdated
|
entry.resource.meta.lastUpdated | string |
lastUpdated |
|
status
|
entry.resource.status | string |
status |
|
system
|
entry.resource.class.system | string |
system |
|
code
|
entry.resource.class.code | string |
code |
|
type
|
entry.resource.type | array of object |
type |
|
coding
|
entry.resource.type.coding | array of object |
coding |
|
system
|
entry.resource.type.coding.system | string |
system |
|
code
|
entry.resource.type.coding.code | string |
code |
|
display
|
entry.resource.type.coding.display | string |
display |
|
text
|
entry.resource.type.text | string |
text |
|
reference
|
entry.resource.subject.reference | string |
reference |
|
display
|
entry.resource.subject.display | string |
display |
|
participant
|
entry.resource.participant | array of object |
participant |
|
reference
|
entry.resource.participant.individual.reference | string |
reference |
|
display
|
entry.resource.participant.individual.display | string |
display |
|
start
|
entry.resource.period.start | string |
start |
|
end
|
entry.resource.period.end | string |
end |
|
reference
|
entry.resource.serviceProvider.reference | string |
reference |
|
display
|
entry.resource.serviceProvider.display | string |
display |
|
reasonCode
|
entry.resource.reasonCode | array of object |
reasonCode |
|
coding
|
entry.resource.reasonCode.coding | array of object |
coding |
|
system
|
entry.resource.reasonCode.coding.system | string |
system |
|
code
|
entry.resource.reasonCode.coding.code | string |
code |
|
display
|
entry.resource.reasonCode.coding.display | string |
display |
|
mode
|
entry.search.mode | string |
mode |
Get Encounter ID
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
status | string |
status |
|
system
|
class.system | string |
system |
|
code
|
class.code | string |
code |
|
type
|
type | array of object |
type |
|
coding
|
type.coding | array of object |
coding |
|
system
|
type.coding.system | string |
system |
|
code
|
type.coding.code | string |
code |
|
display
|
type.coding.display | string |
display |
|
text
|
type.text | string |
text |
|
reference
|
subject.reference | string |
reference |
|
display
|
subject.display | string |
display |
|
participant
|
participant | array of object |
participant |
|
reference
|
participant.individual.reference | string |
reference |
|
display
|
participant.individual.display | string |
display |
|
start
|
period.start | string |
start |
|
end
|
period.end | string |
end |
|
reference
|
serviceProvider.reference | string |
reference |
|
display
|
serviceProvider.display | string |
display |
Get Encounter ID History
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
status | string |
status |
|
system
|
class.system | string |
system |
|
code
|
class.code | string |
code |
|
type
|
type | array of object |
type |
|
coding
|
type.coding | array of object |
coding |
|
system
|
type.coding.system | string |
system |
|
code
|
type.coding.code | string |
code |
|
display
|
type.coding.display | string |
display |
|
text
|
type.text | string |
text |
|
reference
|
subject.reference | string |
reference |
|
display
|
subject.display | string |
display |
|
participant
|
participant | array of object |
participant |
|
reference
|
participant.individual.reference | string |
reference |
|
display
|
participant.individual.display | string |
display |
|
start
|
period.start | string |
start |
|
end
|
period.end | string |
end |
|
reference
|
serviceProvider.reference | string |
reference |
|
display
|
serviceProvider.display | string |
display |
Get Encounter ID Version
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
history
|
vid | True | string |
Changes made to the Value Set Definition over time |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
status | string |
status |
|
system
|
class.system | string |
system |
|
code
|
class.code | string |
code |
|
type
|
type | array of object |
type |
|
coding
|
type.coding | array of object |
coding |
|
system
|
type.coding.system | string |
system |
|
code
|
type.coding.code | string |
code |
|
display
|
type.coding.display | string |
display |
|
text
|
type.text | string |
text |
|
reference
|
subject.reference | string |
reference |
|
display
|
subject.display | string |
display |
|
participant
|
participant | array of object |
participant |
|
reference
|
participant.individual.reference | string |
reference |
|
display
|
participant.individual.display | string |
display |
|
start
|
period.start | string |
start |
|
end
|
period.end | string |
end |
|
reference
|
serviceProvider.reference | string |
reference |
|
display
|
serviceProvider.display | string |
display |
Get Enouncter History
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
status | string |
status |
|
system
|
class.system | string |
system |
|
code
|
class.code | string |
code |
|
type
|
type | array of object |
type |
|
coding
|
type.coding | array of object |
coding |
|
system
|
type.coding.system | string |
system |
|
code
|
type.coding.code | string |
code |
|
display
|
type.coding.display | string |
display |
|
text
|
type.text | string |
text |
|
reference
|
subject.reference | string |
reference |
|
display
|
subject.display | string |
display |
|
participant
|
participant | array of object |
participant |
|
reference
|
participant.individual.reference | string |
reference |
|
display
|
participant.individual.display | string |
display |
|
start
|
period.start | string |
start |
|
end
|
period.end | string |
end |
|
reference
|
serviceProvider.reference | string |
reference |
|
display
|
serviceProvider.display | string |
display |
Get Flag
Prospective warnings of potential issues when providing care to the patient.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
count
|
_count | string |
results returned in a series of pages |
|
|
sort
|
_sort | string |
order to return the results by using the parameter |
|
|
search
|
patient |
clinical-patient |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
identifier
|
identifier | array of object |
identifier |
|
value
|
identifier.value | string |
value |
|
status
|
status | string |
status |
|
category
|
category | array of object |
category |
|
coding
|
category.coding | array of object |
coding |
|
system
|
category.coding.system | string |
system |
|
code
|
category.coding.code | string |
code |
|
display
|
category.coding.display | string |
display |
|
text
|
category.text | string |
text |
|
coding
|
code.coding | array of object |
coding |
|
system
|
code.coding.system | string |
system |
|
code
|
code.coding.code | string |
code |
|
display
|
code.coding.display | string |
display |
|
text
|
code.text | string |
text |
|
reference
|
subject.reference | string |
reference |
|
display
|
subject.display | string |
display |
|
start
|
period.start | string |
start |
|
end
|
period.end | string |
end |
|
reference
|
author.reference | string |
reference |
|
display
|
author.display | string |
display |
Get Flag History
Prospective warnings of potential issues when providing care to the patient.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
identifier
|
identifier | array of object |
identifier |
|
value
|
identifier.value | string |
value |
|
status
|
status | string |
status |
|
category
|
category | array of object |
category |
|
coding
|
category.coding | array of object |
coding |
|
system
|
category.coding.system | string |
system |
|
code
|
category.coding.code | string |
code |
|
display
|
category.coding.display | string |
display |
|
text
|
category.text | string |
text |
|
coding
|
code.coding | array of object |
coding |
|
system
|
code.coding.system | string |
system |
|
code
|
code.coding.code | string |
code |
|
display
|
code.coding.display | string |
display |
|
text
|
code.text | string |
text |
|
reference
|
subject.reference | string |
reference |
|
display
|
subject.display | string |
display |
|
start
|
period.start | string |
start |
|
end
|
period.end | string |
end |
|
reference
|
author.reference | string |
reference |
|
display
|
author.display | string |
display |
Get Flag ID
Prospective warnings of potential issues when providing care to the patient.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
identifier
|
identifier | array of object |
identifier |
|
value
|
identifier.value | string |
value |
|
status
|
status | string |
status |
|
category
|
category | array of object |
category |
|
coding
|
category.coding | array of object |
coding |
|
system
|
category.coding.system | string |
system |
|
code
|
category.coding.code | string |
code |
|
display
|
category.coding.display | string |
display |
|
text
|
category.text | string |
text |
|
coding
|
code.coding | array of object |
coding |
|
system
|
code.coding.system | string |
system |
|
code
|
code.coding.code | string |
code |
|
display
|
code.coding.display | string |
display |
|
text
|
code.text | string |
text |
|
reference
|
subject.reference | string |
reference |
|
display
|
subject.display | string |
display |
|
start
|
period.start | string |
start |
|
end
|
period.end | string |
end |
|
reference
|
author.reference | string |
reference |
|
display
|
author.display | string |
display |
Get Flag ID History
Prospective warnings of potential issues when providing care to the patient.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
identifier
|
identifier | array of object |
identifier |
|
value
|
identifier.value | string |
value |
|
status
|
status | string |
status |
|
category
|
category | array of object |
category |
|
coding
|
category.coding | array of object |
coding |
|
system
|
category.coding.system | string |
system |
|
code
|
category.coding.code | string |
code |
|
display
|
category.coding.display | string |
display |
|
text
|
category.text | string |
text |
|
coding
|
code.coding | array of object |
coding |
|
system
|
code.coding.system | string |
system |
|
code
|
code.coding.code | string |
code |
|
display
|
code.coding.display | string |
display |
|
text
|
code.text | string |
text |
|
reference
|
subject.reference | string |
reference |
|
display
|
subject.display | string |
display |
|
start
|
period.start | string |
start |
|
end
|
period.end | string |
end |
|
reference
|
author.reference | string |
reference |
|
display
|
author.display | string |
display |
Get Flag ID Version
Prospective warnings of potential issues when providing care to the patient.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
history
|
vid | True | string |
Changes made to the Value Set Definition over time |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
identifier
|
identifier | array of object |
identifier |
|
value
|
identifier.value | string |
value |
|
status
|
status | string |
status |
|
category
|
category | array of object |
category |
|
coding
|
category.coding | array of object |
coding |
|
system
|
category.coding.system | string |
system |
|
code
|
category.coding.code | string |
code |
|
display
|
category.coding.display | string |
display |
|
text
|
category.text | string |
text |
|
coding
|
code.coding | array of object |
coding |
|
system
|
code.coding.system | string |
system |
|
code
|
code.coding.code | string |
code |
|
display
|
code.coding.display | string |
display |
|
text
|
code.text | string |
text |
|
reference
|
subject.reference | string |
reference |
|
display
|
subject.display | string |
display |
|
start
|
period.start | string |
start |
|
end
|
period.end | string |
end |
|
reference
|
author.reference | string |
reference |
|
display
|
author.display | string |
display |
Get Location
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
count
|
_count | string |
results returned in a series of pages |
|
|
sort
|
_sort | string |
order to return the results by using the parameter |
|
|
search
|
patient |
clinical-patient |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
status
|
status | string |
status |
|
name
|
name | string |
name |
|
mode
|
mode | string |
mode |
|
reference
|
partOf.reference | string |
reference |
|
display
|
partOf.display | string |
display |
Get Location History
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
status
|
status | string |
status |
|
name
|
name | string |
name |
|
mode
|
mode | string |
mode |
|
reference
|
partOf.reference | string |
reference |
|
display
|
partOf.display | string |
display |
Get Location ID
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
status
|
status | string |
status |
|
name
|
name | string |
name |
|
mode
|
mode | string |
mode |
|
reference
|
partOf.reference | string |
reference |
|
display
|
partOf.display | string |
display |
Get Location ID History
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
status
|
status | string |
status |
|
name
|
name | string |
name |
|
mode
|
mode | string |
mode |
|
reference
|
partOf.reference | string |
reference |
|
display
|
partOf.display | string |
display |
Get Location Version
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
history
|
vid | True | string |
Changes made to the Value Set Definition over time |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
status
|
status | string |
status |
|
name
|
name | string |
name |
|
mode
|
mode | string |
mode |
|
reference
|
partOf.reference | string |
reference |
|
display
|
partOf.display | string |
display |
Get Patient
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
count
|
_count | string |
results returned in a series of pages |
|
|
sort
|
_sort | string |
order to return the results by using the parameter |
|
|
search
|
patient |
clinical-patient |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
type
|
type | string |
type |
|
link
|
link | array of object |
link |
|
relation
|
link.relation | string |
relation |
|
url
|
link.url | string |
url |
|
entry
|
entry | array of object |
entry |
|
fullUrl
|
entry.fullUrl | string |
fullUrl |
|
resourceType
|
entry.resource.resourceType | string |
resourceType |
|
id
|
entry.resource.id | string |
id |
|
versionId
|
entry.resource.meta.versionId | string |
versionId |
|
lastUpdated
|
entry.resource.meta.lastUpdated | string |
lastUpdated |
|
status
|
entry.resource.text.status | string |
status |
|
div
|
entry.resource.text.div | string |
div |
|
extension
|
entry.resource.extension | array of object |
extension |
|
url
|
entry.resource.extension.url | string |
url |
|
coding
|
entry.resource.extension.valueCodeableConcept.coding | array of object |
coding |
|
system
|
entry.resource.extension.valueCodeableConcept.coding.system | string |
system |
|
code
|
entry.resource.extension.valueCodeableConcept.coding.code | string |
code |
|
display
|
entry.resource.extension.valueCodeableConcept.coding.display | string |
display |
|
text
|
entry.resource.extension.valueCodeableConcept.text | string |
text |
|
valueCode
|
entry.resource.extension.valueCode | string |
valueCode |
|
identifier
|
entry.resource.identifier | array of object |
identifier |
|
system
|
entry.resource.identifier.system | string |
system |
|
value
|
entry.resource.identifier.value | string |
value |
|
name
|
entry.resource.name | array of object |
name |
|
use
|
entry.resource.name.use | string |
use |
|
text
|
entry.resource.name.text | string |
text |
|
family
|
entry.resource.name.family | string |
family |
|
given
|
entry.resource.name.given | array of string |
given |
|
telecom
|
entry.resource.telecom | array of object |
telecom |
|
system
|
entry.resource.telecom.system | string |
system |
|
value
|
entry.resource.telecom.value | string |
value |
|
use
|
entry.resource.telecom.use | string |
use |
|
gender
|
entry.resource.gender | string |
gender |
|
birthDate
|
entry.resource.birthDate | string |
birthDate |
|
address
|
entry.resource.address | array of object |
address |
|
use
|
entry.resource.address.use | string |
use |
|
line
|
entry.resource.address.line | array of string |
line |
|
city
|
entry.resource.address.city | string |
city |
|
state
|
entry.resource.address.state | string |
state |
|
postalCode
|
entry.resource.address.postalCode | string |
postalCode |
|
country
|
entry.resource.address.country | string |
country |
|
mode
|
entry.search.mode | string |
mode |
Get Patient History
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
type
|
type | string |
type |
|
link
|
link | array of object |
link |
|
relation
|
link.relation | string |
relation |
|
url
|
link.url | string |
url |
|
entry
|
entry | array of object |
entry |
|
fullUrl
|
entry.fullUrl | string |
fullUrl |
|
resourceType
|
entry.resource.resourceType | string |
resourceType |
|
id
|
entry.resource.id | string |
id |
|
versionId
|
entry.resource.meta.versionId | string |
versionId |
|
lastUpdated
|
entry.resource.meta.lastUpdated | string |
lastUpdated |
|
status
|
entry.resource.text.status | string |
status |
|
div
|
entry.resource.text.div | string |
div |
|
extension
|
entry.resource.extension | array of object |
extension |
|
url
|
entry.resource.extension.url | string |
url |
|
coding
|
entry.resource.extension.valueCodeableConcept.coding | array of object |
coding |
|
system
|
entry.resource.extension.valueCodeableConcept.coding.system | string |
system |
|
code
|
entry.resource.extension.valueCodeableConcept.coding.code | string |
code |
|
display
|
entry.resource.extension.valueCodeableConcept.coding.display | string |
display |
|
text
|
entry.resource.extension.valueCodeableConcept.text | string |
text |
|
valueCode
|
entry.resource.extension.valueCode | string |
valueCode |
|
identifier
|
entry.resource.identifier | array of object |
identifier |
|
system
|
entry.resource.identifier.system | string |
system |
|
value
|
entry.resource.identifier.value | string |
value |
|
name
|
entry.resource.name | array of object |
name |
|
use
|
entry.resource.name.use | string |
use |
|
text
|
entry.resource.name.text | string |
text |
|
family
|
entry.resource.name.family | string |
family |
|
given
|
entry.resource.name.given | array of string |
given |
|
telecom
|
entry.resource.telecom | array of object |
telecom |
|
system
|
entry.resource.telecom.system | string |
system |
|
value
|
entry.resource.telecom.value | string |
value |
|
use
|
entry.resource.telecom.use | string |
use |
|
gender
|
entry.resource.gender | string |
gender |
|
birthDate
|
entry.resource.birthDate | string |
birthDate |
|
address
|
entry.resource.address | array of object |
address |
|
use
|
entry.resource.address.use | string |
use |
|
line
|
entry.resource.address.line | array of string |
line |
|
city
|
entry.resource.address.city | string |
city |
|
state
|
entry.resource.address.state | string |
state |
|
postalCode
|
entry.resource.address.postalCode | string |
postalCode |
|
country
|
entry.resource.address.country | string |
country |
|
mode
|
entry.search.mode | string |
mode |
Get Patient ID
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
type
|
type | string |
type |
|
link
|
link | array of object |
link |
|
relation
|
link.relation | string |
relation |
|
url
|
link.url | string |
url |
|
entry
|
entry | array of object |
entry |
|
fullUrl
|
entry.fullUrl | string |
fullUrl |
|
resourceType
|
entry.resource.resourceType | string |
resourceType |
|
id
|
entry.resource.id | string |
id |
|
versionId
|
entry.resource.meta.versionId | string |
versionId |
|
lastUpdated
|
entry.resource.meta.lastUpdated | string |
lastUpdated |
|
status
|
entry.resource.text.status | string |
status |
|
div
|
entry.resource.text.div | string |
div |
|
extension
|
entry.resource.extension | array of object |
extension |
|
url
|
entry.resource.extension.url | string |
url |
|
coding
|
entry.resource.extension.valueCodeableConcept.coding | array of object |
coding |
|
system
|
entry.resource.extension.valueCodeableConcept.coding.system | string |
system |
|
code
|
entry.resource.extension.valueCodeableConcept.coding.code | string |
code |
|
display
|
entry.resource.extension.valueCodeableConcept.coding.display | string |
display |
|
text
|
entry.resource.extension.valueCodeableConcept.text | string |
text |
|
valueCode
|
entry.resource.extension.valueCode | string |
valueCode |
|
identifier
|
entry.resource.identifier | array of object |
identifier |
|
system
|
entry.resource.identifier.system | string |
system |
|
value
|
entry.resource.identifier.value | string |
value |
|
name
|
entry.resource.name | array of object |
name |
|
use
|
entry.resource.name.use | string |
use |
|
text
|
entry.resource.name.text | string |
text |
|
family
|
entry.resource.name.family | string |
family |
|
given
|
entry.resource.name.given | array of string |
given |
|
telecom
|
entry.resource.telecom | array of object |
telecom |
|
system
|
entry.resource.telecom.system | string |
system |
|
value
|
entry.resource.telecom.value | string |
value |
|
use
|
entry.resource.telecom.use | string |
use |
|
gender
|
entry.resource.gender | string |
gender |
|
birthDate
|
entry.resource.birthDate | string |
birthDate |
|
address
|
entry.resource.address | array of object |
address |
|
use
|
entry.resource.address.use | string |
use |
|
line
|
entry.resource.address.line | array of string |
line |
|
city
|
entry.resource.address.city | string |
city |
|
state
|
entry.resource.address.state | string |
state |
|
postalCode
|
entry.resource.address.postalCode | string |
postalCode |
|
country
|
entry.resource.address.country | string |
country |
|
mode
|
entry.search.mode | string |
mode |
Get Patient ID History
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
type
|
type | string |
type |
|
link
|
link | array of object |
link |
|
relation
|
link.relation | string |
relation |
|
url
|
link.url | string |
url |
|
entry
|
entry | array of object |
entry |
|
fullUrl
|
entry.fullUrl | string |
fullUrl |
|
resourceType
|
entry.resource.resourceType | string |
resourceType |
|
id
|
entry.resource.id | string |
id |
|
versionId
|
entry.resource.meta.versionId | string |
versionId |
|
lastUpdated
|
entry.resource.meta.lastUpdated | string |
lastUpdated |
|
status
|
entry.resource.text.status | string |
status |
|
div
|
entry.resource.text.div | string |
div |
|
extension
|
entry.resource.extension | array of object |
extension |
|
url
|
entry.resource.extension.url | string |
url |
|
coding
|
entry.resource.extension.valueCodeableConcept.coding | array of object |
coding |
|
system
|
entry.resource.extension.valueCodeableConcept.coding.system | string |
system |
|
code
|
entry.resource.extension.valueCodeableConcept.coding.code | string |
code |
|
display
|
entry.resource.extension.valueCodeableConcept.coding.display | string |
display |
|
text
|
entry.resource.extension.valueCodeableConcept.text | string |
text |
|
valueCode
|
entry.resource.extension.valueCode | string |
valueCode |
|
identifier
|
entry.resource.identifier | array of object |
identifier |
|
system
|
entry.resource.identifier.system | string |
system |
|
value
|
entry.resource.identifier.value | string |
value |
|
name
|
entry.resource.name | array of object |
name |
|
use
|
entry.resource.name.use | string |
use |
|
text
|
entry.resource.name.text | string |
text |
|
family
|
entry.resource.name.family | string |
family |
|
given
|
entry.resource.name.given | array of string |
given |
|
telecom
|
entry.resource.telecom | array of object |
telecom |
|
system
|
entry.resource.telecom.system | string |
system |
|
value
|
entry.resource.telecom.value | string |
value |
|
use
|
entry.resource.telecom.use | string |
use |
|
gender
|
entry.resource.gender | string |
gender |
|
birthDate
|
entry.resource.birthDate | string |
birthDate |
|
address
|
entry.resource.address | array of object |
address |
|
use
|
entry.resource.address.use | string |
use |
|
line
|
entry.resource.address.line | array of string |
line |
|
city
|
entry.resource.address.city | string |
city |
|
state
|
entry.resource.address.state | string |
state |
|
postalCode
|
entry.resource.address.postalCode | string |
postalCode |
|
country
|
entry.resource.address.country | string |
country |
|
mode
|
entry.search.mode | string |
mode |
Get Patient ID Version
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
history
|
vid | True | string |
Changes made to the Value Set Definition over time |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
type
|
type | string |
type |
|
link
|
link | array of object |
link |
|
relation
|
link.relation | string |
relation |
|
url
|
link.url | string |
url |
|
entry
|
entry | array of object |
entry |
|
fullUrl
|
entry.fullUrl | string |
fullUrl |
|
resourceType
|
entry.resource.resourceType | string |
resourceType |
|
id
|
entry.resource.id | string |
id |
|
versionId
|
entry.resource.meta.versionId | string |
versionId |
|
lastUpdated
|
entry.resource.meta.lastUpdated | string |
lastUpdated |
|
status
|
entry.resource.text.status | string |
status |
|
div
|
entry.resource.text.div | string |
div |
|
extension
|
entry.resource.extension | array of object |
extension |
|
url
|
entry.resource.extension.url | string |
url |
|
coding
|
entry.resource.extension.valueCodeableConcept.coding | array of object |
coding |
|
system
|
entry.resource.extension.valueCodeableConcept.coding.system | string |
system |
|
code
|
entry.resource.extension.valueCodeableConcept.coding.code | string |
code |
|
display
|
entry.resource.extension.valueCodeableConcept.coding.display | string |
display |
|
text
|
entry.resource.extension.valueCodeableConcept.text | string |
text |
|
valueCode
|
entry.resource.extension.valueCode | string |
valueCode |
|
identifier
|
entry.resource.identifier | array of object |
identifier |
|
system
|
entry.resource.identifier.system | string |
system |
|
value
|
entry.resource.identifier.value | string |
value |
|
name
|
entry.resource.name | array of object |
name |
|
use
|
entry.resource.name.use | string |
use |
|
text
|
entry.resource.name.text | string |
text |
|
family
|
entry.resource.name.family | string |
family |
|
given
|
entry.resource.name.given | array of string |
given |
|
telecom
|
entry.resource.telecom | array of object |
telecom |
|
system
|
entry.resource.telecom.system | string |
system |
|
value
|
entry.resource.telecom.value | string |
value |
|
use
|
entry.resource.telecom.use | string |
use |
|
gender
|
entry.resource.gender | string |
gender |
|
birthDate
|
entry.resource.birthDate | string |
birthDate |
|
address
|
entry.resource.address | array of object |
address |
|
use
|
entry.resource.address.use | string |
use |
|
line
|
entry.resource.address.line | array of string |
line |
|
city
|
entry.resource.address.city | string |
city |
|
state
|
entry.resource.address.state | string |
state |
|
postalCode
|
entry.resource.address.postalCode | string |
postalCode |
|
country
|
entry.resource.address.country | string |
country |
|
mode
|
entry.search.mode | string |
mode |
Get Person
Demographics and administrative information about a person independent of a specific health-related context.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
count
|
_count | string |
results returned in a series of pages |
|
|
sort
|
_sort | string |
order to return the results by using the parameter |
|
|
search
|
patient |
clinical-patient |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
name
|
name | array of object |
name |
|
use
|
name.use | string |
use |
|
family
|
name.family | string |
family |
|
given
|
name.given | array of string |
given |
|
telecom
|
telecom | array of object |
telecom |
|
system
|
telecom.system | string |
system |
|
value
|
telecom.value | string |
value |
|
use
|
telecom.use | string |
use |
|
gender
|
gender | string |
gender |
|
birthDate
|
birthDate | string |
birthDate |
|
address
|
address | array of object |
address |
|
use
|
address.use | string |
use |
|
line
|
address.line | array of string |
line |
|
city
|
address.city | string |
city |
|
state
|
address.state | string |
state |
|
reference
|
managingOrganization.reference | string |
reference |
|
display
|
managingOrganization.display | string |
display |
|
active
|
active | boolean |
active |
|
link
|
link | array of object |
link |
|
reference
|
link.target.reference | string |
reference |
|
display
|
link.target.display | string |
display |
|
assurance
|
link.assurance | string |
assurance |
Get Person History
Demographics and administrative information about a person independent of a specific health-related context.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
name
|
name | array of object |
name |
|
use
|
name.use | string |
use |
|
family
|
name.family | string |
family |
|
given
|
name.given | array of string |
given |
|
telecom
|
telecom | array of object |
telecom |
|
system
|
telecom.system | string |
system |
|
value
|
telecom.value | string |
value |
|
use
|
telecom.use | string |
use |
|
gender
|
gender | string |
gender |
|
birthDate
|
birthDate | string |
birthDate |
|
address
|
address | array of object |
address |
|
use
|
address.use | string |
use |
|
line
|
address.line | array of string |
line |
|
city
|
address.city | string |
city |
|
state
|
address.state | string |
state |
|
reference
|
managingOrganization.reference | string |
reference |
|
display
|
managingOrganization.display | string |
display |
|
active
|
active | boolean |
active |
|
link
|
link | array of object |
link |
|
reference
|
link.target.reference | string |
reference |
|
display
|
link.target.display | string |
display |
|
assurance
|
link.assurance | string |
assurance |
Get Person ID
Demographics and administrative information about a person independent of a specific health-related context.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
name
|
name | array of object |
name |
|
use
|
name.use | string |
use |
|
family
|
name.family | string |
family |
|
given
|
name.given | array of string |
given |
|
telecom
|
telecom | array of object |
telecom |
|
system
|
telecom.system | string |
system |
|
value
|
telecom.value | string |
value |
|
use
|
telecom.use | string |
use |
|
gender
|
gender | string |
gender |
|
birthDate
|
birthDate | string |
birthDate |
|
address
|
address | array of object |
address |
|
use
|
address.use | string |
use |
|
line
|
address.line | array of string |
line |
|
city
|
address.city | string |
city |
|
state
|
address.state | string |
state |
|
reference
|
managingOrganization.reference | string |
reference |
|
display
|
managingOrganization.display | string |
display |
|
active
|
active | boolean |
active |
|
link
|
link | array of object |
link |
|
reference
|
link.target.reference | string |
reference |
|
display
|
link.target.display | string |
display |
|
assurance
|
link.assurance | string |
assurance |
Get Person ID History
Demographics and administrative information about a person independent of a specific health-related context.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
name
|
name | array of object |
name |
|
use
|
name.use | string |
use |
|
family
|
name.family | string |
family |
|
given
|
name.given | array of string |
given |
|
telecom
|
telecom | array of object |
telecom |
|
system
|
telecom.system | string |
system |
|
value
|
telecom.value | string |
value |
|
use
|
telecom.use | string |
use |
|
gender
|
gender | string |
gender |
|
birthDate
|
birthDate | string |
birthDate |
|
address
|
address | array of object |
address |
|
use
|
address.use | string |
use |
|
line
|
address.line | array of string |
line |
|
city
|
address.city | string |
city |
|
state
|
address.state | string |
state |
|
reference
|
managingOrganization.reference | string |
reference |
|
display
|
managingOrganization.display | string |
display |
|
active
|
active | boolean |
active |
|
link
|
link | array of object |
link |
|
reference
|
link.target.reference | string |
reference |
|
display
|
link.target.display | string |
display |
|
assurance
|
link.assurance | string |
assurance |
Get Person ID Version
Demographics and administrative information about a person independent of a specific health-related context.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
history
|
vid | True | string |
Changes made to the Value Set Definition over time |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
name
|
name | array of object |
name |
|
use
|
name.use | string |
use |
|
family
|
name.family | string |
family |
|
given
|
name.given | array of string |
given |
|
telecom
|
telecom | array of object |
telecom |
|
system
|
telecom.system | string |
system |
|
value
|
telecom.value | string |
value |
|
use
|
telecom.use | string |
use |
|
gender
|
gender | string |
gender |
|
birthDate
|
birthDate | string |
birthDate |
|
address
|
address | array of object |
address |
|
use
|
address.use | string |
use |
|
line
|
address.line | array of string |
line |
|
city
|
address.city | string |
city |
|
state
|
address.state | string |
state |
|
reference
|
managingOrganization.reference | string |
reference |
|
display
|
managingOrganization.display | string |
display |
|
active
|
active | boolean |
active |
|
link
|
link | array of object |
link |
|
reference
|
link.target.reference | string |
reference |
|
display
|
link.target.display | string |
display |
|
assurance
|
link.assurance | string |
assurance |
Get Pracitioner ID History
A person who is directly or indirectly involved in the provisioning of healthcare.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
identifier
|
identifier | array of object |
identifier |
|
system
|
identifier.system | string |
system |
|
value
|
identifier.value | string |
value |
|
active
|
active | boolean |
active |
|
name
|
name | array of object |
name |
|
family
|
name.family | string |
family |
|
given
|
name.given | array of string |
given |
|
prefix
|
name.prefix | array of string |
prefix |
|
telecom
|
telecom | array of object |
telecom |
|
system
|
telecom.system | string |
system |
|
value
|
telecom.value | string |
value |
|
use
|
telecom.use | string |
use |
|
address
|
address | array of object |
address |
|
line
|
address.line | array of string |
line |
|
city
|
address.city | string |
city |
|
state
|
address.state | string |
state |
|
postalCode
|
address.postalCode | string |
postalCode |
|
country
|
address.country | string |
country |
|
gender
|
gender | string |
gender |
Get Practitioner
A person who is directly or indirectly involved in the provisioning of healthcare.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
count
|
_count | string |
results returned in a series of pages |
|
|
sort
|
_sort | string |
order to return the results by using the parameter |
|
|
search
|
patient |
clinical-patient |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
type
|
type | string |
type |
|
link
|
link | array of object |
link |
|
relation
|
link.relation | string |
relation |
|
url
|
link.url | string |
url |
|
entry
|
entry | array of object |
entry |
|
fullUrl
|
entry.fullUrl | string |
fullUrl |
|
resourceType
|
entry.resource.resourceType | string |
resourceType |
|
id
|
entry.resource.id | string |
id |
|
versionId
|
entry.resource.meta.versionId | string |
versionId |
|
lastUpdated
|
entry.resource.meta.lastUpdated | string |
lastUpdated |
|
identifier
|
entry.resource.identifier | array of object |
identifier |
|
system
|
entry.resource.identifier.system | string |
system |
|
value
|
entry.resource.identifier.value | string |
value |
|
active
|
entry.resource.active | boolean |
active |
|
name
|
entry.resource.name | array of object |
name |
|
family
|
entry.resource.name.family | string |
family |
|
given
|
entry.resource.name.given | array of string |
given |
|
prefix
|
entry.resource.name.prefix | array of string |
prefix |
|
telecom
|
entry.resource.telecom | array of object |
telecom |
|
system
|
entry.resource.telecom.system | string |
system |
|
value
|
entry.resource.telecom.value | string |
value |
|
use
|
entry.resource.telecom.use | string |
use |
|
address
|
entry.resource.address | array of object |
address |
|
line
|
entry.resource.address.line | array of string |
line |
|
city
|
entry.resource.address.city | string |
city |
|
state
|
entry.resource.address.state | string |
state |
|
postalCode
|
entry.resource.address.postalCode | string |
postalCode |
|
country
|
entry.resource.address.country | string |
country |
|
gender
|
entry.resource.gender | string |
gender |
|
mode
|
entry.search.mode | string |
mode |
Get Practitioner History
A person who is directly or indirectly involved in the provisioning of healthcare.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
identifier
|
identifier | array of object |
identifier |
|
system
|
identifier.system | string |
system |
|
value
|
identifier.value | string |
value |
|
active
|
active | boolean |
active |
|
name
|
name | array of object |
name |
|
family
|
name.family | string |
family |
|
given
|
name.given | array of string |
given |
|
prefix
|
name.prefix | array of string |
prefix |
|
telecom
|
telecom | array of object |
telecom |
|
system
|
telecom.system | string |
system |
|
value
|
telecom.value | string |
value |
|
use
|
telecom.use | string |
use |
|
address
|
address | array of object |
address |
|
line
|
address.line | array of string |
line |
|
city
|
address.city | string |
city |
|
state
|
address.state | string |
state |
|
postalCode
|
address.postalCode | string |
postalCode |
|
country
|
address.country | string |
country |
|
gender
|
gender | string |
gender |
Get Practitioner ID
A person who is directly or indirectly involved in the provisioning of healthcare.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
identifier
|
identifier | array of object |
identifier |
|
system
|
identifier.system | string |
system |
|
value
|
identifier.value | string |
value |
|
active
|
active | boolean |
active |
|
name
|
name | array of object |
name |
|
family
|
name.family | string |
family |
|
given
|
name.given | array of string |
given |
|
prefix
|
name.prefix | array of string |
prefix |
|
telecom
|
telecom | array of object |
telecom |
|
system
|
telecom.system | string |
system |
|
value
|
telecom.value | string |
value |
|
use
|
telecom.use | string |
use |
|
address
|
address | array of object |
address |
|
line
|
address.line | array of string |
line |
|
city
|
address.city | string |
city |
|
state
|
address.state | string |
state |
|
postalCode
|
address.postalCode | string |
postalCode |
|
country
|
address.country | string |
country |
|
gender
|
gender | string |
gender |
Get Practitioner ID Version
A person who is directly or indirectly involved in the provisioning of healthcare.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
history
|
vid | True | string |
Changes made to the Value Set Definition over time |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
identifier
|
identifier | array of object |
identifier |
|
system
|
identifier.system | string |
system |
|
value
|
identifier.value | string |
value |
|
active
|
active | boolean |
active |
|
name
|
name | array of object |
name |
|
family
|
name.family | string |
family |
|
given
|
name.given | array of string |
given |
|
prefix
|
name.prefix | array of string |
prefix |
|
telecom
|
telecom | array of object |
telecom |
|
system
|
telecom.system | string |
system |
|
value
|
telecom.value | string |
value |
|
use
|
telecom.use | string |
use |
|
address
|
address | array of object |
address |
|
line
|
address.line | array of string |
line |
|
city
|
address.city | string |
city |
|
state
|
address.state | string |
state |
|
postalCode
|
address.postalCode | string |
postalCode |
|
country
|
address.country | string |
country |
|
gender
|
gender | string |
gender |
Post Appointment
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
status
|
status | string |
status |
|
|
div
|
div | string |
div |
|
|
status
|
status | string |
status |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
|
|
display
|
display | string |
display |
|
|
code
|
code | string |
code |
|
|
display
|
display | string |
display |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
|
|
display
|
display | string |
display |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
|
|
display
|
display | string |
display |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
priority
|
priority | integer |
priority |
|
|
description
|
description | string |
description |
|
|
start
|
start | string |
start |
|
|
end
|
end | string |
end |
|
|
created
|
created | string |
created |
|
|
comment
|
comment | string |
comment |
|
|
reference
|
reference | string |
reference |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
required
|
required | string |
required |
|
|
status
|
status | string |
status |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
status
|
status | string |
status |
|
participant
|
participant | array of object |
participant |
|
reference
|
participant.actor.reference | string |
reference |
|
display
|
participant.actor.display | string |
display |
|
required
|
participant.required | string |
required |
|
status
|
participant.status | string |
status |
|
type
|
participant.type | array of object |
type |
|
coding
|
participant.type.coding | array of object |
coding |
|
system
|
participant.type.coding.system | string |
system |
|
code
|
participant.type.coding.code | string |
code |
Post Appointment Response
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
status
|
status | string |
status |
|
|
div
|
div | string |
div |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
participantStatus
|
participantStatus | string |
participantStatus |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
reference
|
appointment.reference | string |
reference |
|
display
|
appointment.display | string |
display |
|
reference
|
actor.reference | string |
reference |
|
display
|
actor.display | string |
display |
|
participantStatus
|
participantStatus | string |
participantStatus |
Post Appointment Response ID
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
reference
|
appointment.reference | string |
reference |
|
display
|
appointment.display | string |
display |
|
reference
|
actor.reference | string |
reference |
|
display
|
actor.display | string |
display |
|
participantStatus
|
participantStatus | string |
participantStatus |
Post Device
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
versionId
|
versionId | string |
versionId |
|
|
lastUpdated
|
lastUpdated | string |
lastUpdated |
|
|
deviceIdentifier
|
deviceIdentifier | string |
deviceIdentifier |
|
|
carrierHRF
|
carrierHRF | string |
carrierHRF |
|
|
status
|
status | string |
status |
|
|
distinctIdentifier
|
distinctIdentifier | string |
distinctIdentifier |
|
|
manufactureDate
|
manufactureDate | string |
manufactureDate |
|
|
expirationDate
|
expirationDate | string |
expirationDate |
|
|
lotNumber
|
lotNumber | string |
lotNumber |
|
|
serialNumber
|
serialNumber | string |
serialNumber |
|
|
name
|
name | string |
name |
|
|
type
|
type | string |
type |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
|
|
display
|
display | string |
display |
|
|
text
|
text | string |
text |
|
|
reference
|
reference | string |
reference |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
udiCarrier
|
udiCarrier | array of object |
udiCarrier |
|
deviceIdentifier
|
udiCarrier.deviceIdentifier | string |
deviceIdentifier |
|
carrierHRF
|
udiCarrier.carrierHRF | string |
carrierHRF |
|
status
|
status | string |
status |
|
distinctIdentifier
|
distinctIdentifier | string |
distinctIdentifier |
|
manufactureDate
|
manufactureDate | string |
manufactureDate |
|
expirationDate
|
expirationDate | string |
expirationDate |
|
lotNumber
|
lotNumber | string |
lotNumber |
|
serialNumber
|
serialNumber | string |
serialNumber |
|
deviceName
|
deviceName | array of object |
deviceName |
|
name
|
deviceName.name | string |
name |
|
type
|
deviceName.type | string |
type |
|
coding
|
type.coding | array of object |
coding |
|
system
|
type.coding.system | string |
system |
|
code
|
type.coding.code | string |
code |
|
display
|
type.coding.display | string |
display |
|
text
|
type.text | string |
text |
|
reference
|
patient.reference | string |
reference |
Post Encounter
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
versionId
|
versionId | string |
versionId |
|
|
lastUpdated
|
lastUpdated | string |
lastUpdated |
|
|
status
|
status | string |
status |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
|
|
display
|
display | string |
display |
|
|
text
|
text | string |
text |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
start
|
start | string |
start |
|
|
end
|
end | string |
end |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
status | string |
status |
|
system
|
class.system | string |
system |
|
code
|
class.code | string |
code |
|
type
|
type | array of object |
type |
|
coding
|
type.coding | array of object |
coding |
|
system
|
type.coding.system | string |
system |
|
code
|
type.coding.code | string |
code |
|
display
|
type.coding.display | string |
display |
|
text
|
type.text | string |
text |
|
reference
|
subject.reference | string |
reference |
|
display
|
subject.display | string |
display |
|
participant
|
participant | array of object |
participant |
|
reference
|
participant.individual.reference | string |
reference |
|
display
|
participant.individual.display | string |
display |
|
start
|
period.start | string |
start |
|
end
|
period.end | string |
end |
|
reference
|
serviceProvider.reference | string |
reference |
|
display
|
serviceProvider.display | string |
display |
Post Flag
Prospective warnings of potential issues when providing care to the patient.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
status
|
status | string |
status |
|
|
div
|
div | string |
div |
|
|
value
|
value | string |
value |
|
|
status
|
status | string |
status |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
|
|
display
|
display | string |
display |
|
|
text
|
text | string |
text |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
|
|
display
|
display | string |
display |
|
|
text
|
text | string |
text |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
start
|
start | string |
start |
|
|
end
|
end | string |
end |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
identifier
|
identifier | array of object |
identifier |
|
value
|
identifier.value | string |
value |
|
status
|
status | string |
status |
|
category
|
category | array of object |
category |
|
coding
|
category.coding | array of object |
coding |
|
system
|
category.coding.system | string |
system |
|
code
|
category.coding.code | string |
code |
|
display
|
category.coding.display | string |
display |
|
text
|
category.text | string |
text |
|
coding
|
code.coding | array of object |
coding |
|
system
|
code.coding.system | string |
system |
|
code
|
code.coding.code | string |
code |
|
display
|
code.coding.display | string |
display |
|
text
|
code.text | string |
text |
|
reference
|
subject.reference | string |
reference |
|
display
|
subject.display | string |
display |
|
start
|
period.start | string |
start |
|
end
|
period.end | string |
end |
|
reference
|
author.reference | string |
reference |
|
display
|
author.display | string |
display |
Post Location
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
status
|
status | string |
status |
|
|
div
|
div | string |
div |
|
|
status
|
status | string |
status |
|
|
name
|
name | string |
name |
|
|
mode
|
mode | string |
mode |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
status
|
status | string |
status |
|
name
|
name | string |
name |
|
mode
|
mode | string |
mode |
|
reference
|
partOf.reference | string |
reference |
|
display
|
partOf.display | string |
display |
Post Patient
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
|
active
|
active | boolean |
active |
|
|
use
|
use | string |
use |
|
|
family
|
family | string |
family |
|
|
given
|
given | array of string |
given |
|
|
use
|
use | string |
use |
|
|
system
|
system | string |
system |
|
|
value
|
value | string |
value |
|
|
rank
|
rank | integer |
rank |
|
|
gender
|
gender | string |
gender |
|
|
birthDate
|
birthDate | string |
birthDate |
|
|
deceasedBoolean
|
deceasedBoolean | boolean |
deceasedBoolean |
|
|
use
|
use | string |
use |
|
|
type
|
type | string |
type |
|
|
text
|
text | string |
text |
|
|
line
|
line | array of string |
line |
|
|
city
|
city | string |
city |
|
|
district
|
district | string |
district |
|
|
state
|
state | string |
state |
|
|
postalCode
|
postalCode | string |
postalCode |
|
|
start
|
start | string |
start |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
active
|
active | boolean |
active |
|
name
|
name | array of object |
name |
|
use
|
name.use | string |
use |
|
family
|
name.family | string |
family |
|
given
|
name.given | array of string |
given |
|
telecom
|
telecom | array of object |
telecom |
|
use
|
telecom.use | string |
use |
|
system
|
telecom.system | string |
system |
|
value
|
telecom.value | string |
value |
|
rank
|
telecom.rank | integer |
rank |
|
gender
|
gender | string |
gender |
|
birthDate
|
birthDate | string |
birthDate |
|
deceasedBoolean
|
deceasedBoolean | boolean |
deceasedBoolean |
|
address
|
address | array of object |
address |
|
use
|
address.use | string |
use |
|
type
|
address.type | string |
type |
|
text
|
address.text | string |
text |
|
line
|
address.line | array of string |
line |
|
city
|
address.city | string |
city |
|
district
|
address.district | string |
district |
|
state
|
address.state | string |
state |
|
postalCode
|
address.postalCode | string |
postalCode |
|
start
|
address.period.start | string |
start |
Post Person
Demographics and administrative information about a person independent of a specific health-related context.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
use
|
use | string |
use |
|
|
family
|
family | string |
family |
|
|
given
|
given | array of string |
given |
|
|
system
|
system | string |
system |
|
|
value
|
value | string |
value |
|
|
use
|
use | string |
use |
|
|
gender
|
gender | string |
gender |
|
|
birthDate
|
birthDate | string |
birthDate |
|
|
use
|
use | string |
use |
|
|
line
|
line | array of string |
line |
|
|
city
|
city | string |
city |
|
|
state
|
state | string |
state |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
active
|
active | boolean |
active |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
assurance
|
assurance | string |
assurance |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
name
|
name | array of object |
name |
|
use
|
name.use | string |
use |
|
family
|
name.family | string |
family |
|
given
|
name.given | array of string |
given |
|
telecom
|
telecom | array of object |
telecom |
|
system
|
telecom.system | string |
system |
|
value
|
telecom.value | string |
value |
|
use
|
telecom.use | string |
use |
|
gender
|
gender | string |
gender |
|
birthDate
|
birthDate | string |
birthDate |
|
address
|
address | array of object |
address |
|
use
|
address.use | string |
use |
|
line
|
address.line | array of string |
line |
|
city
|
address.city | string |
city |
|
state
|
address.state | string |
state |
|
reference
|
managingOrganization.reference | string |
reference |
|
display
|
managingOrganization.display | string |
display |
|
active
|
active | boolean |
active |
|
link
|
link | array of object |
link |
|
reference
|
link.target.reference | string |
reference |
|
display
|
link.target.display | string |
display |
|
assurance
|
link.assurance | string |
assurance |
Post Practitioner
A person who is directly or indirectly involved in the provisioning of healthcare.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
|
system
|
system | string |
system |
|
|
value
|
value | string |
value |
|
|
active
|
active | boolean |
active |
|
|
family
|
family | string |
family |
|
|
given
|
given | array of string |
given |
|
|
prefix
|
prefix | array of string |
prefix |
|
|
use
|
use | string |
use |
|
|
line
|
line | array of string |
line |
|
|
city
|
city | string |
city |
|
|
state
|
state | string |
state |
|
|
postalCode
|
postalCode | string |
postalCode |
|
|
system
|
system | string |
system |
|
|
value
|
value | string |
value |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
|
|
display
|
display | string |
display |
|
|
text
|
text | string |
text |
|
|
start
|
start | string |
start |
|
|
display
|
display | string |
display |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
identifier
|
identifier | array of object |
identifier |
|
system
|
identifier.system | string |
system |
|
value
|
identifier.value | string |
value |
|
active
|
active | boolean |
active |
|
name
|
name | array of object |
name |
|
family
|
name.family | string |
family |
|
given
|
name.given | array of string |
given |
|
prefix
|
name.prefix | array of string |
prefix |
|
telecom
|
telecom | array of object |
telecom |
|
system
|
telecom.system | string |
system |
|
value
|
telecom.value | string |
value |
|
use
|
telecom.use | string |
use |
|
address
|
address | array of object |
address |
|
line
|
address.line | array of string |
line |
|
city
|
address.city | string |
city |
|
state
|
address.state | string |
state |
|
postalCode
|
address.postalCode | string |
postalCode |
|
country
|
address.country | string |
country |
|
gender
|
gender | string |
gender |
Put Appointment ID
A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
versionId
|
versionId | string |
versionId |
|
|
lastUpdated
|
lastUpdated | string |
lastUpdated |
|
|
status
|
status | string |
status |
|
|
div
|
div | string |
div |
|
|
status
|
status | string |
status |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
required
|
required | string |
required |
|
|
status
|
status | string |
status |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
status
|
status | string |
status |
|
participant
|
participant | array of object |
participant |
|
reference
|
participant.actor.reference | string |
reference |
|
display
|
participant.actor.display | string |
display |
|
required
|
participant.required | string |
required |
|
status
|
participant.status | string |
status |
|
type
|
participant.type | array of object |
type |
|
coding
|
participant.type.coding | array of object |
coding |
|
system
|
participant.type.coding.system | string |
system |
|
code
|
participant.type.coding.code | string |
code |
Put AppointmentResponse ID
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
versionId
|
versionId | string |
versionId |
|
|
lastUpdated
|
lastUpdated | string |
lastUpdated |
|
|
status
|
status | string |
status |
|
|
div
|
div | string |
div |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
participantStatus
|
participantStatus | string |
participantStatus |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
reference
|
appointment.reference | string |
reference |
|
display
|
appointment.display | string |
display |
|
reference
|
actor.reference | string |
reference |
|
display
|
actor.display | string |
display |
|
participantStatus
|
participantStatus | string |
participantStatus |
Put Device ID
A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
versionId
|
versionId | string |
versionId |
|
|
lastUpdated
|
lastUpdated | string |
lastUpdated |
|
|
status
|
status | string |
status |
|
|
div
|
div | string |
div |
|
|
system
|
system | string |
system |
|
|
value
|
value | string |
value |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
identifier
|
identifier | array of object |
identifier |
|
system
|
identifier.system | string |
system |
|
value
|
identifier.value | string |
value |
Put Encounter ID
An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
versionId
|
versionId | string |
versionId |
|
|
lastUpdated
|
lastUpdated | string |
lastUpdated |
|
|
status
|
status | string |
status |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
|
|
display
|
display | string |
display |
|
|
text
|
text | string |
text |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
start
|
start | string |
start |
|
|
end
|
end | string |
end |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
status
|
status | string |
status |
|
system
|
class.system | string |
system |
|
code
|
class.code | string |
code |
|
type
|
type | array of object |
type |
|
coding
|
type.coding | array of object |
coding |
|
system
|
type.coding.system | string |
system |
|
code
|
type.coding.code | string |
code |
|
display
|
type.coding.display | string |
display |
|
text
|
type.text | string |
text |
|
reference
|
subject.reference | string |
reference |
|
display
|
subject.display | string |
display |
|
participant
|
participant | array of object |
participant |
|
reference
|
participant.individual.reference | string |
reference |
|
display
|
participant.individual.display | string |
display |
|
start
|
period.start | string |
start |
|
end
|
period.end | string |
end |
|
reference
|
serviceProvider.reference | string |
reference |
|
display
|
serviceProvider.display | string |
display |
Put Flag ID
Prospective warnings of potential issues when providing care to the patient.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
status
|
status | string |
status |
|
|
div
|
div | string |
div |
|
|
value
|
value | string |
value |
|
|
status
|
status | string |
status |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
|
|
display
|
display | string |
display |
|
|
text
|
text | string |
text |
|
|
system
|
system | string |
system |
|
|
code
|
code | string |
code |
|
|
display
|
display | string |
display |
|
|
text
|
text | string |
text |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
start
|
start | string |
start |
|
|
end
|
end | string |
end |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
identifier
|
identifier | array of object |
identifier |
|
value
|
identifier.value | string |
value |
|
status
|
status | string |
status |
|
category
|
category | array of object |
category |
|
coding
|
category.coding | array of object |
coding |
|
system
|
category.coding.system | string |
system |
|
code
|
category.coding.code | string |
code |
|
display
|
category.coding.display | string |
display |
|
text
|
category.text | string |
text |
|
coding
|
code.coding | array of object |
coding |
|
system
|
code.coding.system | string |
system |
|
code
|
code.coding.code | string |
code |
|
display
|
code.coding.display | string |
display |
|
text
|
code.text | string |
text |
|
reference
|
subject.reference | string |
reference |
|
display
|
subject.display | string |
display |
|
start
|
period.start | string |
start |
|
end
|
period.end | string |
end |
|
reference
|
author.reference | string |
reference |
|
display
|
author.display | string |
display |
Put Location ID
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
status
|
status | string |
status |
|
|
div
|
div | string |
div |
|
|
status
|
status | string |
status |
|
|
name
|
name | string |
name |
|
|
mode
|
mode | string |
mode |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
status
|
text.status | string |
status |
|
div
|
text.div | string |
div |
|
status
|
status | string |
status |
|
name
|
name | string |
name |
|
mode
|
mode | string |
mode |
|
reference
|
partOf.reference | string |
reference |
|
display
|
partOf.display | string |
display |
Put Patient ID
Demographics and other administrative information about an individual or animal receiving care or other health-related services.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
active
|
active | boolean |
active |
|
|
use
|
use | string |
use |
|
|
family
|
family | string |
family |
|
|
given
|
given | array of string |
given |
|
|
use
|
use | string |
use |
|
|
system
|
system | string |
system |
|
|
value
|
value | string |
value |
|
|
rank
|
rank | integer |
rank |
|
|
gender
|
gender | string |
gender |
|
|
birthDate
|
birthDate | string |
birthDate |
|
|
deceasedBoolean
|
deceasedBoolean | boolean |
deceasedBoolean |
|
|
use
|
use | string |
use |
|
|
type
|
type | string |
type |
|
|
text
|
text | string |
text |
|
|
line
|
line | array of string |
line |
|
|
city
|
city | string |
city |
|
|
district
|
district | string |
district |
|
|
state
|
state | string |
state |
|
|
postalCode
|
postalCode | string |
postalCode |
|
|
start
|
start | string |
start |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
active
|
active | boolean |
active |
|
name
|
name | array of object |
name |
|
use
|
name.use | string |
use |
|
family
|
name.family | string |
family |
|
given
|
name.given | array of string |
given |
|
telecom
|
telecom | array of object |
telecom |
|
use
|
telecom.use | string |
use |
|
system
|
telecom.system | string |
system |
|
value
|
telecom.value | string |
value |
|
rank
|
telecom.rank | integer |
rank |
|
gender
|
gender | string |
gender |
|
birthDate
|
birthDate | string |
birthDate |
|
deceasedBoolean
|
deceasedBoolean | boolean |
deceasedBoolean |
|
address
|
address | array of object |
address |
|
use
|
address.use | string |
use |
|
type
|
address.type | string |
type |
|
text
|
address.text | string |
text |
|
line
|
address.line | array of string |
line |
|
city
|
address.city | string |
city |
|
district
|
address.district | string |
district |
|
state
|
address.state | string |
state |
|
postalCode
|
address.postalCode | string |
postalCode |
|
start
|
address.period.start | string |
start |
Put Person ID
Demographics and administrative information about a person independent of a specific health-related context.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
use
|
use | string |
use |
|
|
family
|
family | string |
family |
|
|
given
|
given | array of string |
given |
|
|
system
|
system | string |
system |
|
|
value
|
value | string |
value |
|
|
use
|
use | string |
use |
|
|
gender
|
gender | string |
gender |
|
|
birthDate
|
birthDate | string |
birthDate |
|
|
use
|
use | string |
use |
|
|
line
|
line | array of string |
line |
|
|
city
|
city | string |
city |
|
|
state
|
state | string |
state |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
active
|
active | boolean |
active |
|
|
reference
|
reference | string |
reference |
|
|
display
|
display | string |
display |
|
|
assurance
|
assurance | string |
assurance |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
name
|
name | array of object |
name |
|
use
|
name.use | string |
use |
|
family
|
name.family | string |
family |
|
given
|
name.given | array of string |
given |
|
telecom
|
telecom | array of object |
telecom |
|
system
|
telecom.system | string |
system |
|
value
|
telecom.value | string |
value |
|
use
|
telecom.use | string |
use |
|
gender
|
gender | string |
gender |
|
birthDate
|
birthDate | string |
birthDate |
|
address
|
address | array of object |
address |
|
use
|
address.use | string |
use |
|
line
|
address.line | array of string |
line |
|
city
|
address.city | string |
city |
|
state
|
address.state | string |
state |
|
reference
|
managingOrganization.reference | string |
reference |
|
display
|
managingOrganization.display | string |
display |
|
active
|
active | boolean |
active |
|
link
|
link | array of object |
link |
|
reference
|
link.target.reference | string |
reference |
|
display
|
link.target.display | string |
display |
|
assurance
|
link.assurance | string |
assurance |
Put Practitioner ID
A person who is directly or indirectly involved in the provisioning of healthcare.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id
|
id | True | string |
logical id of the resource |
|
resourceType
|
resourceType | string |
resourceType |
|
|
id
|
id | string |
id |
|
|
versionId
|
versionId | string |
versionId |
|
|
lastUpdated
|
lastUpdated | string |
lastUpdated |
|
|
system
|
system | string |
system |
|
|
value
|
value | string |
value |
|
|
active
|
active | boolean |
active |
|
|
family
|
family | string |
family |
|
|
given
|
given | array of string |
given |
|
|
prefix
|
prefix | array of string |
prefix |
|
|
system
|
system | string |
system |
|
|
value
|
value | string |
value |
|
|
use
|
use | string |
use |
|
|
line
|
line | array of string |
line |
|
|
city
|
city | string |
city |
|
|
state
|
state | string |
state |
|
|
postalCode
|
postalCode | string |
postalCode |
|
|
country
|
country | string |
country |
|
|
gender
|
gender | string |
gender |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resourceType
|
resourceType | string |
resourceType |
|
id
|
id | string |
id |
|
versionId
|
meta.versionId | string |
versionId |
|
lastUpdated
|
meta.lastUpdated | string |
lastUpdated |
|
identifier
|
identifier | array of object |
identifier |
|
system
|
identifier.system | string |
system |
|
value
|
identifier.value | string |
value |
|
active
|
active | boolean |
active |
|
name
|
name | array of object |
name |
|
family
|
name.family | string |
family |
|
given
|
name.given | array of string |
given |
|
prefix
|
name.prefix | array of string |
prefix |
|
telecom
|
telecom | array of object |
telecom |
|
system
|
telecom.system | string |
system |
|
value
|
telecom.value | string |
value |
|
use
|
telecom.use | string |
use |
|
address
|
address | array of object |
address |
|
line
|
address.line | array of string |
line |
|
city
|
address.city | string |
city |
|
state
|
address.state | string |
state |
|
postalCode
|
address.postalCode | string |
postalCode |
|
country
|
address.country | string |
country |
|
gender
|
gender | string |
gender |