FHIRClinical (Preview)

Microsoft FHIR Server Connector for FHIR R4 Clinical 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 HealthArchitectures@windows.microsoft.com
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 FHIRClinical 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

Delete AdverseEvent ID

Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care

Delete AllergyIntolerance ID

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

Delete CarePlan ID

Describes the intention of how one or more practitioners intend to deliver care for a particular patient

Delete Condition ID

A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

Delete DiagnosticReport ID

The findings and interpretation of diagnostic tests performed on patients

Delete Medication ID

This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering

Delete MedicationRequest ID

An order or request for both supply of the medication and the instructions for administration of the medication to a patient.

Delete MedicationStatement ID

A record of a medication that is being consumed by a patient

Delete Observation ID

Observations are used to support diagnosis, monitor progress, determine baselines and patterns and even capture demographic characteristics

Delete Procedure ID

An action that is or was performed on or for a patient

Delete RiskAssessment ID

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

Get AdverseEvent

Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care

Get AdverseEvent ID

Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care

Get AllergyIntolerance

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance

Get AllergyIntolerance ID

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

Get CarePlan

Describes the intention of how one or more practitioners intend to deliver care for a particular patient

Get CarePlan ID

Describes the intention of how one or more practitioners intend to deliver care for a particular patient

Get CareTeam

The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient

Get CareTeam ID

The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient

Get Condition

A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

Get Condition ID

A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

Get DiagnosticReport

The findings and interpretation of diagnostic tests performed on patients

Get DiagnosticReport ID

The findings and interpretation of diagnostic tests performed on patients

Get Medication

This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering

Get Medication ID

This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering

Get MedicationRequest

An order or request for both supply of the medication and the instructions for administration of the medication to a patient.

Get MedicationRequest ID

An order or request for both supply of the medication and the instructions for administration of the medication to a patient.

Get MedicationStatement

A record of a medication that is being consumed by a patient

Get MedicationStatement ID

A record of a medication that is being consumed by a patient

Get Observation

Observations are used to support diagnosis, monitor progress, determine baselines and patterns and even capture demographic characteristics

Get Observation ID

Observations are used to support diagnosis, monitor progress, determine baselines and patterns and even capture demographic characteristics

Get Procedure

An action that is or was performed on or for a patient

Get Procedure ID

An action that is or was performed on or for a patient

Get RiskAssessment

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

Get RiskAssessment ID

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

Post AdverseEvent

Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care

Post AllergyIntolerance

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

Post CarePlan

Describes the intention of how one or more practitioners intend to deliver care for a particular patient

Post Condition

A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

Post DiagnosticReport

The findings and interpretation of diagnostic tests performed on patients

Post Medication

This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering

Post MedicationRequest

An order or request for both supply of the medication and the instructions for administration of the medication to a patient.

Post MedicationStatement

A record of a medication that is being consumed by a patient

Post Observation

Observations are used to support diagnosis, monitor progress, determine baselines and patterns and even capture demographic characteristics

Post Procedure

An action that is or was performed on or for a patient

Post RiskAssessment

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

Put AdverseEvent ID

Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care

Put AllergyIntolerance

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

Put CarePlan ID

Describes the intention of how one or more practitioners intend to deliver care for a particular patient

Put Condition ID

A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

Put DiagnosticReport ID

The findings and interpretation of diagnostic tests performed on patients

Put Medication ID

This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering

Put MedicationRequest ID

An order or request for both supply of the medication and the instructions for administration of the medication to a patient.

Put MedicationStatement ID

A record of a medication that is being consumed by a patient

Put Observation ID

Observations are used to support diagnosis, monitor progress, determine baselines and patterns and even capture demographic characteristics

Put Procedure ID

An action that is or was performed on or for a patient

Put RiskAssessment ID

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

Delete AdverseEvent ID

Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care

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

actuality
actuality string

actuality

system
system string

system

code
code string

code

display
display string

display

system
system string

system

code
code string

code

display
display string

display

text
text string

text

reference
reference string

reference

date
date string

date

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

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

system
identifier.system string

system

value
identifier.value string

value

actuality
actuality string

actuality

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

coding
event.coding array of object

coding

system
event.coding.system string

system

code
event.coding.code string

code

display
event.coding.display string

display

text
event.text string

text

reference
subject.reference string

reference

date
date string

date

coding
seriousness.coding array of object

coding

system
seriousness.coding.system string

system

code
seriousness.coding.code string

code

display
seriousness.coding.display string

display

coding
severity.coding array of object

coding

system
severity.coding.system string

system

code
severity.coding.code string

code

display
severity.coding.display string

display

reference
recorder.reference string

reference

suspectEntity
suspectEntity array of object

suspectEntity

reference
suspectEntity.instance.reference string

reference

Delete AllergyIntolerance ID

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

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

code
code string

code

system
system string

system

code
code string

code

type
type string

type

category
category array of string

category

criticality
criticality string

criticality

system
system string

system

code
code string

code

display
display string

display

text
text string

text

reference
reference string

reference

recordedDate
recordedDate string

recordedDate

Returns

Name Path Type Description
resourceType
resourceType string

resourceType

id
id string

id

versionId
meta.versionId string

versionId

lastUpdated
meta.lastUpdated string

lastUpdated

coding
clinicalStatus.coding array of object

coding

system
clinicalStatus.coding.system string

system

code
clinicalStatus.coding.code string

code

coding
verificationStatus.coding array of object

coding

system
verificationStatus.coding.system string

system

code
verificationStatus.coding.code string

code

type
type string

type

category
category array of string

category

criticality
criticality string

criticality

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
patient.reference string

reference

recordedDate
recordedDate string

recordedDate

Delete CarePlan ID

Describes the intention of how one or more practitioners intend to deliver care for a particular 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

resourceType
resourceType string

resourceType

id
id string

id

system
system string

system

code
code string

code

system
system string

system

code
code string

code

text
text string

text

reference
reference string

reference

display
display string

display

id
id string

id

system
system string

system

code
code string

code

text
text string

text

reference
reference string

reference

display
display string

display

lifecycleStatus
lifecycleStatus string

lifecycleStatus

text
text string

text

status
status string

status

intent
intent string

intent

reference
reference string

reference

display
display string

display

start
start string

start

reference
reference string

reference

reference
reference string

reference

display
display string

display

reference
reference string

reference

reference
reference string

reference

kind
kind string

kind

system
system string

system

code
code string

code

text
text string

text

status
status string

status

doNotPerform
doNotPerform boolean

doNotPerform

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
text.status string

status

contained
contained array of object

contained

resourceType
contained.resourceType string

resourceType

id
contained.id string

id

coding
contained.clinicalStatus.coding array of object

coding

system
contained.clinicalStatus.coding.system string

system

code
contained.clinicalStatus.coding.code string

code

coding
contained.verificationStatus.coding array of object

coding

system
contained.verificationStatus.coding.system string

system

code
contained.verificationStatus.coding.code string

code

text
contained.code.text string

text

reference
contained.subject.reference string

reference

display
contained.subject.display string

display

participant
contained.participant array of object

participant

id
contained.participant.id string

id

role
contained.participant.role array of object

role

coding
contained.participant.role.coding array of object

coding

system
contained.participant.role.coding.system string

system

code
contained.participant.role.coding.code string

code

text
contained.participant.role.text string

text

reference
contained.participant.member.reference string

reference

display
contained.participant.member.display string

display

lifecycleStatus
contained.lifecycleStatus string

lifecycleStatus

text
contained.description.text string

text

status
status string

status

intent
intent string

intent

reference
subject.reference string

reference

display
subject.display string

display

start
period.start string

start

careTeam
careTeam array of object

careTeam

reference
careTeam.reference string

reference

addresses
addresses array of object

addresses

reference
addresses.reference string

reference

display
addresses.display string

display

goal
goal array of object

goal

reference
goal.reference string

reference

activity
activity array of object

activity

outcomeReference
activity.outcomeReference array of object

outcomeReference

reference
activity.outcomeReference.reference string

reference

kind
activity.detail.kind string

kind

coding
activity.detail.code.coding array of object

coding

system
activity.detail.code.coding.system string

system

code
activity.detail.code.coding.code string

code

text
activity.detail.code.text string

text

status
activity.detail.status string

status

doNotPerform
activity.detail.doNotPerform boolean

doNotPerform

start
activity.detail.scheduledPeriod.start string

start

end
activity.detail.scheduledPeriod.end string

end

performer
activity.detail.performer array of object

performer

reference
activity.detail.performer.reference string

reference

display
activity.detail.performer.display string

display

Delete Condition ID

A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

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

system
system string

system

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

text
text string

text

system
system string

system

code
code string

code

display
display string

display

text
text string

text

reference
reference string

reference

onsetDateTime
onsetDateTime string

onsetDateTime

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

coding
clinicalStatus.coding array of object

coding

system
clinicalStatus.coding.system string

system

code
clinicalStatus.coding.code string

code

coding
verificationStatus.coding array of object

coding

system
verificationStatus.coding.system string

system

code
verificationStatus.coding.code string

code

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

coding
severity.coding array of object

coding

system
severity.coding.system string

system

code
severity.coding.code string

code

display
severity.coding.display string

display

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

bodySite
bodySite array of object

bodySite

coding
bodySite.coding array of object

coding

system
bodySite.coding.system string

system

code
bodySite.coding.code string

code

display
bodySite.coding.display string

display

text
bodySite.text string

text

reference
subject.reference string

reference

onsetDateTime
onsetDateTime string

onsetDateTime

Delete DiagnosticReport ID

The findings and interpretation of diagnostic tests performed on patients

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

use
use string

use

system
system string

system

value
value string

value

reference
reference string

reference

status
status string

status

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

issued
issued string

issued

reference
reference string

reference

display
display string

display

reference
reference string

reference

conclusion
conclusion string

conclusion

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

identifier
identifier array of object

identifier

use
identifier.use string

use

system
identifier.system string

system

value
identifier.value string

value

basedOn
basedOn array of object

basedOn

reference
basedOn.reference string

reference

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

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

reference
subject.reference string

reference

display
subject.display string

display

issued
issued string

issued

performer
performer array of object

performer

reference
performer.reference string

reference

display
performer.display string

display

result
result array of object

result

reference
result.reference string

reference

conclusion
conclusion string

conclusion

Delete Medication ID

This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering

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

resourceType
resourceType string

resourceType

id
id string

id

name
name string

name

system
system string

system

code
code string

code

display
display string

display

status
status string

status

reference
reference string

reference

system
system string

system

code
code string

code

display
display string

display

system
system string

system

code
code string

code

display
display string

display

isActive
isActive boolean

isActive

value
value integer

value

system
system string

system

code
code string

code

value
value integer

value

system
system string

system

code
code string

code

lotNumber
lotNumber string

lotNumber

expirationDate
expirationDate string

expirationDate

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

contained
contained array of object

contained

resourceType
contained.resourceType string

resourceType

id
contained.id string

id

name
contained.name string

name

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

status
status string

status

reference
manufacturer.reference string

reference

coding
form.coding array of object

coding

system
form.coding.system string

system

code
form.coding.code string

code

display
form.coding.display string

display

ingredient
ingredient array of object

ingredient

coding
ingredient.itemCodeableConcept.coding array of object

coding

system
ingredient.itemCodeableConcept.coding.system string

system

code
ingredient.itemCodeableConcept.coding.code string

code

display
ingredient.itemCodeableConcept.coding.display string

display

isActive
ingredient.isActive boolean

isActive

value
ingredient.strength.numerator.value integer

value

system
ingredient.strength.numerator.system string

system

code
ingredient.strength.numerator.code string

code

value
ingredient.strength.denominator.value integer

value

system
ingredient.strength.denominator.system string

system

code
ingredient.strength.denominator.code string

code

lotNumber
batch.lotNumber string

lotNumber

expirationDate
batch.expirationDate string

expirationDate

Delete MedicationRequest ID

An order or request for both supply of the medication and the instructions for administration of the medication to 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

status
status string

status

resourceType
resourceType string

resourceType

id
id string

id

system
system string

system

code
code string

code

display
display string

display

use
use string

use

system
system string

system

value
value string

value

status
status string

status

intent
intent string

intent

reference
reference string

reference

reference
reference string

reference

display
display string

display

reference
reference string

reference

display
display string

display

reference
reference string

reference

authoredOn
authoredOn string

authoredOn

reference
reference string

reference

display
display string

display

system
system string

system

code
code string

code

display
display string

display

text
text string

text

sequence
sequence integer

sequence

text
text string

text

system
system string

system

code
code string

code

display
display string

display

frequency
frequency integer

frequency

period
period integer

period

periodUnit
periodUnit string

periodUnit

system
system string

system

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

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

start
start string

start

end
end string

end

numberOfRepeatsAllowed
numberOfRepeatsAllowed integer

numberOfRepeatsAllowed

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

allowedBoolean
allowedBoolean boolean

allowedBoolean

system
system string

system

code
code string

code

display
display string

display

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

intent
entry.resource.intent string

intent

coding
entry.resource.medicationCodeableConcept.coding array of object

coding

system
entry.resource.medicationCodeableConcept.coding.system string

system

code
entry.resource.medicationCodeableConcept.coding.code string

code

display
entry.resource.medicationCodeableConcept.coding.display string

display

text
entry.resource.medicationCodeableConcept.text string

text

reference
entry.resource.subject.reference string

reference

reference
entry.resource.encounter.reference string

reference

authoredOn
entry.resource.authoredOn string

authoredOn

reference
entry.resource.requester.reference string

reference

display
entry.resource.requester.display string

display

dosageInstruction
entry.resource.dosageInstruction array of object

dosageInstruction

sequence
entry.resource.dosageInstruction.sequence integer

sequence

asNeededBoolean
entry.resource.dosageInstruction.asNeededBoolean boolean

asNeededBoolean

frequency
entry.resource.dosageInstruction.timing.repeat.frequency integer

frequency

period
entry.resource.dosageInstruction.timing.repeat.period integer

period

periodUnit
entry.resource.dosageInstruction.timing.repeat.periodUnit string

periodUnit

doseAndRate
entry.resource.dosageInstruction.doseAndRate array of object

doseAndRate

coding
entry.resource.dosageInstruction.doseAndRate.type.coding array of object

coding

system
entry.resource.dosageInstruction.doseAndRate.type.coding.system string

system

code
entry.resource.dosageInstruction.doseAndRate.type.coding.code string

code

display
entry.resource.dosageInstruction.doseAndRate.type.coding.display string

display

value
entry.resource.dosageInstruction.doseAndRate.doseQuantity.value integer

value

reasonReference
entry.resource.reasonReference array of object

reasonReference

reference
entry.resource.reasonReference.reference string

reference

mode
entry.search.mode string

mode

Delete MedicationStatement ID

A record of a medication that is being consumed by 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

status
status string

status

status
status string

status

text
text string

text

reference
reference string

reference

display
display string

display

effectiveDateTime
effectiveDateTime string

effectiveDateTime

dateAsserted
dateAsserted string

dateAsserted

reference
reference string

reference

display
display string

display

reference
reference string

reference

text
text string

text

sequence
sequence integer

sequence

text
text string

text

asNeededBoolean
asNeededBoolean boolean

asNeededBoolean

system
system string

system

code
code string

code

display
display string

display

system
system string

system

code
code string

code

display
display string

display

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

value
value integer

value

value
value integer

value

system
system string

system

code
code string

code

Delete Observation ID

Observations are used to support diagnosis, monitor progress, determine baselines and patterns and even capture demographic characteristics

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

status
status string

status

system
system string

system

code
code string

code

display
display string

display

system
system string

system

code
code string

code

display
display string

display

text
text string

text

reference
reference string

reference

display
display string

display

issued
issued string

issued

reference
reference string

reference

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

system
system string

system

code
code string

code

system
system string

system

code
code string

code

display
display string

display

system
system string

system

code
code string

code

display
display string

display

value
value float

value

unit
unit string

unit

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

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

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

issued
issued string

issued

performer
performer array of object

performer

reference
performer.reference string

reference

value
valueQuantity.value integer

value

unit
valueQuantity.unit string

unit

system
valueQuantity.system string

system

code
valueQuantity.code string

code

interpretation
interpretation array of object

interpretation

coding
interpretation.coding array of object

coding

system
interpretation.coding.system string

system

code
interpretation.coding.code string

code

coding
bodySite.coding array of object

coding

system
bodySite.coding.system string

system

code
bodySite.coding.code string

code

display
bodySite.coding.display string

display

coding
method.coding array of object

coding

system
method.coding.system string

system

code
method.coding.code string

code

display
method.coding.display string

display

referenceRange
referenceRange array of object

referenceRange

value
referenceRange.high.value float

value

unit
referenceRange.high.unit string

unit

Delete Procedure ID

An action that is or was performed on or for 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

status
status string

status

system
system string

system

code
code string

code

display
display string

display

text
text string

text

reference
reference string

reference

performedDateTime
performedDateTime string

performedDateTime

reference
reference string

reference

display
display string

display

reference
reference string

reference

display
display string

display

reference
reference string

reference

display
display string

display

text
text string

text

text
text string

text

text
text string

text

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

status
status string

status

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

performedDateTime
performedDateTime string

performedDateTime

reference
recorder.reference string

reference

display
recorder.display string

display

reference
asserter.reference string

reference

display
asserter.display string

display

performer
performer array of object

performer

reference
performer.actor.reference string

reference

display
performer.actor.display string

display

reasonCode
reasonCode array of object

reasonCode

text
reasonCode.text string

text

followUp
followUp array of object

followUp

text
followUp.text string

text

note
note array of object

note

text
note.text string

text

Delete RiskAssessment ID

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

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

status
status string

status

code
code string

code

reference
reference string

reference

occurrenceDateTime
occurrenceDateTime string

occurrenceDateTime

reference
reference string

reference

text
text string

text

probabilityDecimal
probabilityDecimal float

probabilityDecimal

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

text
text string

text

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

status
status string

status

coding
method.coding array of object

coding

code
method.coding.code string

code

reference
subject.reference string

reference

occurrenceDateTime
occurrenceDateTime string

occurrenceDateTime

basis
basis array of object

basis

reference
basis.reference string

reference

prediction
prediction array of object

prediction

text
prediction.outcome.text string

text

probabilityDecimal
prediction.probabilityDecimal float

probabilityDecimal

value
prediction.whenRange.high.value integer

value

unit
prediction.whenRange.high.unit string

unit

system
prediction.whenRange.high.system string

system

code
prediction.whenRange.high.code string

code

value
prediction.whenRange.low.value integer

value

unit
prediction.whenRange.low.unit string

unit

system
prediction.whenRange.low.system string

system

code
prediction.whenRange.low.code string

code

note
note array of object

note

text
note.text string

text

Get AdverseEvent

Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care

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

system
entry.resource.identifier.system string

system

value
entry.resource.identifier.value string

value

actuality
entry.resource.actuality string

actuality

category
entry.resource.category array of object

category

coding
entry.resource.category.coding array of object

coding

system
entry.resource.category.coding.system string

system

code
entry.resource.category.coding.code string

code

display
entry.resource.category.coding.display string

display

coding
entry.resource.event.coding array of object

coding

system
entry.resource.event.coding.system string

system

code
entry.resource.event.coding.code string

code

display
entry.resource.event.coding.display string

display

text
entry.resource.event.text string

text

reference
entry.resource.subject.reference string

reference

date
entry.resource.date string

date

coding
entry.resource.seriousness.coding array of object

coding

system
entry.resource.seriousness.coding.system string

system

code
entry.resource.seriousness.coding.code string

code

display
entry.resource.seriousness.coding.display string

display

coding
entry.resource.severity.coding array of object

coding

system
entry.resource.severity.coding.system string

system

code
entry.resource.severity.coding.code string

code

display
entry.resource.severity.coding.display string

display

reference
entry.resource.recorder.reference string

reference

suspectEntity
entry.resource.suspectEntity array of object

suspectEntity

reference
entry.resource.suspectEntity.instance.reference string

reference

mode
entry.search.mode string

mode

Get AdverseEvent ID

Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care

Parameters

Name Key Required Type Description
id
id True string

logical id of the resource

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

versionId
meta.versionId string

versionId

lastUpdated
meta.lastUpdated string

lastUpdated

system
identifier.system string

system

value
identifier.value string

value

actuality
actuality string

actuality

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

coding
event.coding array of object

coding

system
event.coding.system string

system

code
event.coding.code string

code

display
event.coding.display string

display

text
event.text string

text

reference
subject.reference string

reference

date
date string

date

coding
seriousness.coding array of object

coding

system
seriousness.coding.system string

system

code
seriousness.coding.code string

code

display
seriousness.coding.display string

display

coding
severity.coding array of object

coding

system
severity.coding.system string

system

code
severity.coding.code string

code

display
severity.coding.display string

display

reference
recorder.reference string

reference

suspectEntity
suspectEntity array of object

suspectEntity

reference
suspectEntity.instance.reference string

reference

Get AllergyIntolerance

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance

Parameters

Name Key Required Type Description
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

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

coding
entry.resource.clinicalStatus.coding array of object

coding

system
entry.resource.clinicalStatus.coding.system string

system

code
entry.resource.clinicalStatus.coding.code string

code

coding
entry.resource.verificationStatus.coding array of object

coding

system
entry.resource.verificationStatus.coding.system string

system

code
entry.resource.verificationStatus.coding.code string

code

type
entry.resource.type string

type

category
entry.resource.category array of string

category

criticality
entry.resource.criticality string

criticality

coding
entry.resource.code.coding array of object

coding

system
entry.resource.code.coding.system string

system

code
entry.resource.code.coding.code string

code

display
entry.resource.code.coding.display string

display

text
entry.resource.code.text string

text

reference
entry.resource.patient.reference string

reference

recordedDate
entry.resource.recordedDate string

recordedDate

mode
entry.search.mode string

mode

Get AllergyIntolerance ID

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

Parameters

Name Key Required Type Description
id
id True string

logical id of the resource

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

versionId
meta.versionId string

versionId

lastUpdated
meta.lastUpdated string

lastUpdated

coding
clinicalStatus.coding array of object

coding

system
clinicalStatus.coding.system string

system

code
clinicalStatus.coding.code string

code

coding
verificationStatus.coding array of object

coding

system
verificationStatus.coding.system string

system

code
verificationStatus.coding.code string

code

type
type string

type

category
category array of string

category

criticality
criticality string

criticality

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
patient.reference string

reference

recordedDate
recordedDate string

recordedDate

Get CarePlan

Describes the intention of how one or more practitioners intend to deliver care for a particular patient

Parameters

Name Key Required Type Description
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

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

status
entry.resource.status string

status

intent
entry.resource.intent string

intent

category
entry.resource.category array of object

category

coding
entry.resource.category.coding array of object

coding

system
entry.resource.category.coding.system string

system

code
entry.resource.category.coding.code string

code

display
entry.resource.category.coding.display string

display

text
entry.resource.category.text string

text

reference
entry.resource.subject.reference string

reference

reference
entry.resource.encounter.reference string

reference

start
entry.resource.period.start string

start

end
entry.resource.period.end string

end

careTeam
entry.resource.careTeam array of object

careTeam

reference
entry.resource.careTeam.reference string

reference

addresses
entry.resource.addresses array of object

addresses

reference
entry.resource.addresses.reference string

reference

goal
entry.resource.goal array of object

goal

reference
entry.resource.goal.reference string

reference

activity
entry.resource.activity array of object

activity

coding
entry.resource.activity.detail.code.coding array of object

coding

system
entry.resource.activity.detail.code.coding.system string

system

code
entry.resource.activity.detail.code.coding.code string

code

display
entry.resource.activity.detail.code.coding.display string

display

text
entry.resource.activity.detail.code.text string

text

status
entry.resource.activity.detail.status string

status

display
entry.resource.activity.detail.location.display string

display

mode
entry.search.mode string

mode

Get CarePlan ID

Describes the intention of how one or more practitioners intend to deliver care for a particular patient

Parameters

Name Key Required Type Description
id
id True string

logical id of the resource

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

versionId
meta.versionId string

versionId

lastUpdated
meta.lastUpdated string

lastUpdated

status
text.status string

status

status
status string

status

intent
intent string

intent

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

title
title string

title

description
description string

description

reference
subject.reference string

reference

reference
encounter.reference string

reference

start
period.start string

start

end
period.end string

end

careTeam
careTeam array of object

careTeam

reference
careTeam.reference string

reference

addresses
addresses array of object

addresses

reference
addresses.reference string

reference

activity
activity array of object

activity

coding
activity.detail.code.coding array of object

coding

system
activity.detail.code.coding.system string

system

code
activity.detail.code.coding.code string

code

display
activity.detail.code.coding.display string

display

text
activity.detail.code.text string

text

status
activity.detail.status string

status

display
activity.detail.location.display string

display

Get CareTeam

The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient

Parameters

Name Key Required Type Description
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

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

reference
entry.resource.subject.reference string

reference

reference
entry.resource.encounter.reference string

reference

start
entry.resource.period.start string

start

end
entry.resource.period.end string

end

participant
entry.resource.participant array of object

participant

role
entry.resource.participant.role array of object

role

coding
entry.resource.participant.role.coding array of object

coding

system
entry.resource.participant.role.coding.system string

system

code
entry.resource.participant.role.coding.code string

code

display
entry.resource.participant.role.coding.display string

display

text
entry.resource.participant.role.text string

text

reference
entry.resource.participant.member.reference string

reference

display
entry.resource.participant.member.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

text
entry.resource.reasonCode.text string

text

managingOrganization
entry.resource.managingOrganization array of object

managingOrganization

reference
entry.resource.managingOrganization.reference string

reference

display
entry.resource.managingOrganization.display string

display

mode
entry.search.mode string

mode

Get CareTeam ID

The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for 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

reference
subject.reference string

reference

reference
encounter.reference string

reference

start
period.start string

start

participant
participant array of object

participant

role
participant.role array of object

role

coding
participant.role.coding array of object

coding

system
participant.role.coding.system string

system

code
participant.role.coding.code string

code

display
participant.role.coding.display string

display

text
participant.role.text string

text

reference
participant.member.reference string

reference

display
participant.member.display string

display

reasonCode
reasonCode array of object

reasonCode

coding
reasonCode.coding array of object

coding

system
reasonCode.coding.system string

system

code
reasonCode.coding.code string

code

display
reasonCode.coding.display string

display

text
reasonCode.text string

text

managingOrganization
managingOrganization array of object

managingOrganization

reference
managingOrganization.reference string

reference

display
managingOrganization.display string

display

Get Condition

A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

Parameters

Name Key Required Type Description
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

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

coding
entry.resource.clinicalStatus.coding array of object

coding

system
entry.resource.clinicalStatus.coding.system string

system

code
entry.resource.clinicalStatus.coding.code string

code

coding
entry.resource.verificationStatus.coding array of object

coding

system
entry.resource.verificationStatus.coding.system string

system

code
entry.resource.verificationStatus.coding.code string

code

coding
entry.resource.code.coding array of object

coding

system
entry.resource.code.coding.system string

system

code
entry.resource.code.coding.code string

code

display
entry.resource.code.coding.display string

display

text
entry.resource.code.text string

text

reference
entry.resource.subject.reference string

reference

reference
entry.resource.encounter.reference string

reference

onsetDateTime
entry.resource.onsetDateTime string

onsetDateTime

recordedDate
entry.resource.recordedDate string

recordedDate

abatementDateTime
entry.resource.abatementDateTime string

abatementDateTime

mode
entry.search.mode string

mode

Get Condition ID

A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

Parameters

Name Key Required Type Description
id
id True string

logical id of the resource

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

versionId
meta.versionId string

versionId

lastUpdated
meta.lastUpdated string

lastUpdated

status
text.status string

status

coding
clinicalStatus.coding array of object

coding

system
clinicalStatus.coding.system string

system

code
clinicalStatus.coding.code string

code

coding
verificationStatus.coding array of object

coding

system
verificationStatus.coding.system string

system

code
verificationStatus.coding.code string

code

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

coding
severity.coding array of object

coding

system
severity.coding.system string

system

code
severity.coding.code string

code

display
severity.coding.display string

display

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

bodySite
bodySite array of object

bodySite

coding
bodySite.coding array of object

coding

system
bodySite.coding.system string

system

code
bodySite.coding.code string

code

display
bodySite.coding.display string

display

text
bodySite.text string

text

reference
subject.reference string

reference

onsetDateTime
onsetDateTime string

onsetDateTime

Get DiagnosticReport

The findings and interpretation of diagnostic tests performed on patients

Parameters

Name Key Required Type Description
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

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

category
entry.resource.category array of object

category

coding
entry.resource.category.coding array of object

coding

system
entry.resource.category.coding.system string

system

code
entry.resource.category.coding.code string

code

display
entry.resource.category.coding.display string

display

coding
entry.resource.code.coding array of object

coding

system
entry.resource.code.coding.system string

system

code
entry.resource.code.coding.code string

code

display
entry.resource.code.coding.display string

display

text
entry.resource.code.text string

text

reference
entry.resource.subject.reference string

reference

reference
entry.resource.encounter.reference string

reference

effectiveDateTime
entry.resource.effectiveDateTime string

effectiveDateTime

issued
entry.resource.issued string

issued

result
entry.resource.result array of object

result

reference
entry.resource.result.reference string

reference

display
entry.resource.result.display string

display

mode
entry.search.mode string

mode

Get DiagnosticReport ID

The findings and interpretation of diagnostic tests performed on patients

Parameters

Name Key Required Type Description
id
id True string

logical id of the resource

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

versionId
meta.versionId string

versionId

lastUpdated
meta.lastUpdated string

lastUpdated

status
text.status string

status

identifier
identifier array of object

identifier

use
identifier.use string

use

system
identifier.system string

system

value
identifier.value string

value

basedOn
basedOn array of object

basedOn

reference
basedOn.reference string

reference

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

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

reference
subject.reference string

reference

display
subject.display string

display

issued
issued string

issued

performer
performer array of object

performer

reference
performer.reference string

reference

display
performer.display string

display

result
result array of object

result

reference
result.reference string

reference

conclusion
conclusion string

conclusion

Get Medication

This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering

Parameters

Name Key Required Type Description
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

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

status
entry.resource.text.status string

status

div
entry.resource.text.div string

div

text
entry.resource.code.text string

text

coding
entry.resource.form.coding array of object

coding

system
entry.resource.form.coding.system string

system

code
entry.resource.form.coding.code string

code

display
entry.resource.form.coding.display string

display

text
entry.resource.form.text string

text

ingredient
entry.resource.ingredient array of object

ingredient

coding
entry.resource.ingredient.itemCodeableConcept.coding array of object

coding

system
entry.resource.ingredient.itemCodeableConcept.coding.system string

system

code
entry.resource.ingredient.itemCodeableConcept.coding.code string

code

display
entry.resource.ingredient.itemCodeableConcept.coding.display string

display

value
entry.resource.ingredient.strength.numerator.value integer

value

system
entry.resource.ingredient.strength.numerator.system string

system

code
entry.resource.ingredient.strength.numerator.code string

code

value
entry.resource.ingredient.strength.denominator.value integer

value

system
entry.resource.ingredient.strength.denominator.system string

system

code
entry.resource.ingredient.strength.denominator.code string

code

mode
entry.search.mode string

mode

Get Medication ID

This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering

Parameters

Name Key Required Type Description
id
id True string

logical id of the resource

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

versionId
meta.versionId string

versionId

lastUpdated
meta.lastUpdated string

lastUpdated

status
text.status string

status

contained
contained array of object

contained

resourceType
contained.resourceType string

resourceType

id
contained.id string

id

name
contained.name string

name

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

status
status string

status

reference
manufacturer.reference string

reference

coding
form.coding array of object

coding

system
form.coding.system string

system

code
form.coding.code string

code

display
form.coding.display string

display

ingredient
ingredient array of object

ingredient

coding
ingredient.itemCodeableConcept.coding array of object

coding

system
ingredient.itemCodeableConcept.coding.system string

system

code
ingredient.itemCodeableConcept.coding.code string

code

display
ingredient.itemCodeableConcept.coding.display string

display

isActive
ingredient.isActive boolean

isActive

value
ingredient.strength.numerator.value integer

value

system
ingredient.strength.numerator.system string

system

code
ingredient.strength.numerator.code string

code

value
ingredient.strength.denominator.value integer

value

system
ingredient.strength.denominator.system string

system

code
ingredient.strength.denominator.code string

code

lotNumber
batch.lotNumber string

lotNumber

expirationDate
batch.expirationDate string

expirationDate

Get MedicationRequest

An order or request for both supply of the medication and the instructions for administration of the medication to a patient.

Parameters

Name Key Required Type Description
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

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

intent
entry.resource.intent string

intent

coding
entry.resource.medicationCodeableConcept.coding array of object

coding

system
entry.resource.medicationCodeableConcept.coding.system string

system

code
entry.resource.medicationCodeableConcept.coding.code string

code

display
entry.resource.medicationCodeableConcept.coding.display string

display

text
entry.resource.medicationCodeableConcept.text string

text

reference
entry.resource.subject.reference string

reference

reference
entry.resource.encounter.reference string

reference

authoredOn
entry.resource.authoredOn string

authoredOn

reference
entry.resource.requester.reference string

reference

display
entry.resource.requester.display string

display

dosageInstruction
entry.resource.dosageInstruction array of object

dosageInstruction

sequence
entry.resource.dosageInstruction.sequence integer

sequence

asNeededBoolean
entry.resource.dosageInstruction.asNeededBoolean boolean

asNeededBoolean

frequency
entry.resource.dosageInstruction.timing.repeat.frequency integer

frequency

period
entry.resource.dosageInstruction.timing.repeat.period integer

period

periodUnit
entry.resource.dosageInstruction.timing.repeat.periodUnit string

periodUnit

doseAndRate
entry.resource.dosageInstruction.doseAndRate array of object

doseAndRate

coding
entry.resource.dosageInstruction.doseAndRate.type.coding array of object

coding

system
entry.resource.dosageInstruction.doseAndRate.type.coding.system string

system

code
entry.resource.dosageInstruction.doseAndRate.type.coding.code string

code

display
entry.resource.dosageInstruction.doseAndRate.type.coding.display string

display

value
entry.resource.dosageInstruction.doseAndRate.doseQuantity.value integer

value

reasonReference
entry.resource.reasonReference array of object

reasonReference

reference
entry.resource.reasonReference.reference string

reference

mode
entry.search.mode string

mode

Get MedicationRequest ID

An order or request for both supply of the medication and the instructions for administration of the medication to a patient.

Parameters

Name Key Required Type Description
id
id True string

logical id of the resource

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.status string

status

intent
entry.resource.intent string

intent

coding
entry.resource.medicationCodeableConcept.coding array of object

coding

system
entry.resource.medicationCodeableConcept.coding.system string

system

code
entry.resource.medicationCodeableConcept.coding.code string

code

display
entry.resource.medicationCodeableConcept.coding.display string

display

text
entry.resource.medicationCodeableConcept.text string

text

reference
entry.resource.subject.reference string

reference

reference
entry.resource.encounter.reference string

reference

authoredOn
entry.resource.authoredOn string

authoredOn

reference
entry.resource.requester.reference string

reference

display
entry.resource.requester.display string

display

dosageInstruction
entry.resource.dosageInstruction array of object

dosageInstruction

sequence
entry.resource.dosageInstruction.sequence integer

sequence

asNeededBoolean
entry.resource.dosageInstruction.asNeededBoolean boolean

asNeededBoolean

frequency
entry.resource.dosageInstruction.timing.repeat.frequency integer

frequency

period
entry.resource.dosageInstruction.timing.repeat.period integer

period

periodUnit
entry.resource.dosageInstruction.timing.repeat.periodUnit string

periodUnit

doseAndRate
entry.resource.dosageInstruction.doseAndRate array of object

doseAndRate

coding
entry.resource.dosageInstruction.doseAndRate.type.coding array of object

coding

system
entry.resource.dosageInstruction.doseAndRate.type.coding.system string

system

code
entry.resource.dosageInstruction.doseAndRate.type.coding.code string

code

display
entry.resource.dosageInstruction.doseAndRate.type.coding.display string

display

value
entry.resource.dosageInstruction.doseAndRate.doseQuantity.value integer

value

reasonReference
entry.resource.reasonReference array of object

reasonReference

reference
entry.resource.reasonReference.reference string

reference

mode
entry.search.mode string

mode

Get MedicationStatement

A record of a medication that is being consumed by a patient

Parameters

Name Key Required Type Description
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

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

contained
entry.resource.contained array of object

contained

resourceType
entry.resource.contained.resourceType string

resourceType

id
entry.resource.contained.id string

id

coding
entry.resource.contained.code.coding array of object

coding

system
entry.resource.contained.code.coding.system string

system

code
entry.resource.contained.code.coding.code string

code

display
entry.resource.contained.code.coding.display string

display

coding
entry.resource.contained.form.coding array of object

coding

system
entry.resource.contained.form.coding.system string

system

code
entry.resource.contained.form.coding.code string

code

display
entry.resource.contained.form.coding.display string

display

ingredient
entry.resource.contained.ingredient array of object

ingredient

coding
entry.resource.contained.ingredient.itemCodeableConcept.coding array of object

coding

system
entry.resource.contained.ingredient.itemCodeableConcept.coding.system string

system

code
entry.resource.contained.ingredient.itemCodeableConcept.coding.code string

code

display
entry.resource.contained.ingredient.itemCodeableConcept.coding.display string

display

value
entry.resource.contained.ingredient.strength.numerator.value integer

value

system
entry.resource.contained.ingredient.strength.numerator.system string

system

code
entry.resource.contained.ingredient.strength.numerator.code string

code

value
entry.resource.contained.ingredient.strength.denominator.value integer

value

system
entry.resource.contained.ingredient.strength.denominator.system string

system

code
entry.resource.contained.ingredient.strength.denominator.code string

code

lotNumber
entry.resource.contained.batch.lotNumber string

lotNumber

expirationDate
entry.resource.contained.batch.expirationDate string

expirationDate

identifier
entry.resource.identifier array of object

identifier

use
entry.resource.identifier.use string

use

system
entry.resource.identifier.system string

system

value
entry.resource.identifier.value string

value

status
entry.resource.status string

status

coding
entry.resource.category.coding array of object

coding

system
entry.resource.category.coding.system string

system

code
entry.resource.category.coding.code string

code

display
entry.resource.category.coding.display string

display

reference
entry.resource.medicationReference.reference string

reference

reference
entry.resource.subject.reference string

reference

display
entry.resource.subject.display string

display

effectiveDateTime
entry.resource.effectiveDateTime string

effectiveDateTime

dateAsserted
entry.resource.dateAsserted string

dateAsserted

reference
entry.resource.informationSource.reference string

reference

display
entry.resource.informationSource.display string

display

derivedFrom
entry.resource.derivedFrom array of object

derivedFrom

reference
entry.resource.derivedFrom.reference string

reference

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

note
entry.resource.note array of object

note

text
entry.resource.note.text string

text

dosage
entry.resource.dosage array of object

dosage

sequence
entry.resource.dosage.sequence integer

sequence

text
entry.resource.dosage.text string

text

additionalInstruction
entry.resource.dosage.additionalInstruction array of object

additionalInstruction

text
entry.resource.dosage.additionalInstruction.text string

text

frequency
entry.resource.dosage.timing.repeat.frequency integer

frequency

period
entry.resource.dosage.timing.repeat.period integer

period

periodUnit
entry.resource.dosage.timing.repeat.periodUnit string

periodUnit

coding
entry.resource.dosage.asNeededCodeableConcept.coding array of object

coding

system
entry.resource.dosage.asNeededCodeableConcept.coding.system string

system

code
entry.resource.dosage.asNeededCodeableConcept.coding.code string

code

display
entry.resource.dosage.asNeededCodeableConcept.coding.display string

display

coding
entry.resource.dosage.route.coding array of object

coding

system
entry.resource.dosage.route.coding.system string

system

code
entry.resource.dosage.route.coding.code string

code

display
entry.resource.dosage.route.coding.display string

display

doseAndRate
entry.resource.dosage.doseAndRate array of object

doseAndRate

coding
entry.resource.dosage.doseAndRate.type.coding array of object

coding

system
entry.resource.dosage.doseAndRate.type.coding.system string

system

code
entry.resource.dosage.doseAndRate.type.coding.code string

code

display
entry.resource.dosage.doseAndRate.type.coding.display string

display

value
entry.resource.dosage.doseAndRate.doseRange.low.value integer

value

unit
entry.resource.dosage.doseAndRate.doseRange.low.unit string

unit

system
entry.resource.dosage.doseAndRate.doseRange.low.system string

system

code
entry.resource.dosage.doseAndRate.doseRange.low.code string

code

value
entry.resource.dosage.doseAndRate.doseRange.high.value integer

value

unit
entry.resource.dosage.doseAndRate.doseRange.high.unit string

unit

system
entry.resource.dosage.doseAndRate.doseRange.high.system string

system

code
entry.resource.dosage.doseAndRate.doseRange.high.code string

code

value
entry.resource.dosage.doseAndRate.doseQuantity.value integer

value

unit
entry.resource.dosage.doseAndRate.doseQuantity.unit string

unit

system
entry.resource.dosage.doseAndRate.doseQuantity.system string

system

code
entry.resource.dosage.doseAndRate.doseQuantity.code string

code

asNeededBoolean
entry.resource.dosage.asNeededBoolean boolean

asNeededBoolean

value
entry.resource.dosage.maxDosePerPeriod.numerator.value integer

value

value
entry.resource.dosage.maxDosePerPeriod.denominator.value integer

value

system
entry.resource.dosage.maxDosePerPeriod.denominator.system string

system

code
entry.resource.dosage.maxDosePerPeriod.denominator.code string

code

text
entry.resource.medicationCodeableConcept.text string

text

reasonReference
entry.resource.reasonReference array of object

reasonReference

reference
entry.resource.reasonReference.reference string

reference

mode
entry.search.mode string

mode

Get MedicationStatement ID

A record of a medication that is being consumed by a patient

Parameters

Name Key Required Type Description
id
id True string

logical id of the resource

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

contained
entry.resource.contained array of object

contained

resourceType
entry.resource.contained.resourceType string

resourceType

id
entry.resource.contained.id string

id

coding
entry.resource.contained.code.coding array of object

coding

system
entry.resource.contained.code.coding.system string

system

code
entry.resource.contained.code.coding.code string

code

display
entry.resource.contained.code.coding.display string

display

coding
entry.resource.contained.form.coding array of object

coding

system
entry.resource.contained.form.coding.system string

system

code
entry.resource.contained.form.coding.code string

code

display
entry.resource.contained.form.coding.display string

display

ingredient
entry.resource.contained.ingredient array of object

ingredient

coding
entry.resource.contained.ingredient.itemCodeableConcept.coding array of object

coding

system
entry.resource.contained.ingredient.itemCodeableConcept.coding.system string

system

code
entry.resource.contained.ingredient.itemCodeableConcept.coding.code string

code

display
entry.resource.contained.ingredient.itemCodeableConcept.coding.display string

display

value
entry.resource.contained.ingredient.strength.numerator.value integer

value

system
entry.resource.contained.ingredient.strength.numerator.system string

system

code
entry.resource.contained.ingredient.strength.numerator.code string

code

value
entry.resource.contained.ingredient.strength.denominator.value integer

value

system
entry.resource.contained.ingredient.strength.denominator.system string

system

code
entry.resource.contained.ingredient.strength.denominator.code string

code

lotNumber
entry.resource.contained.batch.lotNumber string

lotNumber

expirationDate
entry.resource.contained.batch.expirationDate string

expirationDate

identifier
entry.resource.identifier array of object

identifier

use
entry.resource.identifier.use string

use

system
entry.resource.identifier.system string

system

value
entry.resource.identifier.value string

value

status
entry.resource.status string

status

coding
entry.resource.category.coding array of object

coding

system
entry.resource.category.coding.system string

system

code
entry.resource.category.coding.code string

code

display
entry.resource.category.coding.display string

display

reference
entry.resource.medicationReference.reference string

reference

reference
entry.resource.subject.reference string

reference

display
entry.resource.subject.display string

display

effectiveDateTime
entry.resource.effectiveDateTime string

effectiveDateTime

dateAsserted
entry.resource.dateAsserted string

dateAsserted

reference
entry.resource.informationSource.reference string

reference

display
entry.resource.informationSource.display string

display

derivedFrom
entry.resource.derivedFrom array of object

derivedFrom

reference
entry.resource.derivedFrom.reference string

reference

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

note
entry.resource.note array of object

note

text
entry.resource.note.text string

text

dosage
entry.resource.dosage array of object

dosage

sequence
entry.resource.dosage.sequence integer

sequence

text
entry.resource.dosage.text string

text

additionalInstruction
entry.resource.dosage.additionalInstruction array of object

additionalInstruction

text
entry.resource.dosage.additionalInstruction.text string

text

frequency
entry.resource.dosage.timing.repeat.frequency integer

frequency

period
entry.resource.dosage.timing.repeat.period integer

period

periodUnit
entry.resource.dosage.timing.repeat.periodUnit string

periodUnit

coding
entry.resource.dosage.asNeededCodeableConcept.coding array of object

coding

system
entry.resource.dosage.asNeededCodeableConcept.coding.system string

system

code
entry.resource.dosage.asNeededCodeableConcept.coding.code string

code

display
entry.resource.dosage.asNeededCodeableConcept.coding.display string

display

coding
entry.resource.dosage.route.coding array of object

coding

system
entry.resource.dosage.route.coding.system string

system

code
entry.resource.dosage.route.coding.code string

code

display
entry.resource.dosage.route.coding.display string

display

doseAndRate
entry.resource.dosage.doseAndRate array of object

doseAndRate

coding
entry.resource.dosage.doseAndRate.type.coding array of object

coding

system
entry.resource.dosage.doseAndRate.type.coding.system string

system

code
entry.resource.dosage.doseAndRate.type.coding.code string

code

display
entry.resource.dosage.doseAndRate.type.coding.display string

display

value
entry.resource.dosage.doseAndRate.doseRange.low.value integer

value

unit
entry.resource.dosage.doseAndRate.doseRange.low.unit string

unit

system
entry.resource.dosage.doseAndRate.doseRange.low.system string

system

code
entry.resource.dosage.doseAndRate.doseRange.low.code string

code

value
entry.resource.dosage.doseAndRate.doseRange.high.value integer

value

unit
entry.resource.dosage.doseAndRate.doseRange.high.unit string

unit

system
entry.resource.dosage.doseAndRate.doseRange.high.system string

system

code
entry.resource.dosage.doseAndRate.doseRange.high.code string

code

value
entry.resource.dosage.doseAndRate.doseQuantity.value integer

value

unit
entry.resource.dosage.doseAndRate.doseQuantity.unit string

unit

system
entry.resource.dosage.doseAndRate.doseQuantity.system string

system

code
entry.resource.dosage.doseAndRate.doseQuantity.code string

code

asNeededBoolean
entry.resource.dosage.asNeededBoolean boolean

asNeededBoolean

value
entry.resource.dosage.maxDosePerPeriod.numerator.value integer

value

value
entry.resource.dosage.maxDosePerPeriod.denominator.value integer

value

system
entry.resource.dosage.maxDosePerPeriod.denominator.system string

system

code
entry.resource.dosage.maxDosePerPeriod.denominator.code string

code

text
entry.resource.medicationCodeableConcept.text string

text

reasonReference
entry.resource.reasonReference array of object

reasonReference

reference
entry.resource.reasonReference.reference string

reference

mode
entry.search.mode string

mode

Get Observation

Observations are used to support diagnosis, monitor progress, determine baselines and patterns and even capture demographic characteristics

Parameters

Name Key Required Type Description
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

search
patient

clinical-patient

search
encounter

interaction between a patient and healthcare provider

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

category
entry.resource.category array of object

category

coding
entry.resource.category.coding array of object

coding

system
entry.resource.category.coding.system string

system

code
entry.resource.category.coding.code string

code

display
entry.resource.category.coding.display string

display

coding
entry.resource.code.coding array of object

coding

system
entry.resource.code.coding.system string

system

code
entry.resource.code.coding.code string

code

display
entry.resource.code.coding.display string

display

text
entry.resource.code.text string

text

reference
entry.resource.subject.reference string

reference

reference
entry.resource.encounter.reference string

reference

effectiveDateTime
entry.resource.effectiveDateTime string

effectiveDateTime

issued
entry.resource.issued string

issued

value
entry.resource.valueQuantity.value float

value

unit
entry.resource.valueQuantity.unit string

unit

system
entry.resource.valueQuantity.system string

system

code
entry.resource.valueQuantity.code string

code

mode
entry.search.mode string

mode

Get Observation ID

Observations are used to support diagnosis, monitor progress, determine baselines and patterns and even capture demographic characteristics

Parameters

Name Key Required Type Description
id
id True string

logical id of the resource

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

versionId
meta.versionId string

versionId

lastUpdated
meta.lastUpdated string

lastUpdated

status
text.status string

status

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

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

issued
issued string

issued

performer
performer array of object

performer

reference
performer.reference string

reference

value
valueQuantity.value integer

value

unit
valueQuantity.unit string

unit

system
valueQuantity.system string

system

code
valueQuantity.code string

code

interpretation
interpretation array of object

interpretation

coding
interpretation.coding array of object

coding

system
interpretation.coding.system string

system

code
interpretation.coding.code string

code

coding
bodySite.coding array of object

coding

system
bodySite.coding.system string

system

code
bodySite.coding.code string

code

display
bodySite.coding.display string

display

coding
method.coding array of object

coding

system
method.coding.system string

system

code
method.coding.code string

code

display
method.coding.display string

display

referenceRange
referenceRange array of object

referenceRange

value
referenceRange.high.value float

value

unit
referenceRange.high.unit string

unit

Get Procedure

An action that is or was performed on or for a patient

Parameters

Name Key Required Type Description
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

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

coding
entry.resource.code.coding array of object

coding

system
entry.resource.code.coding.system string

system

code
entry.resource.code.coding.code string

code

display
entry.resource.code.coding.display string

display

text
entry.resource.code.text string

text

reference
entry.resource.subject.reference string

reference

reference
entry.resource.encounter.reference string

reference

start
entry.resource.performedPeriod.start string

start

end
entry.resource.performedPeriod.end string

end

reasonReference
entry.resource.reasonReference array of object

reasonReference

reference
entry.resource.reasonReference.reference string

reference

display
entry.resource.reasonReference.display string

display

mode
entry.search.mode string

mode

Get Procedure ID

An action that is or was performed on or for a patient

Parameters

Name Key Required Type Description
id
id True string

logical id of the resource

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

versionId
meta.versionId string

versionId

lastUpdated
meta.lastUpdated string

lastUpdated

status
status string

status

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

reference
encounter.reference string

reference

start
performedPeriod.start string

start

end
performedPeriod.end string

end

Get RiskAssessment

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

Parameters

Name Key Required Type Description
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

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

status
status string

status

coding
method.coding array of object

coding

code
method.coding.code string

code

reference
subject.reference string

reference

occurrenceDateTime
occurrenceDateTime string

occurrenceDateTime

basis
basis array of object

basis

reference
basis.reference string

reference

prediction
prediction array of object

prediction

text
prediction.outcome.text string

text

probabilityDecimal
prediction.probabilityDecimal float

probabilityDecimal

value
prediction.whenRange.high.value integer

value

unit
prediction.whenRange.high.unit string

unit

system
prediction.whenRange.high.system string

system

code
prediction.whenRange.high.code string

code

value
prediction.whenRange.low.value integer

value

unit
prediction.whenRange.low.unit string

unit

system
prediction.whenRange.low.system string

system

code
prediction.whenRange.low.code string

code

note
note array of object

note

text
note.text string

text

Get RiskAssessment ID

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

Parameters

Name Key Required Type Description
id
id True string

logical id of the resource

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

versionId
meta.versionId string

versionId

lastUpdated
meta.lastUpdated string

lastUpdated

status
text.status string

status

status
status string

status

coding
method.coding array of object

coding

code
method.coding.code string

code

reference
subject.reference string

reference

occurrenceDateTime
occurrenceDateTime string

occurrenceDateTime

basis
basis array of object

basis

reference
basis.reference string

reference

prediction
prediction array of object

prediction

text
prediction.outcome.text string

text

probabilityDecimal
prediction.probabilityDecimal float

probabilityDecimal

value
prediction.whenRange.high.value integer

value

unit
prediction.whenRange.high.unit string

unit

system
prediction.whenRange.high.system string

system

code
prediction.whenRange.high.code string

code

value
prediction.whenRange.low.value integer

value

unit
prediction.whenRange.low.unit string

unit

system
prediction.whenRange.low.system string

system

code
prediction.whenRange.low.code string

code

note
note array of object

note

text
note.text string

text

Post AdverseEvent

Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care

Parameters

Name Key Required Type Description
resourceType
resourceType string

resourceType

id
id string

id

system
system string

system

value
value string

value

actuality
actuality string

actuality

system
system string

system

code
code string

code

display
display string

display

system
system string

system

code
code string

code

display
display string

display

text
text string

text

reference
reference string

reference

date
date string

date

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

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

system
identifier.system string

system

value
identifier.value string

value

actuality
actuality string

actuality

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

coding
event.coding array of object

coding

system
event.coding.system string

system

code
event.coding.code string

code

display
event.coding.display string

display

text
event.text string

text

reference
subject.reference string

reference

date
date string

date

coding
seriousness.coding array of object

coding

system
seriousness.coding.system string

system

code
seriousness.coding.code string

code

display
seriousness.coding.display string

display

coding
severity.coding array of object

coding

system
severity.coding.system string

system

code
severity.coding.code string

code

display
severity.coding.display string

display

reference
recorder.reference string

reference

suspectEntity
suspectEntity array of object

suspectEntity

reference
suspectEntity.instance.reference string

reference

Post AllergyIntolerance

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

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

display
display string

display

system
system string

system

code
code string

code

display
display string

display

type
type string

type

category
category array of string

category

criticality
criticality string

criticality

system
system string

system

code
code string

code

display
display string

display

reference
reference string

reference

recordedDate
recordedDate string

recordedDate

reference
reference string

reference

system
system string

system

code
code string

code

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
text.status string

status

coding
clinicalStatus.coding array of object

coding

system
clinicalStatus.coding.system string

system

code
clinicalStatus.coding.code string

code

display
clinicalStatus.coding.display string

display

coding
verificationStatus.coding array of object

coding

system
verificationStatus.coding.system string

system

code
verificationStatus.coding.code string

code

display
verificationStatus.coding.display string

display

type
type string

type

category
category array of string

category

criticality
criticality string

criticality

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

reference
patient.reference string

reference

recordedDate
recordedDate string

recordedDate

reference
recorder.reference string

reference

reaction
reaction array of object

reaction

manifestation
reaction.manifestation array of object

manifestation

coding
reaction.manifestation.coding array of object

coding

system
reaction.manifestation.coding.system string

system

code
reaction.manifestation.coding.code string

code

display
reaction.manifestation.coding.display string

display

Post CarePlan

Describes the intention of how one or more practitioners intend to deliver care for a particular 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

status
status string

status

intent
intent string

intent

system
system string

system

code
code string

code

display
display string

display

text
text string

text

title
title string

title

description
description string

description

reference
reference string

reference

reference
reference string

reference

start
start string

start

end
end string

end

reference
reference string

reference

reference
reference string

reference

system
system string

system

code
code string

code

display
display string

display

text
text string

text

status
status string

status

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
text.status string

status

contained
contained array of object

contained

resourceType
contained.resourceType string

resourceType

id
contained.id string

id

coding
contained.clinicalStatus.coding array of object

coding

system
contained.clinicalStatus.coding.system string

system

code
contained.clinicalStatus.coding.code string

code

coding
contained.verificationStatus.coding array of object

coding

system
contained.verificationStatus.coding.system string

system

code
contained.verificationStatus.coding.code string

code

text
contained.code.text string

text

reference
contained.subject.reference string

reference

display
contained.subject.display string

display

participant
contained.participant array of object

participant

id
contained.participant.id string

id

role
contained.participant.role array of object

role

coding
contained.participant.role.coding array of object

coding

system
contained.participant.role.coding.system string

system

code
contained.participant.role.coding.code string

code

text
contained.participant.role.text string

text

reference
contained.participant.member.reference string

reference

display
contained.participant.member.display string

display

lifecycleStatus
contained.lifecycleStatus string

lifecycleStatus

text
contained.description.text string

text

status
status string

status

intent
intent string

intent

reference
subject.reference string

reference

display
subject.display string

display

start
period.start string

start

careTeam
careTeam array of object

careTeam

reference
careTeam.reference string

reference

addresses
addresses array of object

addresses

reference
addresses.reference string

reference

display
addresses.display string

display

goal
goal array of object

goal

reference
goal.reference string

reference

activity
activity array of object

activity

outcomeReference
activity.outcomeReference array of object

outcomeReference

reference
activity.outcomeReference.reference string

reference

kind
activity.detail.kind string

kind

coding
activity.detail.code.coding array of object

coding

system
activity.detail.code.coding.system string

system

code
activity.detail.code.coding.code string

code

text
activity.detail.code.text string

text

status
activity.detail.status string

status

doNotPerform
activity.detail.doNotPerform boolean

doNotPerform

start
activity.detail.scheduledPeriod.start string

start

end
activity.detail.scheduledPeriod.end string

end

performer
activity.detail.performer array of object

performer

reference
activity.detail.performer.reference string

reference

display
activity.detail.performer.display string

display

Post Condition

A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

Parameters

Name Key Required Type Description
resourceType
resourceType string

resourceType

id
id string

id

status
status string

status

system
system string

system

code
code string

code

system
system string

system

code
code string

code

system
system string

system

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

text
text string

text

system
system string

system

code
code string

code

display
display string

display

text
text string

text

reference
reference string

reference

onsetDateTime
onsetDateTime string

onsetDateTime

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

coding
clinicalStatus.coding array of object

coding

system
clinicalStatus.coding.system string

system

code
clinicalStatus.coding.code string

code

coding
verificationStatus.coding array of object

coding

system
verificationStatus.coding.system string

system

code
verificationStatus.coding.code string

code

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

coding
severity.coding array of object

coding

system
severity.coding.system string

system

code
severity.coding.code string

code

display
severity.coding.display string

display

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

bodySite
bodySite array of object

bodySite

coding
bodySite.coding array of object

coding

system
bodySite.coding.system string

system

code
bodySite.coding.code string

code

display
bodySite.coding.display string

display

text
bodySite.text string

text

reference
subject.reference string

reference

onsetDateTime
onsetDateTime string

onsetDateTime

Post DiagnosticReport

The findings and interpretation of diagnostic tests performed on patients

Parameters

Name Key Required Type Description
resourceType
resourceType string

resourceType

id
id string

id

status
status string

status

use
use string

use

system
system string

system

value
value string

value

reference
reference string

reference

status
status string

status

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

issued
issued string

issued

reference
reference string

reference

display
display string

display

reference
reference string

reference

conclusion
conclusion string

conclusion

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

identifier
identifier array of object

identifier

use
identifier.use string

use

system
identifier.system string

system

value
identifier.value string

value

basedOn
basedOn array of object

basedOn

reference
basedOn.reference string

reference

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

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

reference
subject.reference string

reference

display
subject.display string

display

issued
issued string

issued

performer
performer array of object

performer

reference
performer.reference string

reference

display
performer.display string

display

result
result array of object

result

reference
result.reference string

reference

conclusion
conclusion string

conclusion

Post Medication

This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering

Parameters

Name Key Required Type Description
resourceType
resourceType string

resourceType

id
id string

id

status
status string

status

resourceType
resourceType string

resourceType

id
id string

id

name
name string

name

system
system string

system

code
code string

code

display
display string

display

status
status string

status

reference
reference string

reference

system
system string

system

code
code string

code

display
display string

display

system
system string

system

code
code string

code

display
display string

display

isActive
isActive boolean

isActive

value
value integer

value

system
system string

system

code
code string

code

value
value integer

value

system
system string

system

code
code string

code

lotNumber
lotNumber string

lotNumber

expirationDate
expirationDate string

expirationDate

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

contained
contained array of object

contained

resourceType
contained.resourceType string

resourceType

id
contained.id string

id

name
contained.name string

name

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

status
status string

status

reference
manufacturer.reference string

reference

coding
form.coding array of object

coding

system
form.coding.system string

system

code
form.coding.code string

code

display
form.coding.display string

display

ingredient
ingredient array of object

ingredient

coding
ingredient.itemCodeableConcept.coding array of object

coding

system
ingredient.itemCodeableConcept.coding.system string

system

code
ingredient.itemCodeableConcept.coding.code string

code

display
ingredient.itemCodeableConcept.coding.display string

display

isActive
ingredient.isActive boolean

isActive

value
ingredient.strength.numerator.value integer

value

system
ingredient.strength.numerator.system string

system

code
ingredient.strength.numerator.code string

code

value
ingredient.strength.denominator.value integer

value

system
ingredient.strength.denominator.system string

system

code
ingredient.strength.denominator.code string

code

lotNumber
batch.lotNumber string

lotNumber

expirationDate
batch.expirationDate string

expirationDate

Post MedicationRequest

An order or request for both supply of the medication and the instructions for administration of the medication to a patient.

Parameters

Name Key Required Type Description
resourceType
resourceType string

resourceType

id
id string

id

status
status string

status

resourceType
resourceType string

resourceType

id
id string

id

system
system string

system

code
code string

code

display
display string

display

use
use string

use

system
system string

system

value
value string

value

status
status string

status

intent
intent string

intent

system
system string

system

code
code string

code

display
display string

display

reference
reference string

reference

display
display string

display

reference
reference string

reference

display
display string

display

reference
reference string

reference

authoredOn
authoredOn string

authoredOn

reference
reference string

reference

display
display string

display

system
system string

system

code
code string

code

display
display string

display

text
text string

text

sequence
sequence integer

sequence

text
text string

text

system
system string

system

code
code string

code

display
display string

display

frequency
frequency integer

frequency

period
period integer

period

periodUnit
periodUnit string

periodUnit

system
system string

system

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

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

start
start string

start

end
end string

end

numberOfRepeatsAllowed
numberOfRepeatsAllowed integer

numberOfRepeatsAllowed

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

allowedBoolean
allowedBoolean boolean

allowedBoolean

system
system string

system

code
code string

code

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
text.status string

status

contained
contained array of object

contained

resourceType
contained.resourceType string

resourceType

id
contained.id string

id

coding
contained.code.coding array of object

coding

system
contained.code.coding.system string

system

code
contained.code.coding.code string

code

display
contained.code.coding.display string

display

identifier
identifier array of object

identifier

use
identifier.use string

use

system
identifier.system string

system

value
identifier.value string

value

status
status string

status

intent
intent string

intent

coding
medicationCodeableConcept.coding array of object

coding

system
medicationCodeableConcept.coding.system string

system

code
medicationCodeableConcept.coding.code string

code

display
medicationCodeableConcept.coding.display string

display

reference
subject.reference string

reference

display
subject.display string

display

reference
encounter.reference string

reference

display
encounter.display string

display

supportingInformation
supportingInformation array of object

supportingInformation

reference
supportingInformation.reference string

reference

authoredOn
authoredOn string

authoredOn

reference
requester.reference string

reference

display
requester.display string

display

reasonCode
reasonCode array of object

reasonCode

coding
reasonCode.coding array of object

coding

system
reasonCode.coding.system string

system

code
reasonCode.coding.code string

code

display
reasonCode.coding.display string

display

note
note array of object

note

text
note.text string

text

dosageInstruction
dosageInstruction array of object

dosageInstruction

sequence
dosageInstruction.sequence integer

sequence

text
dosageInstruction.text string

text

additionalInstruction
dosageInstruction.additionalInstruction array of object

additionalInstruction

coding
dosageInstruction.additionalInstruction.coding array of object

coding

system
dosageInstruction.additionalInstruction.coding.system string

system

code
dosageInstruction.additionalInstruction.coding.code string

code

display
dosageInstruction.additionalInstruction.coding.display string

display

frequency
dosageInstruction.timing.repeat.frequency integer

frequency

period
dosageInstruction.timing.repeat.period integer

period

periodUnit
dosageInstruction.timing.repeat.periodUnit string

periodUnit

coding
dosageInstruction.route.coding array of object

coding

system
dosageInstruction.route.coding.system string

system

code
dosageInstruction.route.coding.code string

code

display
dosageInstruction.route.coding.display string

display

coding
dosageInstruction.method.coding array of object

coding

system
dosageInstruction.method.coding.system string

system

code
dosageInstruction.method.coding.code string

code

display
dosageInstruction.method.coding.display string

display

doseAndRate
dosageInstruction.doseAndRate array of object

doseAndRate

coding
dosageInstruction.doseAndRate.type.coding array of object

coding

system
dosageInstruction.doseAndRate.type.coding.system string

system

code
dosageInstruction.doseAndRate.type.coding.code string

code

display
dosageInstruction.doseAndRate.type.coding.display string

display

value
dosageInstruction.doseAndRate.doseQuantity.value integer

value

unit
dosageInstruction.doseAndRate.doseQuantity.unit string

unit

system
dosageInstruction.doseAndRate.doseQuantity.system string

system

code
dosageInstruction.doseAndRate.doseQuantity.code string

code

start
dispenseRequest.validityPeriod.start string

start

end
dispenseRequest.validityPeriod.end string

end

numberOfRepeatsAllowed
dispenseRequest.numberOfRepeatsAllowed integer

numberOfRepeatsAllowed

value
dispenseRequest.quantity.value integer

value

unit
dispenseRequest.quantity.unit string

unit

system
dispenseRequest.quantity.system string

system

code
dispenseRequest.quantity.code string

code

value
dispenseRequest.expectedSupplyDuration.value integer

value

unit
dispenseRequest.expectedSupplyDuration.unit string

unit

system
dispenseRequest.expectedSupplyDuration.system string

system

code
dispenseRequest.expectedSupplyDuration.code string

code

allowedBoolean
substitution.allowedBoolean boolean

allowedBoolean

coding
substitution.reason.coding array of object

coding

system
substitution.reason.coding.system string

system

code
substitution.reason.coding.code string

code

display
substitution.reason.coding.display string

display

Post MedicationStatement

A record of a medication that is being consumed by a patient

Parameters

Name Key Required Type Description
resourceType
resourceType string

resourceType

id
id string

id

status
status string

status

status
status string

status

text
text string

text

reference
reference string

reference

display
display string

display

effectiveDateTime
effectiveDateTime string

effectiveDateTime

dateAsserted
dateAsserted string

dateAsserted

reference
reference string

reference

display
display string

display

reference
reference string

reference

text
text string

text

sequence
sequence integer

sequence

text
text string

text

asNeededBoolean
asNeededBoolean boolean

asNeededBoolean

system
system string

system

code
code string

code

display
display string

display

system
system string

system

code
code string

code

display
display string

display

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

value
value integer

value

value
value integer

value

system
system string

system

code
code string

code

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

contained
entry.resource.contained array of object

contained

resourceType
entry.resource.contained.resourceType string

resourceType

id
entry.resource.contained.id string

id

coding
entry.resource.contained.code.coding array of object

coding

system
entry.resource.contained.code.coding.system string

system

code
entry.resource.contained.code.coding.code string

code

display
entry.resource.contained.code.coding.display string

display

coding
entry.resource.contained.form.coding array of object

coding

system
entry.resource.contained.form.coding.system string

system

code
entry.resource.contained.form.coding.code string

code

display
entry.resource.contained.form.coding.display string

display

ingredient
entry.resource.contained.ingredient array of object

ingredient

coding
entry.resource.contained.ingredient.itemCodeableConcept.coding array of object

coding

system
entry.resource.contained.ingredient.itemCodeableConcept.coding.system string

system

code
entry.resource.contained.ingredient.itemCodeableConcept.coding.code string

code

display
entry.resource.contained.ingredient.itemCodeableConcept.coding.display string

display

value
entry.resource.contained.ingredient.strength.numerator.value integer

value

system
entry.resource.contained.ingredient.strength.numerator.system string

system

code
entry.resource.contained.ingredient.strength.numerator.code string

code

value
entry.resource.contained.ingredient.strength.denominator.value integer

value

system
entry.resource.contained.ingredient.strength.denominator.system string

system

code
entry.resource.contained.ingredient.strength.denominator.code string

code

lotNumber
entry.resource.contained.batch.lotNumber string

lotNumber

expirationDate
entry.resource.contained.batch.expirationDate string

expirationDate

identifier
entry.resource.identifier array of object

identifier

use
entry.resource.identifier.use string

use

system
entry.resource.identifier.system string

system

value
entry.resource.identifier.value string

value

status
entry.resource.status string

status

coding
entry.resource.category.coding array of object

coding

system
entry.resource.category.coding.system string

system

code
entry.resource.category.coding.code string

code

display
entry.resource.category.coding.display string

display

reference
entry.resource.medicationReference.reference string

reference

reference
entry.resource.subject.reference string

reference

display
entry.resource.subject.display string

display

effectiveDateTime
entry.resource.effectiveDateTime string

effectiveDateTime

dateAsserted
entry.resource.dateAsserted string

dateAsserted

reference
entry.resource.informationSource.reference string

reference

display
entry.resource.informationSource.display string

display

derivedFrom
entry.resource.derivedFrom array of object

derivedFrom

reference
entry.resource.derivedFrom.reference string

reference

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

note
entry.resource.note array of object

note

text
entry.resource.note.text string

text

dosage
entry.resource.dosage array of object

dosage

sequence
entry.resource.dosage.sequence integer

sequence

text
entry.resource.dosage.text string

text

additionalInstruction
entry.resource.dosage.additionalInstruction array of object

additionalInstruction

text
entry.resource.dosage.additionalInstruction.text string

text

frequency
entry.resource.dosage.timing.repeat.frequency integer

frequency

period
entry.resource.dosage.timing.repeat.period integer

period

periodUnit
entry.resource.dosage.timing.repeat.periodUnit string

periodUnit

coding
entry.resource.dosage.asNeededCodeableConcept.coding array of object

coding

system
entry.resource.dosage.asNeededCodeableConcept.coding.system string

system

code
entry.resource.dosage.asNeededCodeableConcept.coding.code string

code

display
entry.resource.dosage.asNeededCodeableConcept.coding.display string

display

coding
entry.resource.dosage.route.coding array of object

coding

system
entry.resource.dosage.route.coding.system string

system

code
entry.resource.dosage.route.coding.code string

code

display
entry.resource.dosage.route.coding.display string

display

doseAndRate
entry.resource.dosage.doseAndRate array of object

doseAndRate

coding
entry.resource.dosage.doseAndRate.type.coding array of object

coding

system
entry.resource.dosage.doseAndRate.type.coding.system string

system

code
entry.resource.dosage.doseAndRate.type.coding.code string

code

display
entry.resource.dosage.doseAndRate.type.coding.display string

display

value
entry.resource.dosage.doseAndRate.doseRange.low.value integer

value

unit
entry.resource.dosage.doseAndRate.doseRange.low.unit string

unit

system
entry.resource.dosage.doseAndRate.doseRange.low.system string

system

code
entry.resource.dosage.doseAndRate.doseRange.low.code string

code

value
entry.resource.dosage.doseAndRate.doseRange.high.value integer

value

unit
entry.resource.dosage.doseAndRate.doseRange.high.unit string

unit

system
entry.resource.dosage.doseAndRate.doseRange.high.system string

system

code
entry.resource.dosage.doseAndRate.doseRange.high.code string

code

value
entry.resource.dosage.doseAndRate.doseQuantity.value integer

value

unit
entry.resource.dosage.doseAndRate.doseQuantity.unit string

unit

system
entry.resource.dosage.doseAndRate.doseQuantity.system string

system

code
entry.resource.dosage.doseAndRate.doseQuantity.code string

code

asNeededBoolean
entry.resource.dosage.asNeededBoolean boolean

asNeededBoolean

value
entry.resource.dosage.maxDosePerPeriod.numerator.value integer

value

value
entry.resource.dosage.maxDosePerPeriod.denominator.value integer

value

system
entry.resource.dosage.maxDosePerPeriod.denominator.system string

system

code
entry.resource.dosage.maxDosePerPeriod.denominator.code string

code

coding
entry.resource.medicationCodeableConcept.coding array of object

coding

system
entry.resource.medicationCodeableConcept.coding.system string

system

code
entry.resource.medicationCodeableConcept.coding.code string

code

display
entry.resource.medicationCodeableConcept.coding.display string

display

text
entry.resource.medicationCodeableConcept.text string

text

reasonReference
entry.resource.reasonReference array of object

reasonReference

reference
entry.resource.reasonReference.reference string

reference

mode
entry.search.mode string

mode

Post Observation

Observations are used to support diagnosis, monitor progress, determine baselines and patterns and even capture demographic characteristics

Parameters

Name Key Required Type Description
resourceType
resourceType string

resourceType

id
id string

id

status
status string

status

status
status string

status

system
system string

system

code
code string

code

display
display string

display

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

issued
issued string

issued

reference
reference string

reference

value
value integer

value

unit
unit string

unit

system
system string

system

valueQuantity value
code string

code

system
system string

system

code
code string

code

system
system string

system

code
code string

code

display
display string

display

system
system string

system

code
code string

code

display
display string

display

value
value float

value

unit
unit string

unit

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

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

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

reference
encounter.reference string

reference

issued
issued string

issued

performer
performer array of object

performer

reference
performer.reference string

reference

value
valueQuantity.value integer

value

unit
valueQuantity.unit string

unit

system
valueQuantity.system string

system

code
valueQuantity.code string

code

interpretation
interpretation array of object

interpretation

coding
interpretation.coding array of object

coding

system
interpretation.coding.system string

system

code
interpretation.coding.code string

code

coding
bodySite.coding array of object

coding

system
bodySite.coding.system string

system

code
bodySite.coding.code string

code

display
bodySite.coding.display string

display

coding
method.coding array of object

coding

system
method.coding.system string

system

code
method.coding.code string

code

display
method.coding.display string

display

referenceRange
referenceRange array of object

referenceRange

value
referenceRange.high.value float

value

unit
referenceRange.high.unit string

unit

Post Procedure

An action that is or was performed on or for a patient

Parameters

Name Key Required Type Description
resourceType
resourceType string

resourceType

id
id string

id

status
status string

status

status
status string

status

system
system string

system

code
code string

code

display
display string

display

text
text string

text

reference
reference string

reference

performedDateTime
performedDateTime string

performedDateTime

reference
reference string

reference

display
display string

display

reference
reference string

reference

display
display string

display

reference
reference string

reference

display
display string

display

text
text string

text

text
text string

text

text
text string

text

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

status
status string

status

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

performedDateTime
performedDateTime string

performedDateTime

reference
recorder.reference string

reference

display
recorder.display string

display

reference
asserter.reference string

reference

display
asserter.display string

display

performer
performer array of object

performer

reference
performer.actor.reference string

reference

display
performer.actor.display string

display

reasonCode
reasonCode array of object

reasonCode

text
reasonCode.text string

text

followUp
followUp array of object

followUp

text
followUp.text string

text

note
note array of object

note

text
note.text string

text

Post RiskAssessment

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

Parameters

Name Key Required Type Description
resourceType
resourceType string

resourceType

id
id string

id

status
status string

status

status
status string

status

code
code string

code

reference
reference string

reference

occurrenceDateTime
occurrenceDateTime string

occurrenceDateTime

reference
reference string

reference

text
text string

text

probabilityDecimal
probabilityDecimal float

probabilityDecimal

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

text
text string

text

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

status
status string

status

coding
method.coding array of object

coding

code
method.coding.code string

code

reference
subject.reference string

reference

occurrenceDateTime
occurrenceDateTime string

occurrenceDateTime

basis
basis array of object

basis

reference
basis.reference string

reference

prediction
prediction array of object

prediction

text
prediction.outcome.text string

text

probabilityDecimal
prediction.probabilityDecimal float

probabilityDecimal

value
prediction.whenRange.high.value integer

value

unit
prediction.whenRange.high.unit string

unit

system
prediction.whenRange.high.system string

system

code
prediction.whenRange.high.code string

code

value
prediction.whenRange.low.value integer

value

unit
prediction.whenRange.low.unit string

unit

system
prediction.whenRange.low.system string

system

code
prediction.whenRange.low.code string

code

note
note array of object

note

text
note.text string

text

Put AdverseEvent ID

Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care

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

actuality
actuality string

actuality

system
system string

system

code
code string

code

display
display string

display

system
system string

system

code
code string

code

display
display string

display

text
text string

text

reference
reference string

reference

date
date string

date

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

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

system
identifier.system string

system

value
identifier.value string

value

actuality
actuality string

actuality

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

coding
event.coding array of object

coding

system
event.coding.system string

system

code
event.coding.code string

code

display
event.coding.display string

display

text
event.text string

text

reference
subject.reference string

reference

date
date string

date

coding
seriousness.coding array of object

coding

system
seriousness.coding.system string

system

code
seriousness.coding.code string

code

display
seriousness.coding.display string

display

coding
severity.coding array of object

coding

system
severity.coding.system string

system

code
severity.coding.code string

code

display
severity.coding.display string

display

reference
recorder.reference string

reference

suspectEntity
suspectEntity array of object

suspectEntity

reference
suspectEntity.instance.reference string

reference

Put AllergyIntolerance

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

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

code
code string

code

system
system string

system

code
code string

code

type
type string

type

category
category array of string

category

criticality
criticality string

criticality

system
system string

system

code
code string

code

display
display string

display

text
text string

text

reference
reference string

reference

recordedDate
recordedDate string

recordedDate

Returns

Name Path Type Description
resourceType
resourceType string

resourceType

id
id string

id

versionId
meta.versionId string

versionId

lastUpdated
meta.lastUpdated string

lastUpdated

coding
clinicalStatus.coding array of object

coding

system
clinicalStatus.coding.system string

system

code
clinicalStatus.coding.code string

code

coding
verificationStatus.coding array of object

coding

system
verificationStatus.coding.system string

system

code
verificationStatus.coding.code string

code

type
type string

type

category
category array of string

category

criticality
criticality string

criticality

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
patient.reference string

reference

recordedDate
recordedDate string

recordedDate

Put CarePlan ID

Describes the intention of how one or more practitioners intend to deliver care for a particular 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

resourceType
resourceType string

resourceType

id
id string

id

system
system string

system

code
code string

code

system
system string

system

code
code string

code

text
text string

text

reference
reference string

reference

display
display string

display

id
id string

id

system
system string

system

code
code string

code

text
text string

text

reference
reference string

reference

display
display string

display

lifecycleStatus
lifecycleStatus string

lifecycleStatus

text
text string

text

status
status string

status

intent
intent string

intent

reference
reference string

reference

display
display string

display

start
start string

start

reference
reference string

reference

reference
reference string

reference

display
display string

display

reference
reference string

reference

reference
reference string

reference

kind
kind string

kind

system
system string

system

code
code string

code

text
text string

text

status
status string

status

doNotPerform
doNotPerform boolean

doNotPerform

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
text.status string

status

contained
contained array of object

contained

resourceType
contained.resourceType string

resourceType

id
contained.id string

id

coding
contained.clinicalStatus.coding array of object

coding

system
contained.clinicalStatus.coding.system string

system

code
contained.clinicalStatus.coding.code string

code

coding
contained.verificationStatus.coding array of object

coding

system
contained.verificationStatus.coding.system string

system

code
contained.verificationStatus.coding.code string

code

text
contained.code.text string

text

reference
contained.subject.reference string

reference

display
contained.subject.display string

display

participant
contained.participant array of object

participant

id
contained.participant.id string

id

role
contained.participant.role array of object

role

coding
contained.participant.role.coding array of object

coding

system
contained.participant.role.coding.system string

system

code
contained.participant.role.coding.code string

code

text
contained.participant.role.text string

text

reference
contained.participant.member.reference string

reference

display
contained.participant.member.display string

display

lifecycleStatus
contained.lifecycleStatus string

lifecycleStatus

text
contained.description.text string

text

status
status string

status

intent
intent string

intent

reference
subject.reference string

reference

display
subject.display string

display

start
period.start string

start

careTeam
careTeam array of object

careTeam

reference
careTeam.reference string

reference

addresses
addresses array of object

addresses

reference
addresses.reference string

reference

display
addresses.display string

display

goal
goal array of object

goal

reference
goal.reference string

reference

activity
activity array of object

activity

outcomeReference
activity.outcomeReference array of object

outcomeReference

reference
activity.outcomeReference.reference string

reference

kind
activity.detail.kind string

kind

coding
activity.detail.code.coding array of object

coding

system
activity.detail.code.coding.system string

system

code
activity.detail.code.coding.code string

code

text
activity.detail.code.text string

text

status
activity.detail.status string

status

doNotPerform
activity.detail.doNotPerform boolean

doNotPerform

start
activity.detail.scheduledPeriod.start string

start

end
activity.detail.scheduledPeriod.end string

end

performer
activity.detail.performer array of object

performer

reference
activity.detail.performer.reference string

reference

display
activity.detail.performer.display string

display

Put Condition ID

A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

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

system
system string

system

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

text
text string

text

system
system string

system

code
code string

code

display
display string

display

text
text string

text

reference
reference string

reference

onsetDateTime
onsetDateTime string

onsetDateTime

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

coding
clinicalStatus.coding array of object

coding

system
clinicalStatus.coding.system string

system

code
clinicalStatus.coding.code string

code

coding
verificationStatus.coding array of object

coding

system
verificationStatus.coding.system string

system

code
verificationStatus.coding.code string

code

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

coding
severity.coding array of object

coding

system
severity.coding.system string

system

code
severity.coding.code string

code

display
severity.coding.display string

display

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

bodySite
bodySite array of object

bodySite

coding
bodySite.coding array of object

coding

system
bodySite.coding.system string

system

code
bodySite.coding.code string

code

display
bodySite.coding.display string

display

text
bodySite.text string

text

reference
subject.reference string

reference

onsetDateTime
onsetDateTime string

onsetDateTime

Put DiagnosticReport ID

The findings and interpretation of diagnostic tests performed on patients

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

use
use string

use

system
system string

system

value
value string

value

reference
reference string

reference

status
status string

status

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

issued
issued string

issued

reference
reference string

reference

display
display string

display

reference
reference string

reference

conclusion
conclusion string

conclusion

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

identifier
identifier array of object

identifier

use
identifier.use string

use

system
identifier.system string

system

value
identifier.value string

value

basedOn
basedOn array of object

basedOn

reference
basedOn.reference string

reference

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

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

reference
subject.reference string

reference

display
subject.display string

display

issued
issued string

issued

performer
performer array of object

performer

reference
performer.reference string

reference

display
performer.display string

display

result
result array of object

result

reference
result.reference string

reference

conclusion
conclusion string

conclusion

Put Medication ID

This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering

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

resourceType
resourceType string

resourceType

id
id string

id

name
name string

name

system
system string

system

code
code string

code

display
display string

display

status
status string

status

reference
reference string

reference

system
system string

system

code
code string

code

display
display string

display

system
system string

system

code
code string

code

display
display string

display

isActive
isActive boolean

isActive

value
value integer

value

system
system string

system

code
code string

code

value
value integer

value

system
system string

system

code
code string

code

lotNumber
lotNumber string

lotNumber

expirationDate
expirationDate string

expirationDate

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

contained
contained array of object

contained

resourceType
contained.resourceType string

resourceType

id
contained.id string

id

name
contained.name string

name

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

status
status string

status

reference
manufacturer.reference string

reference

coding
form.coding array of object

coding

system
form.coding.system string

system

code
form.coding.code string

code

display
form.coding.display string

display

ingredient
ingredient array of object

ingredient

coding
ingredient.itemCodeableConcept.coding array of object

coding

system
ingredient.itemCodeableConcept.coding.system string

system

code
ingredient.itemCodeableConcept.coding.code string

code

display
ingredient.itemCodeableConcept.coding.display string

display

isActive
ingredient.isActive boolean

isActive

value
ingredient.strength.numerator.value integer

value

system
ingredient.strength.numerator.system string

system

code
ingredient.strength.numerator.code string

code

value
ingredient.strength.denominator.value integer

value

system
ingredient.strength.denominator.system string

system

code
ingredient.strength.denominator.code string

code

lotNumber
batch.lotNumber string

lotNumber

expirationDate
batch.expirationDate string

expirationDate

Put MedicationRequest ID

An order or request for both supply of the medication and the instructions for administration of the medication to 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

status
status string

status

resourceType
resourceType string

resourceType

id
id string

id

system
system string

system

code
code string

code

display
display string

display

use
use string

use

system
system string

system

value
value string

value

status
status string

status

intent
intent string

intent

reference
reference string

reference

reference
reference string

reference

display
display string

display

reference
reference string

reference

display
display string

display

reference
reference string

reference

authoredOn
authoredOn string

authoredOn

reference
reference string

reference

display
display string

display

system
system string

system

code
code string

code

display
display string

display

text
text string

text

sequence
sequence integer

sequence

text
text string

text

system
system string

system

code
code string

code

display
display string

display

frequency
frequency integer

frequency

period
period integer

period

periodUnit
periodUnit string

periodUnit

system
system string

system

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

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

start
start string

start

end
end string

end

numberOfRepeatsAllowed
numberOfRepeatsAllowed integer

numberOfRepeatsAllowed

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

allowedBoolean
allowedBoolean boolean

allowedBoolean

system
system string

system

code
code string

code

display
display string

display

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

intent
entry.resource.intent string

intent

coding
entry.resource.medicationCodeableConcept.coding array of object

coding

system
entry.resource.medicationCodeableConcept.coding.system string

system

code
entry.resource.medicationCodeableConcept.coding.code string

code

display
entry.resource.medicationCodeableConcept.coding.display string

display

text
entry.resource.medicationCodeableConcept.text string

text

reference
entry.resource.subject.reference string

reference

reference
entry.resource.encounter.reference string

reference

authoredOn
entry.resource.authoredOn string

authoredOn

reference
entry.resource.requester.reference string

reference

display
entry.resource.requester.display string

display

dosageInstruction
entry.resource.dosageInstruction array of object

dosageInstruction

sequence
entry.resource.dosageInstruction.sequence integer

sequence

asNeededBoolean
entry.resource.dosageInstruction.asNeededBoolean boolean

asNeededBoolean

frequency
entry.resource.dosageInstruction.timing.repeat.frequency integer

frequency

period
entry.resource.dosageInstruction.timing.repeat.period integer

period

periodUnit
entry.resource.dosageInstruction.timing.repeat.periodUnit string

periodUnit

doseAndRate
entry.resource.dosageInstruction.doseAndRate array of object

doseAndRate

coding
entry.resource.dosageInstruction.doseAndRate.type.coding array of object

coding

system
entry.resource.dosageInstruction.doseAndRate.type.coding.system string

system

code
entry.resource.dosageInstruction.doseAndRate.type.coding.code string

code

display
entry.resource.dosageInstruction.doseAndRate.type.coding.display string

display

value
entry.resource.dosageInstruction.doseAndRate.doseQuantity.value integer

value

reasonReference
entry.resource.reasonReference array of object

reasonReference

reference
entry.resource.reasonReference.reference string

reference

mode
entry.search.mode string

mode

Put MedicationStatement ID

A record of a medication that is being consumed by 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

status
status string

status

status
status string

status

text
text string

text

reference
reference string

reference

display
display string

display

effectiveDateTime
effectiveDateTime string

effectiveDateTime

dateAsserted
dateAsserted string

dateAsserted

reference
reference string

reference

display
display string

display

reference
reference string

reference

text
text string

text

sequence
sequence integer

sequence

text
text string

text

asNeededBoolean
asNeededBoolean boolean

asNeededBoolean

system
system string

system

code
code string

code

display
display string

display

system
system string

system

code
code string

code

display
display string

display

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

value
value integer

value

value
value integer

value

system
system string

system

code
code string

code

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

contained
entry.resource.contained array of object

contained

resourceType
entry.resource.contained.resourceType string

resourceType

id
entry.resource.contained.id string

id

coding
entry.resource.contained.code.coding array of object

coding

system
entry.resource.contained.code.coding.system string

system

code
entry.resource.contained.code.coding.code string

code

display
entry.resource.contained.code.coding.display string

display

coding
entry.resource.contained.form.coding array of object

coding

system
entry.resource.contained.form.coding.system string

system

code
entry.resource.contained.form.coding.code string

code

display
entry.resource.contained.form.coding.display string

display

ingredient
entry.resource.contained.ingredient array of object

ingredient

coding
entry.resource.contained.ingredient.itemCodeableConcept.coding array of object

coding

system
entry.resource.contained.ingredient.itemCodeableConcept.coding.system string

system

code
entry.resource.contained.ingredient.itemCodeableConcept.coding.code string

code

display
entry.resource.contained.ingredient.itemCodeableConcept.coding.display string

display

value
entry.resource.contained.ingredient.strength.numerator.value integer

value

system
entry.resource.contained.ingredient.strength.numerator.system string

system

code
entry.resource.contained.ingredient.strength.numerator.code string

code

value
entry.resource.contained.ingredient.strength.denominator.value integer

value

system
entry.resource.contained.ingredient.strength.denominator.system string

system

code
entry.resource.contained.ingredient.strength.denominator.code string

code

lotNumber
entry.resource.contained.batch.lotNumber string

lotNumber

expirationDate
entry.resource.contained.batch.expirationDate string

expirationDate

identifier
entry.resource.identifier array of object

identifier

use
entry.resource.identifier.use string

use

system
entry.resource.identifier.system string

system

value
entry.resource.identifier.value string

value

status
entry.resource.status string

status

coding
entry.resource.category.coding array of object

coding

system
entry.resource.category.coding.system string

system

code
entry.resource.category.coding.code string

code

display
entry.resource.category.coding.display string

display

reference
entry.resource.medicationReference.reference string

reference

reference
entry.resource.subject.reference string

reference

display
entry.resource.subject.display string

display

effectiveDateTime
entry.resource.effectiveDateTime string

effectiveDateTime

dateAsserted
entry.resource.dateAsserted string

dateAsserted

reference
entry.resource.informationSource.reference string

reference

display
entry.resource.informationSource.display string

display

derivedFrom
entry.resource.derivedFrom array of object

derivedFrom

reference
entry.resource.derivedFrom.reference string

reference

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

note
entry.resource.note array of object

note

text
entry.resource.note.text string

text

dosage
entry.resource.dosage array of object

dosage

sequence
entry.resource.dosage.sequence integer

sequence

text
entry.resource.dosage.text string

text

additionalInstruction
entry.resource.dosage.additionalInstruction array of object

additionalInstruction

text
entry.resource.dosage.additionalInstruction.text string

text

frequency
entry.resource.dosage.timing.repeat.frequency integer

frequency

period
entry.resource.dosage.timing.repeat.period integer

period

periodUnit
entry.resource.dosage.timing.repeat.periodUnit string

periodUnit

coding
entry.resource.dosage.asNeededCodeableConcept.coding array of object

coding

system
entry.resource.dosage.asNeededCodeableConcept.coding.system string

system

code
entry.resource.dosage.asNeededCodeableConcept.coding.code string

code

display
entry.resource.dosage.asNeededCodeableConcept.coding.display string

display

coding
entry.resource.dosage.route.coding array of object

coding

system
entry.resource.dosage.route.coding.system string

system

code
entry.resource.dosage.route.coding.code string

code

display
entry.resource.dosage.route.coding.display string

display

doseAndRate
entry.resource.dosage.doseAndRate array of object

doseAndRate

coding
entry.resource.dosage.doseAndRate.type.coding array of object

coding

system
entry.resource.dosage.doseAndRate.type.coding.system string

system

code
entry.resource.dosage.doseAndRate.type.coding.code string

code

display
entry.resource.dosage.doseAndRate.type.coding.display string

display

value
entry.resource.dosage.doseAndRate.doseRange.low.value integer

value

unit
entry.resource.dosage.doseAndRate.doseRange.low.unit string

unit

system
entry.resource.dosage.doseAndRate.doseRange.low.system string

system

code
entry.resource.dosage.doseAndRate.doseRange.low.code string

code

value
entry.resource.dosage.doseAndRate.doseRange.high.value integer

value

unit
entry.resource.dosage.doseAndRate.doseRange.high.unit string

unit

system
entry.resource.dosage.doseAndRate.doseRange.high.system string

system

code
entry.resource.dosage.doseAndRate.doseRange.high.code string

code

value
entry.resource.dosage.doseAndRate.doseQuantity.value integer

value

unit
entry.resource.dosage.doseAndRate.doseQuantity.unit string

unit

system
entry.resource.dosage.doseAndRate.doseQuantity.system string

system

code
entry.resource.dosage.doseAndRate.doseQuantity.code string

code

asNeededBoolean
entry.resource.dosage.asNeededBoolean boolean

asNeededBoolean

value
entry.resource.dosage.maxDosePerPeriod.numerator.value integer

value

value
entry.resource.dosage.maxDosePerPeriod.denominator.value integer

value

system
entry.resource.dosage.maxDosePerPeriod.denominator.system string

system

code
entry.resource.dosage.maxDosePerPeriod.denominator.code string

code

text
entry.resource.medicationCodeableConcept.text string

text

reasonReference
entry.resource.reasonReference array of object

reasonReference

reference
entry.resource.reasonReference.reference string

reference

mode
entry.search.mode string

mode

Put Observation ID

Observations are used to support diagnosis, monitor progress, determine baselines and patterns and even capture demographic characteristics

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

status
status string

status

system
system string

system

code
code string

code

display
display string

display

system
system string

system

code
code string

code

display
display string

display

text
text string

text

reference
reference string

reference

display
display string

display

issued
issued string

issued

reference
reference string

reference

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

system
system string

system

code
code string

code

system
system string

system

code
code string

code

display
display string

display

system
system string

system

code
code string

code

display
display string

display

value
value float

value

unit
unit string

unit

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

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

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

issued
issued string

issued

performer
performer array of object

performer

reference
performer.reference string

reference

value
valueQuantity.value integer

value

unit
valueQuantity.unit string

unit

system
valueQuantity.system string

system

code
valueQuantity.code string

code

interpretation
interpretation array of object

interpretation

coding
interpretation.coding array of object

coding

system
interpretation.coding.system string

system

code
interpretation.coding.code string

code

coding
bodySite.coding array of object

coding

system
bodySite.coding.system string

system

code
bodySite.coding.code string

code

display
bodySite.coding.display string

display

coding
method.coding array of object

coding

system
method.coding.system string

system

code
method.coding.code string

code

display
method.coding.display string

display

referenceRange
referenceRange array of object

referenceRange

value
referenceRange.high.value float

value

unit
referenceRange.high.unit string

unit

Put Procedure ID

An action that is or was performed on or for 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

status
status string

status

system
system string

system

code
code string

code

display
display string

display

text
text string

text

reference
reference string

reference

performedDateTime
performedDateTime string

performedDateTime

reference
reference string

reference

display
display string

display

reference
reference string

reference

display
display string

display

reference
reference string

reference

display
display string

display

text
text string

text

text
text string

text

text
text string

text

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

status
status string

status

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

performedDateTime
performedDateTime string

performedDateTime

reference
recorder.reference string

reference

display
recorder.display string

display

reference
asserter.reference string

reference

display
asserter.display string

display

performer
performer array of object

performer

reference
performer.actor.reference string

reference

display
performer.actor.display string

display

reasonCode
reasonCode array of object

reasonCode

text
reasonCode.text string

text

followUp
followUp array of object

followUp

text
followUp.text string

text

note
note array of object

note

text
note.text string

text

Put RiskAssessment ID

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

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

status
status string

status

code
code string

code

reference
reference string

reference

occurrenceDateTime
occurrenceDateTime string

occurrenceDateTime

reference
reference string

reference

text
text string

text

probabilityDecimal
probabilityDecimal float

probabilityDecimal

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

value
value integer

value

unit
unit string

unit

system
system string

system

code
code string

code

text
text string

text

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

status
status string

status

coding
method.coding array of object

coding

code
method.coding.code string

code

reference
subject.reference string

reference

occurrenceDateTime
occurrenceDateTime string

occurrenceDateTime

basis
basis array of object

basis

reference
basis.reference string

reference

prediction
prediction array of object

prediction

text
prediction.outcome.text string

text

probabilityDecimal
prediction.probabilityDecimal float

probabilityDecimal

value
prediction.whenRange.high.value integer

value

unit
prediction.whenRange.high.unit string

unit

system
prediction.whenRange.high.system string

system

code
prediction.whenRange.high.code string

code

value
prediction.whenRange.low.value integer

value

unit
prediction.whenRange.low.unit string

unit

system
prediction.whenRange.low.system string

system

code
prediction.whenRange.low.code string

code

note
note array of object

note

text
note.text string

text