Exchange
This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0-draft-final:
Final
QA
Preview
for
R5
-
STU
see
ballot
notes
).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
|
FHIR
Infrastructure
Work
Group
|
Maturity Level : N/A | Standards Status : Informative |
This page lists all search parameters defined as part of this specification. Additional search parameters associated with extensions can be found in the extensions search registry . For further details regarding using search parameters, see searching on the RESTful API .
All resources have the canonical URL http://hl7.org/fhir/SearchParameter/[id] where [id] is taken from the table below. You can download XML and JSON source for this page.
| Parameter | Type | Id | Description | Paths (Expression) |
|---|---|---|---|---|
| Resource N | ||||
| _content TU |
|
Resource-content |
Search on the entire content of the resource |
|
| _filter TU |
|
Resource-filter |
Filter search parameter which supports a more sophisticated grammar for searching. See documentation for further details |
|
| _has TU |
|
Resource-has |
Provides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation |
|
|
_id
|
token | Resource-id |
Logical id of this artifact |
Resource.id |
|
| reference | Resource-in | Allows for the retrieval of resources that are active members of a CareTeam, Group, or List | Resource.id |
| _language TU | token | Resource-language | Language of the resource content | Resource.language |
| _lastUpdated | date | Resource-lastUpdated |
When the resource version last changed |
Resource.meta.lastUpdated |
| _list TU |
|
Resource-list |
|
|
|
_profile
|
|
Resource-profile |
Profiles this resource claims to conform to |
Resource.meta.profile |
| _query TU |
|
Resource-query |
A custom search profile that describes a specific defined query operation |
|
| _security TU | token | Resource-security |
Security Labels applied to this resource |
Resource.meta.security |
|
_source
|
uri | Resource-source |
Identifies where the resource comes from |
Resource.meta.source |
| _tag TU | token | Resource-tag |
Tags applied to this resource |
Resource.meta.tag |
| _text TU | string | Resource-text |
|
|
| _type TU |
|
Resource-type |
|
|
| DomainResource N | ||||
| _text TU |
|
DomainResource-text |
Search on the narrative of the resource |
|
|
|
||||
|
|
|
|
Multiple Resources:
|
|
|
|
|
|
Multiple Resources:
|
|
| context-type TU | token |
|
Multiple Resources:
|
ActivityDefinition.useContext.code | ActorDefinition.useContext.code | CapabilityStatement.useContext.code | ChargeItemDefinition.useContext.code | Citation.useContext.code | CodeSystem.useContext.code | CompartmentDefinition.useContext.code | ConceptMap.useContext.code | ConditionDefinition.useContext.code | EventDefinition.useContext.code | Evidence.useContext.code | EvidenceReport.useContext.code | EvidenceVariable.useContext.code | ExampleScenario.useContext.code | GraphDefinition.useContext.code | ImplementationGuide.useContext.code | Library.useContext.code | Measure.useContext.code | MessageDefinition.useContext.code | NamingSystem.useContext.code | OperationDefinition.useContext.code | PlanDefinition.useContext.code | Questionnaire.useContext.code | Requirements.useContext.code | SearchParameter.useContext.code | StructureDefinition.useContext.code | StructureMap.useContext.code | TerminologyCapabilities.useContext.code | TestScript.useContext.code | ValueSet.useContext.code |
| context-type-quantity TU | composite |
|
Multiple Resources:
|
ActivityDefinition.useContext | ActorDefinition.useContext | CapabilityStatement.useContext | ChargeItemDefinition.useContext | Citation.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | ConditionDefinition.useContext | EventDefinition.useContext | Evidence.useContext | EvidenceReport.useContext | EvidenceVariable.useContext | ExampleScenario.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | Library.useContext | Measure.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | PlanDefinition.useContext | Questionnaire.useContext | Requirements.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | TestScript.useContext | ValueSet.useContext |
| context-type-value TU | composite |
|
Multiple Resources:
|
ActivityDefinition.useContext | ActorDefinition.useContext | CapabilityStatement.useContext | ChargeItemDefinition.useContext | Citation.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | ConditionDefinition.useContext | EventDefinition.useContext | Evidence.useContext | EvidenceReport.useContext | EvidenceVariable.useContext | ExampleScenario.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | Library.useContext | Measure.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | PlanDefinition.useContext | Questionnaire.useContext | Requirements.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | TestScript.useContext | ValueSet.useContext |
| date TU | date |
|
Multiple Resources:
|
ActivityDefinition.date | ActorDefinition.date | CapabilityStatement.date | ChargeItemDefinition.date | Citation.date | CodeSystem.date | CompartmentDefinition.date | ConceptMap.date | ConditionDefinition.date | EventDefinition.date | Evidence.date | EvidenceVariable.date | ExampleScenario.date | GraphDefinition.date | ImplementationGuide.date | Library.date | Measure.date | MessageDefinition.date | NamingSystem.date | OperationDefinition.date | PlanDefinition.date | Questionnaire.date | Requirements.date | SearchParameter.date | StructureDefinition.date | StructureMap.date | SubscriptionTopic.date | TerminologyCapabilities.date | TestScript.date | ValueSet.date |
|
|
|
|
Multiple Resources:
| ActivityDefinition.description | ActorDefinition.description | CapabilityStatement.description | ChargeItemDefinition.description | Citation.description | CodeSystem.description | CompartmentDefinition.description | ConceptMap.description | ConditionDefinition.description | EventDefinition.description | Evidence.description | EvidenceVariable.description | GraphDefinition.description | ImplementationGuide.description | Library.description | Measure.description | MessageDefinition.description | NamingSystem.description | OperationDefinition.description | PlanDefinition.description | Questionnaire.description | Requirements.description | SearchParameter.description | StructureDefinition.description | StructureMap.description | TerminologyCapabilities.description | TestScript.description | ValueSet.description |
| identifier TU | token | CanonicalResource-identifier | Multiple Resources:
| ActivityDefinition.identifier | ActorDefinition.identifier | CapabilityStatement.identifier | ChargeItemDefinition.identifier | Citation.identifier | CodeSystem.identifier | ConceptMap.identifier | ConditionDefinition.identifier | EventDefinition.identifier | Evidence.identifier | EvidenceReport.identifier | EvidenceVariable.identifier | ExampleScenario.identifier | GraphDefinition.identifier | ImplementationGuide.identifier | Library.identifier | Measure.identifier | MedicationKnowledge.identifier | MessageDefinition.identifier | NamingSystem.identifier | ObservationDefinition.identifier | OperationDefinition.identifier | PlanDefinition.identifier | Questionnaire.identifier | Requirements.identifier | SearchParameter.identifier | SpecimenDefinition.identifier | StructureDefinition.identifier | StructureMap.identifier | SubscriptionTopic.identifier | TerminologyCapabilities.identifier | TestScript.identifier | ValueSet.identifier |
| jurisdiction TU | token | CanonicalResource-jurisdiction | Multiple Resources:
| ActivityDefinition.jurisdiction | ActorDefinition.jurisdiction | CapabilityStatement.jurisdiction | ChargeItemDefinition.jurisdiction | Citation.jurisdiction | CodeSystem.jurisdiction | ConceptMap.jurisdiction | ConditionDefinition.jurisdiction | EventDefinition.jurisdiction | ExampleScenario.jurisdiction | GraphDefinition.jurisdiction | ImplementationGuide.jurisdiction | Library.jurisdiction | Measure.jurisdiction | MessageDefinition.jurisdiction | NamingSystem.jurisdiction | OperationDefinition.jurisdiction | PlanDefinition.jurisdiction | Questionnaire.jurisdiction | Requirements.jurisdiction | SearchParameter.jurisdiction | StructureDefinition.jurisdiction | StructureMap.jurisdiction | TerminologyCapabilities.jurisdiction | TestScript.jurisdiction | ValueSet.jurisdiction |
| name TU | string | CanonicalResource-name | Multiple Resources:
| ActivityDefinition.name | CapabilityStatement.name | Citation.name | CodeSystem.name | CompartmentDefinition.name | ConceptMap.name | ConditionDefinition.name | EventDefinition.name | EvidenceVariable.name | ExampleScenario.name | GraphDefinition.name | ImplementationGuide.name | Library.name | Measure.name | MessageDefinition.name | NamingSystem.name | OperationDefinition.name | PlanDefinition.name | Questionnaire.name | Requirements.name | SearchParameter.name | StructureDefinition.name | StructureMap.name | TerminologyCapabilities.name | TestScript.name | ValueSet.name |
| publisher TU | string | CanonicalResource-publisher | Multiple Resources:
| ActivityDefinition.publisher | ActorDefinition.publisher | CapabilityStatement.publisher | ChargeItemDefinition.publisher | Citation.publisher | CodeSystem.publisher | CompartmentDefinition.publisher | ConceptMap.publisher | ConditionDefinition.publisher | EventDefinition.publisher | Evidence.publisher | EvidenceReport.publisher | EvidenceVariable.publisher | ExampleScenario.publisher | GraphDefinition.publisher | ImplementationGuide.publisher | Library.publisher | Measure.publisher | MessageDefinition.publisher | NamingSystem.publisher | OperationDefinition.publisher | PlanDefinition.publisher | Questionnaire.publisher | Requirements.publisher | SearchParameter.publisher | StructureDefinition.publisher | StructureMap.publisher | TerminologyCapabilities.publisher | TestScript.publisher | ValueSet.publisher |
| status TU | token | CanonicalResource-status | Multiple Resources:
|
|
|
|
string |
|
Multiple Resources:
| ActivityDefinition.title | ActorDefinition.title | CapabilityStatement.title | ChargeItemDefinition.title | Citation.title | CodeSystem.title | ConceptMap.title | ConditionDefinition.title | EventDefinition.title | Evidence.title | EvidenceVariable.title | ImplementationGuide.title | Library.title | Measure.title | MessageDefinition.title | ObservationDefinition.title | OperationDefinition.title | PlanDefinition.title | Questionnaire.title | Requirements.title | SpecimenDefinition.title | StructureDefinition.title | StructureMap.title | SubscriptionTopic.title | TerminologyCapabilities.title | TestScript.title | ValueSet.title |
| url TU | uri | CanonicalResource-url | Multiple Resources:
| ActivityDefinition.url | ActorDefinition.url | CapabilityStatement.url | ChargeItemDefinition.url | Citation.url | CodeSystem.url | CompartmentDefinition.url | ConceptMap.url | ConditionDefinition.url | EventDefinition.url | Evidence.url | EvidenceReport.url | EvidenceVariable.url | ExampleScenario.url | GraphDefinition.url | ImplementationGuide.url | Library.url | Measure.url | MessageDefinition.url | NamingSystem.url | ObservationDefinition.url | OperationDefinition.url | PlanDefinition.url | Questionnaire.url | Requirements.url | SearchParameter.url | SpecimenDefinition.url | StructureDefinition.url | StructureMap.url | SubscriptionTopic.url | TerminologyCapabilities.url | TestScript.url | ValueSet.url |
| version TU | token | CanonicalResource-version | Multiple Resources:
|
|
| MetadataResource | ||||
|
| reference | MetadataResource-composed-of | Multiple Resources:
| ActivityDefinition.relatedArtifact.where(type='composed-of').resource | EventDefinition.relatedArtifact.where(type='composed-of').resource | EvidenceVariable.relatedArtifact.where(type='composed-of').resource | Library.relatedArtifact.where(type='composed-of').resource | Measure.relatedArtifact.where(type='composed-of').resource | PlanDefinition.relatedArtifact.where(type='composed-of').resource |
| depends-on TU | reference | MetadataResource-depends-on | Multiple Resources:
| ActivityDefinition.relatedArtifact.where(type='depends-on').resource | ActivityDefinition.library | EventDefinition.relatedArtifact.where(type='depends-on').resource | EvidenceVariable.relatedArtifact.where(type='depends-on').resource | Library.relatedArtifact.where(type='depends-on').resource | Measure.relatedArtifact.where(type='depends-on').resource | Measure.library | PlanDefinition.relatedArtifact.where(type='depends-on').resource | PlanDefinition.library |
| derived-from TU | reference | MetadataResource-derived-from | Multiple Resources:
| ActivityDefinition.relatedArtifact.where(type='derived-from').resource | CodeSystem.relatedArtifact.where(type='derived-from').resource | ConceptMap.relatedArtifact.where(type='derived-from').resource | EventDefinition.relatedArtifact.where(type='derived-from').resource | EvidenceVariable.relatedArtifact.where(type='derived-from').resource | Library.relatedArtifact.where(type='derived-from').resource | Measure.relatedArtifact.where(type='derived-from').resource | NamingSystem.relatedArtifact.where(type='derived-from').resource | PlanDefinition.relatedArtifact.where(type='derived-from').resource | ValueSet.relatedArtifact.where(type='derived-from').resource |
| effective TU | date | MetadataResource-effective | Multiple Resources:
| ActivityDefinition.effectivePeriod | ChargeItemDefinition.applicability.effectivePeriod | Citation.effectivePeriod | CodeSystem.effectivePeriod | ConceptMap.effectivePeriod | EventDefinition.effectivePeriod | Library.effectivePeriod | Measure.effectivePeriod | NamingSystem.effectivePeriod | PlanDefinition.effectivePeriod | Questionnaire.effectivePeriod | ValueSet.effectivePeriod |
| predecessor TU | reference | MetadataResource-predecessor | Multiple Resources:
| ActivityDefinition.relatedArtifact.where(type='predecessor').resource | CodeSystem.relatedArtifact.where(type='predecessor').resource | ConceptMap.relatedArtifact.where(type='predecessor').resource | EventDefinition.relatedArtifact.where(type='predecessor').resource | EvidenceVariable.relatedArtifact.where(type='predecessor').resource | Library.relatedArtifact.where(type='predecessor').resource | Measure.relatedArtifact.where(type='predecessor').resource | NamingSystem.relatedArtifact.where(type='predecessor').resource | PlanDefinition.relatedArtifact.where(type='predecessor').resource | ValueSet.relatedArtifact.where(type='predecessor').resource |
| successor TU | reference | MetadataResource-successor | Multiple Resources:
| ActivityDefinition.relatedArtifact.where(type='successor').resource | EventDefinition.relatedArtifact.where(type='successor').resource | EvidenceVariable.relatedArtifact.where(type='successor').resource | Library.relatedArtifact.where(type='successor').resource | Measure.relatedArtifact.where(type='successor').resource | PlanDefinition.relatedArtifact.where(type='successor').resource |
| topic TU | token | MetadataResource-topic | Multiple Resources:
| ActivityDefinition.topic | CodeSystem.topic | ConceptMap.topic | EventDefinition.topic | Library.topic | Measure.topic | NamingSystem.topic | PlanDefinition.topic | ValueSet.topic |
| Common Search Parameters | ||||
| address N | string | individual-address | Multiple Resources:
| Patient.address | Person.address | Practitioner.address | RelatedPerson.address |
| address-city N | string | individual-address-city | Multiple Resources:
| Patient.address.city | Person.address.city | Practitioner.address.city | RelatedPerson.address.city |
| address-country N | string | individual-address-country | Multiple Resources:
| Patient.address.country | Person.address.country | Practitioner.address.country | RelatedPerson.address.country |
| address-postalcode N | string | individual-address-postalcode | Multiple Resources:
| Patient.address.postalCode | Person.address.postalCode | Practitioner.address.postalCode | RelatedPerson.address.postalCode |
| address-state N | string | individual-address-state | Multiple Resources:
| Patient.address.state | Person.address.state | Practitioner.address.state | RelatedPerson.address.state |
| address-use N | token | individual-address-use | Multiple Resources:
| Patient.address.use | Person.address.use | Practitioner.address.use | RelatedPerson.address.use |
| birthdate N | date | individual-birthdate | Multiple Resources:
| Patient.birthDate | Person.birthDate | RelatedPerson.birthDate |
| code TU | token | clinical-code | Multiple Resources:
| AdverseEvent.code | AllergyIntolerance.code | AllergyIntolerance.reaction.substance | AuditEvent.code | Basic.code | ChargeItem.code | Condition.code | DetectedIssue.code | DeviceRequest.code.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | ImagingSelection.status | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationStatement.medication.concept | NutritionIntake.code | Observation.code | Procedure.code | RequestOrchestration.code | Task.code |
| date TU | date | clinical-date | Multiple Resources:
| AdverseEvent.occurrence.ofType(dateTime) | AdverseEvent.occurrence.ofType(Period) | AdverseEvent.occurrence.ofType(Timing) | AllergyIntolerance.recordedDate | (start | requestedPeriod.start).first() | AuditEvent.recorded | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.date | DiagnosticReport.effective.ofType(dateTime) | DiagnosticReport.effective.ofType(Period) | DocumentReference.date | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence.ofType(dateTime)) | ImmunizationEvaluation.date | ImmunizationRecommendation.date | Invoice.date | List.date | MeasureReport.date | NutritionIntake.occurrence.ofType(dateTime) | NutritionIntake.occurrence.ofType(Period) | Observation.effective.ofType(dateTime) | Observation.effective.ofType(Period) | Observation.effective.ofType(Timing) | Observation.effective.ofType(instant) | Procedure.occurrence.ofType(dateTime) | Procedure.occurrence.ofType(Period) | Procedure.occurrence.ofType(Timing) | ResearchSubject.period | (RiskAssessment.occurrence.ofType(dateTime)) | SupplyRequest.authoredOn |
| email N | token | individual-email |
Multiple Resources:
|
Patient.telecom.where(system='email')
|
Person.telecom.where(system='email')
|
Practitioner.telecom.where(system='email')
|
|
| encounter TU | reference | clinical-encounter |
Multiple Resources:
|
AuditEvent.encounter
|
CarePlan.encounter
|
ChargeItem.encounter
|
Claim.item.encounter
|
ClinicalImpression.encounter
|
Communication.encounter
|
CommunicationRequest.encounter
|
Composition.encounter
|
Condition.encounter
|
DeviceRequest.encounter
|
DiagnosticReport.encounter
|
|
|
|
reference | medications-encounter | Multiple Resources:
| MedicationAdministration.encounter | MedicationRequest.encounter |
| family N | string | individual-family |
Multiple Resources:
|
Patient.name.family | Practitioner.name.family |
|
gender
|
token | individual-gender |
Multiple Resources:
|
Patient.gender | Person.gender | Practitioner.gender | RelatedPerson.gender |
|
given
|
string | individual-given |
Multiple Resources:
|
Patient.name.given | Practitioner.name.given |
| identifier TU | token | clinical-identifier |
Multiple Resources:
|
Account.identifier
|
AdverseEvent.identifier
|
AllergyIntolerance.identifier
|
Appointment.identifier
|
AppointmentResponse.identifier
|
Basic.identifier
|
BodyStructure.identifier
|
CarePlan.identifier
|
CareTeam.identifier
|
ChargeItem.identifier
|
Claim.identifier
|
ClaimResponse.identifier
|
ClinicalImpression.identifier
|
Communication.identifier
|
CommunicationRequest.identifier
|
Composition.identifier
|
Condition.identifier
|
Consent.identifier
|
|
| medication TU | reference | medications-medication |
Multiple Resources:
|
|
|
|
|
|
Multiple Resources:
|
Account.subject.where(resolve()
is
Patient)
|
AdverseEvent.subject.where(resolve()
is
Patient)
|
AllergyIntolerance.patient
|
Appointment.participant.actor.where(resolve()
is
Patient)
|
Appointment.subject.where(resolve()
is
Patient)
|
AppointmentResponse.actor.where(resolve()
is
Patient)
|
AuditEvent.patient
|
Basic.subject.where(resolve()
is
Patient)
|
BodyStructure.patient
|
CarePlan.subject.where(resolve()
is
Patient)
|
CareTeam.subject.where(resolve()
is
Patient)
|
ChargeItem.subject.where(resolve()
is
Patient)
|
Claim.patient
|
ClaimResponse.patient
|
ClinicalImpression.subject.where(resolve()
is
Patient)
|
Communication.subject.where(resolve()
is
Patient)
|
CommunicationRequest.subject.where(resolve()
is
Patient)
|
Composition.subject.where(resolve()
is
Patient)
|
Condition.subject.where(resolve()
is
Patient)
|
|
|
phone
|
token | individual-phone |
Multiple Resources:
|
Patient.telecom.where(system='phone')
|
Person.telecom.where(system='phone')
|
Practitioner.telecom.where(system='phone')
|
|
|
phonetic
|
string | individual-phonetic |
Multiple Resources:
|
Patient.name | Person.name | Practitioner.name | RelatedPerson.name |
|
|
token | medications-status |
Multiple Resources:
|
MedicationAdministration.status | MedicationDispense.status | MedicationRequest.status | MedicationStatement.status |
|
telecom
|
token | individual-telecom |
Multiple Resources:
|
Patient.telecom
|
Person.telecom
|
Practitioner.telecom
|
|
|
|
token | clinical-type |
Multiple Resources:
|
|
| Account TU | ||||
| guarantor | reference |
|
|
|
| identifier | token |
|
Account number |
Account.identifier |
| name | string | Account-name |
Human-readable label |
Account.name |
| owner | reference | Account-owner |
Entity managing the Account |
Account.owner |
| patient | reference |
|
The entity that caused the expenses |
Account.subject.where(resolve() is Patient) |
| period | date | Account-period |
Transaction window |
Account.servicePeriod |
| relatedaccount | reference | Account-relatedaccount | Parent and other related accounts | Account.relatedAccount.account |
| status | token | Account-status |
active | inactive | entered-in-error | on-hold | unknown |
Account.status |
| subject | reference | Account-subject |
The entity that caused the expenses |
Account.subject |
| type | token |
|
E.g. patient, expense, depreciation |
Account.type |
| ActivityDefinition TU | ||||
| composed-of | reference |
|
What resource is being referenced |
ActivityDefinition.relatedArtifact.where(type='composed-of').resource |
| context | token |
|
A use context assigned to the activity definition |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the activity definition |
|
| context-type | token |
|
A type of use context assigned to the activity definition |
ActivityDefinition.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the activity definition |
ActivityDefinition.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the activity definition |
ActivityDefinition.useContext |
|
date
|
date |
|
The activity definition publication date |
ActivityDefinition.date |
| depends-on | reference |
|
What resource is being referenced |
ActivityDefinition.relatedArtifact.where(type='depends-on').resource | ActivityDefinition.library |
| derived-from | reference |
|
What resource is being referenced |
ActivityDefinition.relatedArtifact.where(type='derived-from').resource |
|
description
|
string |
|
The description of the activity definition |
ActivityDefinition.description |
| effective | date |
|
The time during which the activity definition is intended to be in use |
ActivityDefinition.effectivePeriod |
| identifier | token |
|
External identifier for the activity definition |
ActivityDefinition.identifier |
| jurisdiction | token |
|
Intended jurisdiction for the activity definition |
ActivityDefinition.jurisdiction |
|
| token | ActivityDefinition-kind | The kind of activity definition | ActivityDefinition.kind |
| name | string |
|
Computationally friendly name of the activity definition |
ActivityDefinition.name |
| predecessor | reference |
|
What resource is being referenced |
ActivityDefinition.relatedArtifact.where(type='predecessor').resource |
|
publisher
|
string |
|
Name of the publisher of the activity definition |
ActivityDefinition.publisher |
|
status
|
token |
|
The current status of the activity definition |
ActivityDefinition.status |
| successor | reference |
|
What resource is being referenced |
ActivityDefinition.relatedArtifact.where(type='successor').resource |
|
title
|
string |
|
The human-friendly name of the activity definition |
ActivityDefinition.title |
| topic | token |
|
Topics associated with the module |
ActivityDefinition.topic |
|
url
|
uri |
|
The uri that identifies the activity definition |
ActivityDefinition.url |
|
version
|
token |
|
The business version of the activity definition |
ActivityDefinition.version |
| ActorDefinition TU | ||||
| context | token | CanonicalResource-context | A use context assigned to the Actor Definition | (ActorDefinition.useContext.value.ofType(CodeableConcept)) |
| context-quantity | quantity | CanonicalResource-context-quantity | A quantity- or range-valued use context assigned to the Actor Definition | (ActorDefinition.useContext.value.ofType(Quantity)) | (ActorDefinition.useContext.value.ofType(Range)) |
| context-type | token | CanonicalResource-context-type | A type of use context assigned to the Actor Definition | ActorDefinition.useContext.code |
| context-type-quantity | composite | CanonicalResource-context-type-quantity | A use context type and quantity- or range-based value assigned to the Actor Definition | ActorDefinition.useContext |
| context-type-value | composite | CanonicalResource-context-type-value | A use context type and value assigned to the Actor Definition | ActorDefinition.useContext |
| date | date | CanonicalResource-date | The Actor Definition publication date | ActorDefinition.date |
| description | string | CanonicalResource-description | The description of the Actor Definition | ActorDefinition.description |
| identifier | token | CanonicalResource-identifier | External identifier for the Actor Definition | ActorDefinition.identifier |
| jurisdiction | token | CanonicalResource-jurisdiction | Intended jurisdiction for the Actor Definition | ActorDefinition.jurisdiction |
| publisher | string | CanonicalResource-publisher | Name of the publisher of the Actor Definition | ActorDefinition.publisher |
| status | token | CanonicalResource-status | The current status of the Actor Definition | ActorDefinition.status |
| title | string | CanonicalResource-title | The human-friendly name of the Actor Definition | ActorDefinition.title |
| type | token | ActorDefinition-type | The type of actor | ActorDefinition.type |
| url | uri | CanonicalResource-url | The uri that identifies the Actor Definition | ActorDefinition.url |
| version | token | CanonicalResource-version | The business version of the Actor Definition | ActorDefinition.version |
| AdministrableProductDefinition TU | ||||
| device | reference | AdministrableProductDefinition-device |
A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product. This is not intended for devices that are just co-packaged |
AdministrableProductDefinition.device |
| dose-form | token | AdministrableProductDefinition-dose-form |
The administrable dose form, i.e. the dose form of the final product after necessary reconstitution or processing |
AdministrableProductDefinition.administrableDoseForm |
| form-of | reference | AdministrableProductDefinition-form-of |
The medicinal product that this is an administrable form of. This is not a reference to the item(s) that make up this administrable form - it is the whole product |
AdministrableProductDefinition.formOf |
| identifier | token | AdministrableProductDefinition-identifier |
An identifier for the administrable product |
AdministrableProductDefinition.identifier |
| ingredient | token | AdministrableProductDefinition-ingredient |
The ingredients of this administrable medicinal product |
AdministrableProductDefinition.ingredient |
| manufactured-item | reference | AdministrableProductDefinition-manufactured-item |
The manufactured item(s) that this administrable product is produced from. Either a single item, or several that are mixed before administration (e.g. a power item and a solution item). Note that these are not raw ingredients |
AdministrableProductDefinition.producedFrom |
| route | token | AdministrableProductDefinition-route |
Coded expression for the route |
AdministrableProductDefinition.routeOfAdministration.code |
| status | token | AdministrableProductDefinition-status | The status of this administrable product. Enables tracking the life-cycle of the content. | AdministrableProductDefinition.status |
| target-species | token | AdministrableProductDefinition-target-species |
Coded expression for the species |
AdministrableProductDefinition.routeOfAdministration.targetSpecies.code |
| AdverseEvent TU | ||||
| actuality | token | AdverseEvent-actuality |
actual | potential |
AdverseEvent.actuality |
| category | token | AdverseEvent-category |
|
AdverseEvent.category |
| code | token | clinical-code | Event or incident that occurred or was averted | AdverseEvent.code |
| date | date |
|
When the event occurred |
|
|
|
token |
|
|
|
| location | reference | AdverseEvent-location |
Location where adverse event occurred |
AdverseEvent.location |
| patient | reference | clinical-patient | Subject impacted by event | AdverseEvent.subject.where(resolve() is Patient) |
| recorder | reference | AdverseEvent-recorder |
Who recorded the adverse event |
AdverseEvent.recorder |
|
|
reference |
|
Effect on the subject due to this event |
|
| seriousness | token | AdverseEvent-seriousness |
Seriousness or gravity of the event |
AdverseEvent.seriousness |
|
|
token |
|
|
|
| study | reference | AdverseEvent-study |
|
AdverseEvent.study |
| subject | reference | AdverseEvent-subject |
Subject impacted by event |
AdverseEvent.subject |
| substance | reference | AdverseEvent-substance |
Refers to the specific entity that caused the adverse event |
|
| AllergyIntolerance TU | ||||
|
|
token | AllergyIntolerance-category |
food | medication | environment | biologic |
AllergyIntolerance.category |
| clinical-status | token | AllergyIntolerance-clinical-status |
active | inactive | resolved |
AllergyIntolerance.clinicalStatus |
| code | token | clinical-code |
Code that identifies the allergy or intolerance |
AllergyIntolerance.code | AllergyIntolerance.reaction.substance |
| criticality | token | AllergyIntolerance-criticality |
low | high | unable-to-assess |
AllergyIntolerance.criticality |
| date | date | clinical-date |
Date first version of the resource instance was recorded |
AllergyIntolerance.recordedDate |
| identifier | token | clinical-identifier |
External ids for this item |
AllergyIntolerance.identifier |
| last-date | date | AllergyIntolerance-last-date |
Date(/time) of last known occurrence of a reaction |
AllergyIntolerance.lastOccurrence |
|
|
token |
|
Clinical symptoms/signs associated with the Event |
|
|
|
|
|
|
|
|
|
reference |
|
Who
or
what
participated
in
the
|
|
|
|
reference |
|
Who
|
|
| route | token | AllergyIntolerance-route |
How the subject was exposed to the substance |
AllergyIntolerance.reaction.exposureRoute |
| severity | token | AllergyIntolerance-severity |
mild | moderate | severe (of event as a whole) |
AllergyIntolerance.reaction.severity |
| type | token | clinical-type |
allergy | intolerance - Underlying mechanism (if known) |
AllergyIntolerance.type |
| verification-status | token | AllergyIntolerance-verification-status |
unconfirmed | presumed | confirmed | refuted | entered-in-error |
AllergyIntolerance.verificationStatus |
| Appointment TU | ||||
| actor | reference | Appointment-actor |
Any one of the individuals participating in the appointment |
Appointment.participant.actor |
| appointment-type | token | Appointment-appointment-type |
The style of appointment or patient that has been booked in the slot (not service type) |
Appointment.appointmentType |
| based-on | reference | Appointment-based-on |
The service request this appointment is allocated to assess |
Appointment.basedOn |
| date | date |
|
Appointment date/time. |
|
| group | reference | Appointment-group | One of the individuals of the appointment is this patient | Appointment.participant.actor.where(resolve() is Group) | Appointment.subject.where(resolve() is Group) |
| identifier | token |
|
An Identifier of the Appointment |
Appointment.identifier |
| location | reference | Appointment-location |
This location is listed in the participants of the appointment |
Appointment.participant.actor.where(resolve() is Location) |
| part-status | token | Appointment-part-status |
The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests. |
Appointment.participant.status |
| patient | reference |
|
One of the individuals of the appointment is this patient |
Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) |
| practitioner | reference | Appointment-practitioner |
One of the individuals of the appointment is this practitioner |
Appointment.participant.actor.where(resolve() is Practitioner) |
| reason-code | token | Appointment-reason-code |
|
|
| reason-reference | reference | Appointment-reason-reference |
| Appointment.reason.reference |
| requested-period | date | Appointment-requested-period |
During
what
period
was
the
|
|
| service-category | token | Appointment-service-category |
A broad categorization of the service that is to be performed during this appointment |
Appointment.serviceCategory |
| service-type | token | Appointment-service-type |
The specific service (by coding) that is to be performed during this appointment |
|
| service-type-reference | reference | Appointment-service-type-reference | The specific service (by HealthcareService) that is to be performed during this appointment | Appointment.serviceType.reference |
| slot | reference | Appointment-slot |
The slots that this appointment is filling |
Appointment.slot |
| specialty | token | Appointment-specialty |
The specialty of a practitioner that would be required to perform the service requested in this appointment |
Appointment.specialty |
| status | token | Appointment-status |
The overall status of the appointment |
Appointment.status |
| subject | reference | Appointment-subject | One of the individuals of the appointment is this patient | Appointment.subject |
| supporting-info | reference | Appointment-supporting-info |
Additional information to support the appointment |
Appointment.supportingInformation |
| AppointmentResponse TU | ||||
| actor | reference | AppointmentResponse-actor |
The Person, Location/HealthcareService or Device that this appointment response replies for |
AppointmentResponse.actor |
| appointment | reference | AppointmentResponse-appointment |
The appointment that the response is attached to |
AppointmentResponse.appointment |
| group | reference | AppointmentResponse-group | This Response is for this Group | AppointmentResponse.actor.where(resolve() is Group) |
| identifier | token |
|
An Identifier in this appointment response |
AppointmentResponse.identifier |
| location | reference | AppointmentResponse-location |
This Response is for this Location |
AppointmentResponse.actor.where(resolve() is Location) |
| part-status | token | AppointmentResponse-part-status |
The participants acceptance status for this appointment |
AppointmentResponse.participantStatus |
| patient | reference |
|
This Response is for this Patient |
AppointmentResponse.actor.where(resolve() is Patient) |
| practitioner | reference | AppointmentResponse-practitioner |
This Response is for this Practitioner |
AppointmentResponse.actor.where(resolve() is Practitioner) |
| ArtifactAssessment TU | ||||
| date | date | ArtifactAssessment-date | The artifact assessment publication date | ArtifactAssessment.date |
| AuditEvent TU | ||||
| action | token | AuditEvent-action |
Type of action performed during the event |
AuditEvent.action |
|
|
|
|
Identifier
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
token |
|
|
|
|
|
token |
|
|
|
| date | date |
|
Time when the event was recorded |
AuditEvent.recorded |
|
|
reference |
|
|
|
|
|
|
|
|
|
| entity-role | token | AuditEvent-entity-role |
What role the entity played |
AuditEvent.entity.role |
|
|
token | AuditEvent-outcome |
Whether the event succeeded or failed |
|
| patient | reference |
|
|
|
| policy | uri | AuditEvent-policy |
Policy that authorized event |
AuditEvent.agent.policy |
|
|
token |
|
|
|
| source | reference | AuditEvent-source |
The identity of source detecting the event |
AuditEvent.source.observer |
| Basic TU | ||||
|
| reference | Basic-author | Who created | Basic.author |
| code | token |
|
|
|
|
| date | Basic-created | When created | Basic.created |
| identifier | token |
|
| Basic.identifier |
| patient | reference | clinical-patient |
Identifies
the
focus
of
|
|
| subject | reference | Basic-subject | Identifies the focus of this resource | Basic.subject |
|
|
||||
|
| token | BiologicallyDerivedProduct-biological-source-event | The biological source for the biologically derived product | BiologicallyDerivedProduct.biologicalSourceEvent |
| code | token | BiologicallyDerivedProduct-code | A code that identifies the kind of this biologically derived product (SNOMED CT code). | BiologicallyDerivedProduct.productCode |
| collector | reference |
|
|
|
|
|
token |
|
| BiologicallyDerivedProduct.identifier |
| product-category | token | BiologicallyDerivedProduct-product-category |
Broad
category
of
|
|
|
|
|
|
|
|
| request | reference | BiologicallyDerivedProduct-request | Procedure request to obtain this biologically derived product. | BiologicallyDerivedProduct.request |
| serial-number | token | BiologicallyDerivedProduct-serial-number | Identifier | BiologicallyDerivedProduct.identifier |
| BiologicallyDerivedProductDispense D | ||||
| identifier | token |
|
|
|
| patient | reference |
|
|
|
|
|
reference |
|
| BiologicallyDerivedProductDispense.performer.actor |
| product | reference | BiologicallyDerivedProductDispense-product |
Search
for
products
that
match
this
|
|
| status | token | BiologicallyDerivedProductDispense-status | The status of the dispense | BiologicallyDerivedProductDispense.status |
| BodyStructure TU | ||||
| excluded_structure | token | BodyStructure-excludedstructure | Body site excludedStructure structure | BodyStructure.excludedStructure.structure |
| identifier | token |
|
Bodystructure identifier |
BodyStructure.identifier |
|
|
token |
|
Body site includedStructure structure |
|
| morphology | token | BodyStructure-morphology |
Kind of Structure |
BodyStructure.morphology |
| patient | reference |
|
Who this is about |
BodyStructure.patient |
| Bundle N | ||||
|
composition
|
reference | Bundle-composition |
The first resource in the bundle, if the bundle type is "document" - this is a composition, and this parameter provides access to search its contents |
Bundle.entry[0].resource as Composition |
|
identifier
|
token | Bundle-identifier |
Persistent identifier for the bundle |
Bundle.identifier |
|
message
|
reference | Bundle-message |
The first resource in the bundle, if the bundle type is "message" - this is a message header, and this parameter provides access to search its contents |
Bundle.entry[0].resource as MessageHeader |
|
timestamp
|
date | Bundle-timestamp |
When the bundle was assembled |
Bundle.timestamp |
|
type
|
token | Bundle-type |
document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification |
Bundle.type |
| CapabilityStatement N | ||||
| context TU | token |
|
A use context assigned to the capability statement |
|
| context-quantity TU | quantity |
|
A quantity- or range-valued use context assigned to the capability statement |
|
| context-type TU | token |
|
A type of use context assigned to the capability statement |
CapabilityStatement.useContext.code |
| context-type-quantity TU | composite |
|
A use context type and quantity- or range-based value assigned to the capability statement |
CapabilityStatement.useContext |
| context-type-value TU | composite |
|
A use context type and value assigned to the capability statement |
CapabilityStatement.useContext |
| date TU | date |
|
The capability statement publication date |
CapabilityStatement.date |
| description TU | string |
|
The description of the capability statement |
CapabilityStatement.description |
|
fhirversion
|
token | CapabilityStatement-fhirversion |
The version of FHIR |
|
|
format
|
token | CapabilityStatement-format |
formats supported (xml | json | ttl | mime type) |
CapabilityStatement.format |
|
guide
|
reference | CapabilityStatement-guide |
Implementation guides supported |
CapabilityStatement.implementationGuide |
| identifier TU | token | CanonicalResource-identifier | External identifier for the capability statement | CapabilityStatement.identifier |
| jurisdiction TU | token |
|
Intended jurisdiction for the capability statement |
CapabilityStatement.jurisdiction |
|
mode
|
token | CapabilityStatement-mode |
Mode - restful (server/client) or messaging (sender/receiver) |
CapabilityStatement.rest.mode |
| name TU | string |
|
Computationally friendly name of the capability statement |
CapabilityStatement.name |
| publisher TU | string |
|
Name of the publisher of the capability statement |
CapabilityStatement.publisher |
|
resource
|
token | CapabilityStatement-resource |
Name of a resource mentioned in a capability statement |
CapabilityStatement.rest.resource.type |
|
resource-profile
|
reference | CapabilityStatement-resource-profile |
A profile id invoked in a capability statement |
CapabilityStatement.rest.resource.profile |
| security-service TU | token | CapabilityStatement-security-service |
OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates |
CapabilityStatement.rest.security.service |
|
software
|
string | CapabilityStatement-software |
Part of the name of a software application |
CapabilityStatement.software.name |
| status TU | token |
|
The current status of the capability statement |
CapabilityStatement.status |
| supported-profile TU | reference | CapabilityStatement-supported-profile |
Profiles for use cases supported |
CapabilityStatement.rest.resource.supportedProfile |
| title TU | string |
|
The human-friendly name of the capability statement |
CapabilityStatement.title |
| url TU | uri |
|
The uri that identifies the capability statement |
CapabilityStatement.url |
| version TU | token |
|
The business version of the capability statement |
CapabilityStatement.version |
| CarePlan TU | ||||
|
|
reference | CarePlan-activity-reference |
Activity
|
|
| based-on | reference | CarePlan-based-on |
Fulfills CarePlan |
CarePlan.basedOn |
| care-team | reference | CarePlan-care-team |
Who's involved in plan? |
CarePlan.careTeam |
| category | token | CarePlan-category |
Type of plan |
CarePlan.category |
| condition | reference | CarePlan-condition |
|
|
| custodian | reference | CarePlan-custodian | Who is the designated responsible party | CarePlan.custodian |
| date | date | clinical-date |
Time period plan covers |
CarePlan.period |
| encounter | reference |
|
The
Encounter
during
which
this
CarePlan
was
created
|
CarePlan.encounter |
| goal | reference | CarePlan-goal |
Desired outcome of plan |
CarePlan.goal |
| identifier | token | clinical-identifier |
External Ids for this plan |
CarePlan.identifier |
| instantiates-canonical | reference | CarePlan-instantiates-canonical |
Instantiates FHIR protocol or definition |
CarePlan.instantiatesCanonical |
| instantiates-uri | uri | CarePlan-instantiates-uri |
Instantiates external protocol or definition |
CarePlan.instantiatesUri |
| intent | token | CarePlan-intent |
proposal | plan | order | option | directive |
CarePlan.intent |
| part-of | reference | CarePlan-part-of |
Part of referenced CarePlan |
CarePlan.partOf |
| patient | reference | clinical-patient |
Who the care plan is for |
CarePlan.subject.where(resolve() is Patient) |
|
|
reference | CarePlan-replaces |
CarePlan replaced by this CarePlan |
CarePlan.replaces |
| status | token | CarePlan-status |
draft | active | on-hold | revoked | completed | entered-in-error | unknown |
CarePlan.status |
| subject | reference | CarePlan-subject |
Who the care plan is for |
CarePlan.subject |
| CareTeam TU | ||||
| category | token | CareTeam-category |
Type of team |
CareTeam.category |
| date | date | clinical-date |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| participant | reference | CareTeam-participant |
Who is involved |
CareTeam.participant.member |
| patient | reference | clinical-patient |
Who care team is for |
CareTeam.subject.where(resolve() is Patient) |
| status | token | CareTeam-status |
proposed | active | suspended | inactive | entered-in-error |
CareTeam.status |
| subject | reference | CareTeam-subject |
Who care team is for |
CareTeam.subject |
| ChargeItem TU | ||||
| account | reference | ChargeItem-account |
Account to place this charge |
ChargeItem.account |
| code | token |
|
A code that identifies the charge, like a billing code |
ChargeItem.code |
|
|
reference |
|
Encounter
|
|
| entered-date | date | ChargeItem-entered-date |
Date the charge item was entered |
ChargeItem.enteredDate |
| enterer | reference | ChargeItem-enterer |
Individual who was entering |
ChargeItem.enterer |
| factor-override | number | ChargeItem-factor-override |
Factor overriding the associated rules |
|
| identifier | token |
|
Business Identifier for item |
ChargeItem.identifier |
| occurrence | date | ChargeItem-occurrence |
When the charged service was applied |
|
| patient | reference |
|
Individual service was done for/to |
ChargeItem.subject.where(resolve() is Patient) |
| performer-actor | reference | ChargeItem-performer-actor |
Individual who was performing |
ChargeItem.performer.actor |
| performer-function | token | ChargeItem-performer-function |
What type of performance was done |
ChargeItem.performer.function |
| performing-organization | reference | ChargeItem-performing-organization |
Organization providing the charged service |
ChargeItem.performingOrganization |
| price-override | quantity | ChargeItem-price-override |
Price overriding the associated rules |
|
| quantity | quantity | ChargeItem-quantity |
Quantity of which the charge item has been serviced |
ChargeItem.quantity |
| requesting-organization | reference | ChargeItem-requesting-organization |
Organization requesting the charged service |
ChargeItem.requestingOrganization |
| service | reference | ChargeItem-service |
Which rendered service is being charged? |
|
| status | token | ChargeItem-status | Is this charge item active | ChargeItem.status |
| subject | reference | ChargeItem-subject |
Individual service was done for/to |
ChargeItem.subject |
| ChargeItemDefinition TU | ||||
| context | token |
|
A use context assigned to the charge item definition |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the charge item definition |
|
| context-type | token |
|
A type of use context assigned to the charge item definition |
ChargeItemDefinition.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the charge item definition |
ChargeItemDefinition.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the charge item definition |
ChargeItemDefinition.useContext |
| date | date |
|
The charge item definition publication date |
ChargeItemDefinition.date |
| description | string |
|
The description of the charge item definition |
ChargeItemDefinition.description |
| effective | date |
|
The time during which the charge item definition is intended to be in use |
|
| identifier | token |
|
External identifier for the charge item definition |
ChargeItemDefinition.identifier |
| jurisdiction | token |
|
Intended jurisdiction for the charge item definition |
ChargeItemDefinition.jurisdiction |
| publisher | string |
|
Name of the publisher of the charge item definition |
ChargeItemDefinition.publisher |
| status | token |
|
The current status of the charge item definition |
ChargeItemDefinition.status |
| title | string |
|
The human-friendly name of the charge item definition |
ChargeItemDefinition.title |
| url | uri |
|
The uri that identifies the charge item definition |
ChargeItemDefinition.url |
| version | token |
|
The business version of the charge item definition |
ChargeItemDefinition.version |
| Citation TU | ||||
| classification | composite | Citation-classification | A classification type and value assigned to the citation | Citation.classification |
| classification-type | token | Citation-classification-type | A type of classification assigned to the citation | (Citation.classification.type) |
| classifier | token | Citation-classifier | A classifier assigned to the citation | (Citation.classification.classifier) |
| context | token |
|
A use context assigned to the citation |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the citation |
|
| context-type | token |
|
A type of use context assigned to the citation |
Citation.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the citation |
Citation.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the citation |
Citation.useContext |
|
date
|
date |
|
The citation publication date |
Citation.date |
|
description
|
string |
|
The description of the citation |
Citation.description |
| effective | date |
|
The time during which the citation is intended to be in use |
Citation.effectivePeriod |
| identifier | token |
|
External identifier for the citation |
Citation.identifier |
| jurisdiction | token |
|
Intended jurisdiction for the citation |
Citation.jurisdiction |
|
name
|
string |
|
Computationally friendly name of the citation |
Citation.name |
|
publisher
|
string |
|
Name of the publisher of the citation |
Citation.publisher |
|
status
|
token |
|
The current status of the citation |
Citation.status |
|
title
|
string |
|
The human-friendly name of the citation |
Citation.title |
|
url
|
uri |
|
The uri that identifies the citation |
Citation.url |
|
version
|
token |
|
The business version of the citation |
Citation.version |
| Claim TU | ||||
| care-team | reference | Claim-care-team |
Member of the CareTeam |
Claim.careTeam.provider |
| created | date | Claim-created |
The creation date for the Claim |
Claim.created |
| detail-udi | reference | Claim-detail-udi |
UDI associated with a line item, detail product or service |
Claim.item.detail.udi |
| encounter | reference |
|
Encounters associated with a billed line item |
Claim.item.encounter |
| enterer | reference | Claim-enterer |
The party responsible for the entry of the Claim |
Claim.enterer |
| facility | reference | Claim-facility |
Facility where the products or services have been or will be provided |
Claim.facility |
| identifier | token |
|
The primary identifier of the financial resource |
Claim.identifier |
| insurer | reference | Claim-insurer |
The target payor/insurer for the Claim |
Claim.insurer |
| item-udi | reference | Claim-item-udi |
UDI associated with a line item product or service |
Claim.item.udi |
| patient | reference |
|
Patient receiving the products or services |
Claim.patient |
| payee | reference | Claim-payee |
The party receiving any payment for the Claim |
Claim.payee.party |
| priority | token | Claim-priority |
Processing priority requested |
Claim.priority |
| procedure-udi | reference | Claim-procedure-udi |
UDI associated with a procedure |
Claim.procedure.udi |
| provider | reference | Claim-provider |
Provider responsible for the Claim |
Claim.provider |
| status | token | Claim-status |
The status of the Claim instance. |
Claim.status |
| subdetail-udi | reference | Claim-subdetail-udi |
UDI associated with a line item, detail, subdetail product or service |
Claim.item.detail.subDetail.udi |
| use | token | Claim-use |
The kind of financial resource |
Claim.use |
| ClaimResponse TU | ||||
| created | date | ClaimResponse-created |
The creation date |
ClaimResponse.created |
| disposition | string | ClaimResponse-disposition |
The contents of the disposition message |
ClaimResponse.disposition |
| identifier | token |
|
The identity of the ClaimResponse |
ClaimResponse.identifier |
| insurer | reference | ClaimResponse-insurer |
The organization which generated this resource |
ClaimResponse.insurer |
| outcome | token | ClaimResponse-outcome |
The processing outcome |
ClaimResponse.outcome |
| patient | reference |
|
The subject of care |
ClaimResponse.patient |
| payment-date | date | ClaimResponse-payment-date |
The expected payment date |
ClaimResponse.payment.date |
| request | reference | ClaimResponse-request |
The claim reference |
ClaimResponse.request |
| requestor | reference | ClaimResponse-requestor |
The Provider of the claim |
ClaimResponse.requestor |
| status | token | ClaimResponse-status |
The status of the ClaimResponse |
ClaimResponse.status |
| use | token | ClaimResponse-use |
The type of claim |
ClaimResponse.use |
| ClinicalImpression TU | ||||
|
|
date | clinical-date |
When the assessment was documented |
ClinicalImpression.date |
| encounter | reference |
|
The
Encounter
during
which
this
ClinicalImpression
was
created
|
ClinicalImpression.encounter |
| finding-code | token | ClinicalImpression-finding-code |
|
|
| finding-ref | reference | ClinicalImpression-finding-ref |
|
|
| identifier | token |
|
Business identifier |
ClinicalImpression.identifier |
|
|
reference |
|
|
|
|
|
reference |
|
|
|
| previous | reference | ClinicalImpression-previous |
Reference to last assessment |
ClinicalImpression.previous |
| problem | reference | ClinicalImpression-problem |
Relevant impressions of patient state |
ClinicalImpression.problem |
| status | token | ClinicalImpression-status |
preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
ClinicalImpression.status |
| subject | reference | ClinicalImpression-subject |
Patient or group assessed |
ClinicalImpression.subject |
| supporting-info | reference | ClinicalImpression-supporting-info |
Information supporting the clinical impression |
ClinicalImpression.supportingInfo |
| ClinicalUseDefinition TU | ||||
| contraindication | token | ClinicalUseDefinition-contraindication |
The situation that is being documented as contraindicating against this item, as a code |
|
| contraindication-reference | reference | ClinicalUseDefinition-contraindication-reference |
The situation that is being documented as contraindicating against this item, as a reference |
|
| effect | token | ClinicalUseDefinition-effect |
The situation in which the undesirable effect may manifest, as a code |
|
| effect-reference | reference | ClinicalUseDefinition-effect-reference |
The situation in which the undesirable effect may manifest, as a reference |
|
| identifier | token | ClinicalUseDefinition-identifier |
Business identifier for this issue |
ClinicalUseDefinition.identifier |
| indication | token | ClinicalUseDefinition-indication |
The situation that is being documented as an indicaton for this item, as a code |
|
| indication-reference | reference | ClinicalUseDefinition-indication-reference |
The situation that is being documented as an indicaton for this item, as a reference |
|
| interaction | token | ClinicalUseDefinition-interaction |
The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction |
ClinicalUseDefinition.interaction.type |
| product | reference | ClinicalUseDefinition-product |
The medicinal product for which this is a clinical usage issue |
ClinicalUseDefinition.subject.where(resolve() is MedicinalProductDefinition) |
| status | token | ClinicalUseDefinition-status | Whether this is a current issue or one that has been retired etc. | ClinicalUseDefinition.status |
| subject | reference | ClinicalUseDefinition-subject |
The resource for which this is a clinical usage issue |
ClinicalUseDefinition.subject |
|
type
|
token | ClinicalUseDefinition-type |
indication | contraindication | interaction | undesirable-effect | warning |
ClinicalUseDefinition.type |
| CodeSystem N | ||||
|
code
|
token | CodeSystem-code |
A code defined in the code system |
CodeSystem.concept.code |
|
content-mode
|
token | CodeSystem-content-mode |
not-present | example | fragment | complete | supplement |
CodeSystem.content |
| context TU | token |
|
A use context assigned to the code system |
|
| context-quantity TU | quantity |
|
A quantity- or range-valued use context assigned to the code system |
|
| context-type TU | token |
|
A type of use context assigned to the code system |
CodeSystem.useContext.code |
| context-type-quantity TU | composite |
|
A use context type and quantity- or range-based value assigned to the code system |
CodeSystem.useContext |
| context-type-value TU | composite |
|
A use context type and value assigned to the code system |
CodeSystem.useContext |
| date TU | date |
|
The code system publication date |
CodeSystem.date |
| derived-from TU | reference | MetadataResource-derived-from | A resource that the CodeSystem is derived from | CodeSystem.relatedArtifact.where(type='derived-from').resource |
| description TU | string |
|
The description of the code system |
CodeSystem.description |
| effective TU | date | MetadataResource-effective | The time during which the CodeSystem is intended to be in use | CodeSystem.effectivePeriod |
| identifier TU | token |
|
External identifier for the code system |
CodeSystem.identifier |
| jurisdiction TU | token |
|
Intended jurisdiction for the code system |
CodeSystem.jurisdiction |
|
language
|
token | CodeSystem-language |
A language in which a designation is provided |
CodeSystem.concept.designation.language |
| name TU | string |
|
Computationally friendly name of the code system |
CodeSystem.name |
| predecessor TU | reference | MetadataResource-predecessor | The predecessor of the CodeSystem | CodeSystem.relatedArtifact.where(type='predecessor').resource |
| publisher TU | string |
|
Name of the publisher of the code system |
CodeSystem.publisher |
| status TU | token |
|
The current status of the code system |
CodeSystem.status |
| supplements TU | reference | CodeSystem-supplements |
Find code system supplements for the referenced code system |
CodeSystem.supplements |
|
system
|
uri | CodeSystem-system |
The system for any codes defined by this code system (same as 'url') |
CodeSystem.url |
| title TU | string |
|
The human-friendly name of the code system |
CodeSystem.title |
| topic TU | token | MetadataResource-topic | Topics associated with the CodeSystem | CodeSystem.topic |
| url TU | uri |
|
The uri that identifies the code system |
CodeSystem.url |
| version TU | token |
|
The business version of the code system |
CodeSystem.version |
| Communication TU | ||||
| based-on | reference | Communication-based-on |
Request fulfilled by this communication |
Communication.basedOn |
| category | token | Communication-category |
Message category |
Communication.category |
| encounter | reference |
|
The
Encounter
during
which
this
Communication
was
created
|
Communication.encounter |
| identifier | token |
|
Unique identifier |
Communication.identifier |
| instantiates-canonical | reference | Communication-instantiates-canonical |
Instantiates FHIR protocol or definition |
Communication.instantiatesCanonical |
| instantiates-uri | uri | Communication-instantiates-uri |
Instantiates external protocol or definition |
Communication.instantiatesUri |
| medium | token | Communication-medium |
A channel of communication |
Communication.medium |
| part-of | reference | Communication-part-of |
Part
of
|
Communication.partOf |
| patient | reference |
|
Focus of message |
Communication.subject.where(resolve() is Patient) |
| received | date | Communication-received |
When received |
Communication.received |
| recipient | reference | Communication-recipient |
|
Communication.recipient |
| sender | reference | Communication-sender |
|
Communication.sender |
| sent | date | Communication-sent |
When sent |
Communication.sent |
| status | token | Communication-status |
preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
Communication.status |
| subject | reference | Communication-subject |
Focus of message |
Communication.subject |
| topic | token | Communication-topic | Description of the purpose/content | Communication.topic |
| CommunicationRequest TU | ||||
| authored | date | CommunicationRequest-authored |
When request transitioned to being actionable |
CommunicationRequest.authoredOn |
| based-on | reference | CommunicationRequest-based-on |
Fulfills plan or proposal |
CommunicationRequest.basedOn |
| category | token | CommunicationRequest-category |
Message category |
CommunicationRequest.category |
| encounter | reference |
|
The
Encounter
during
which
this
CommunicationRequest
was
created
|
CommunicationRequest.encounter |
| group-identifier | token | CommunicationRequest-group-identifier |
Composite request this is part of |
CommunicationRequest.groupIdentifier |
| identifier | token |
|
Unique identifier |
CommunicationRequest.identifier |
| information-provider | reference | CommunicationRequest-information-provider | Who should share the information | CommunicationRequest.informationProvider |
| medium | token | CommunicationRequest-medium |
A channel of communication |
CommunicationRequest.medium |
| occurrence | date | CommunicationRequest-occurrence |
When scheduled |
|
| patient | reference |
|
Focus of message |
CommunicationRequest.subject.where(resolve() is Patient) |
| priority | token | CommunicationRequest-priority |
routine | urgent | asap | stat |
CommunicationRequest.priority |
| recipient | reference | CommunicationRequest-recipient |
|
CommunicationRequest.recipient |
| replaces | reference | CommunicationRequest-replaces |
Request(s) replaced by this request |
CommunicationRequest.replaces |
| requester | reference | CommunicationRequest-requester |
|
CommunicationRequest.requester |
|
|
token | CommunicationRequest-status |
draft | active | on-hold | revoked | completed | entered-in-error | unknown |
CommunicationRequest.status |
| subject | reference | CommunicationRequest-subject |
Focus of message |
CommunicationRequest.subject |
| CompartmentDefinition TU | ||||
| code | token | CompartmentDefinition-code |
Patient | Encounter | RelatedPerson | Practitioner | Device |
CompartmentDefinition.code |
| context | token |
|
A use context assigned to the compartment definition |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the compartment definition |
|
| context-type | token |
|
A type of use context assigned to the compartment definition |
CompartmentDefinition.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the compartment definition |
CompartmentDefinition.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the compartment definition |
CompartmentDefinition.useContext |
| date | date |
|
The compartment definition publication date |
CompartmentDefinition.date |
| description | string |
|
The description of the compartment definition |
CompartmentDefinition.description |
| name | string |
|
Computationally friendly name of the compartment definition |
CompartmentDefinition.name |
| publisher | string |
|
Name of the publisher of the compartment definition |
CompartmentDefinition.publisher |
| resource | token | CompartmentDefinition-resource |
Name of resource type |
CompartmentDefinition.resource.code |
| status | token |
|
The current status of the compartment definition |
CompartmentDefinition.status |
| url | uri |
|
The uri that identifies the compartment definition |
CompartmentDefinition.url |
| version | token |
|
The business version of the compartment definition |
CompartmentDefinition.version |
| Composition TU | ||||
| attester | reference | Composition-attester |
Who attested the composition |
Composition.attester.party |
| author | reference | Composition-author |
Who and/or what authored the composition |
Composition.author |
| category | token | Composition-category |
Categorization of Composition |
Composition.category |
|
|
token | Composition-context |
Code(s) that apply to the event being documented |
Composition.event.code |
| date | date | clinical-date |
Composition editing time |
Composition.date |
| encounter | reference | clinical-encounter |
Context of the Composition |
Composition.encounter |
| entry | reference | Composition-entry |
A reference to data that supports this section |
Composition.section.entry |
| identifier | token | clinical-identifier |
Version-independent identifier for the Composition |
Composition.identifier |
| patient | reference | clinical-patient |
Who and/or what the composition is about |
Composition.subject.where(resolve() is Patient) |
| period | date | Composition-period |
The period covered by the documentation |
Composition.event.period |
|
|
|
|
Target of the relationship |
|
|
|
|
|
|
|
|
|
|
|
| Composition.section |
| section-text | special | Composition-section-text |
Search
on
the
section
|
|
| status | token | Composition-status |
preliminary | final | amended | entered-in-error |
Composition.status |
| subject | reference | Composition-subject |
Who and/or what the composition is about |
Composition.subject |
| title | string | Composition-title |
Human Readable name/title |
Composition.title |
| type | token | clinical-type |
Kind of composition (LOINC if possible) |
Composition.type |
| url | uri | Composition-url | The uri that identifies the activity definition | Composition.url |
| version | token | Composition-version | The business version of the activity definition | Composition.version |
| ConceptMap TU | ||||
| context | token |
|
A use context assigned to the concept map |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the concept map |
|
| context-type | token |
|
A type of use context assigned to the concept map |
ConceptMap.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the concept map |
ConceptMap.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the concept map |
ConceptMap.useContext |
| date | date |
|
The concept map publication date |
ConceptMap.date |
|
|
|
|
|
|
| description | string |
|
The description of the concept map |
ConceptMap.description |
| effective | date | MetadataResource-effective | The time during which the ConceptMap is intended to be in use | ConceptMap.effectivePeriod |
| identifier | token |
|
External identifier for the concept map |
ConceptMap.identifier |
| jurisdiction | token |
|
Intended jurisdiction for the concept map |
ConceptMap.jurisdiction |
| mapping-property | uri | ConceptMap-mapping-property | Other properties required for this mapping | ConceptMap.property.uri |
| name | string |
|
Computationally friendly name of the concept map |
ConceptMap.name |
|
|
reference |
|
canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped |
|
|
|
|
|
|
|
| publisher | string |
|
Name of the publisher of the concept map |
ConceptMap.publisher |
|
|
token | ConceptMap-source-code |
Identifies
|
ConceptMap.group.element.code |
|
|
|
|
Source system where concepts to be mapped are defined |
ConceptMap.group.source |
|
|
reference |
|
The source value set that contains the concepts that are being mapped |
|
|
|
|
|
The
|
|
|
|
|
|
The
|
|
| target-code | token | ConceptMap-target-code |
Code that identifies the target element |
ConceptMap.group.element.target.code |
|
|
|
|
Target system that the concepts are to be mapped to |
ConceptMap.group.target |
|
|
reference |
|
The target value set which provides context for the mappings |
|
| target-scope-uri | uri | ConceptMap-target-scope-uri | The URI for the target value set that contains the concepts being mapped. | (ConceptMap.targetScope as uri) |
| title | string |
|
The human-friendly name of the concept map |
ConceptMap.title |
| topic | token | MetadataResource-topic | Topics associated with the ConceptMap | ConceptMap.topic |
| url | uri |
|
The
|
ConceptMap.url |
| version | token |
|
The business version of the concept map |
ConceptMap.version |
| Condition TU | ||||
| abatement-age | quantity | Condition-abatement-age |
Abatement as age or age range |
|
| abatement-date | date | Condition-abatement-date |
Date-related abatements (dateTime and period) |
|
| abatement-string | string | Condition-abatement-string |
Abatement as a string |
|
| body-site | token | Condition-body-site |
Anatomical location, if relevant |
Condition.bodySite |
| category | token | Condition-category |
The category of the condition |
Condition.category |
| clinical-status | token | Condition-clinical-status |
The clinical status of the condition |
Condition.clinicalStatus |
| code | token | clinical-code |
Code for the condition |
Condition.code |
| encounter | reference |
|
The
Encounter
during
which
this
Condition
was
created
|
Condition.encounter |
| evidence | token | Condition-evidence |
Manifestation/symptom |
|
| evidence-detail | reference | Condition-evidence-detail |
Supporting information found elsewhere |
|
| identifier | token | clinical-identifier |
A unique identifier of the condition record |
Condition.identifier |
| onset-age | quantity | Condition-onset-age |
Onsets as age or age range |
|
| onset-date | date | Condition-onset-date |
Date related onsets (dateTime and Period) |
|
| onset-info | string | Condition-onset-info |
Onsets as a string |
|
| participant-actor | reference | Condition-participant-actor | Who or what participated in the activities related to the condition | Condition.participant.actor |
| participant-function | token | Condition-participant-function | Type of involvement of the actor in the activities related to the condition | Condition.participant.function |
| patient | reference | clinical-patient |
Who has the condition? |
Condition.subject.where(resolve() is Patient) |
| recorded-date | date | Condition-recorded-date |
Date record was first recorded |
Condition.recordedDate |
| severity | token | Condition-severity |
The severity of the condition |
Condition.severity |
| stage | token | Condition-stage |
Simple summary (disease specific) |
Condition.stage.summary |
| subject | reference | Condition-subject |
Who has the condition? |
Condition.subject |
| verification-status | token | Condition-verification-status |
unconfirmed | provisional | differential | confirmed | refuted | entered-in-error |
Condition.verificationStatus |
| ConditionDefinition TU | ||||
| context | token | CanonicalResource-context | A use context assigned to the condition definition | (ConditionDefinition.useContext.value.ofType(CodeableConcept)) |
| context-quantity | quantity | CanonicalResource-context-quantity | A quantity- or range-valued use context assigned to the condition definition | (ConditionDefinition.useContext.value.ofType(Quantity)) | (ConditionDefinition.useContext.value.ofType(Range)) |
| context-type | token | CanonicalResource-context-type | A type of use context assigned to the condition definition | ConditionDefinition.useContext.code |
| context-type-quantity | composite | CanonicalResource-context-type-quantity | A use context type and quantity- or range-based value assigned to the condition definition | ConditionDefinition.useContext |
| context-type-value | composite | CanonicalResource-context-type-value | A use context type and value assigned to the condition definition | ConditionDefinition.useContext |
| date | date | CanonicalResource-date | The condition definition publication date | ConditionDefinition.date |
| description | string | CanonicalResource-description | The description of the condition definition | ConditionDefinition.description |
| identifier | token | CanonicalResource-identifier | External identifier for the condition definition | ConditionDefinition.identifier |
| jurisdiction | token | CanonicalResource-jurisdiction | Intended jurisdiction for the condition definition | ConditionDefinition.jurisdiction |
| name | string | CanonicalResource-name | Computationally friendly name of the condition definition | ConditionDefinition.name |
| publisher | string | CanonicalResource-publisher | Name of the publisher of the condition definition | ConditionDefinition.publisher |
| status | token | CanonicalResource-status | The current status of the condition definition | ConditionDefinition.status |
| title | string | CanonicalResource-title | The human-friendly name of the condition definition | ConditionDefinition.title |
| url | uri | CanonicalResource-url | The uri that identifies the condition definition | ConditionDefinition.url |
| version | token | CanonicalResource-version | The business version of the condition definition | ConditionDefinition.version |
| Consent TU | ||||
| action | token | Consent-action |
Actions controlled by this rule |
Consent.provision.action |
| actor | reference | Consent-actor |
Resource for the actor (or group, by role) |
Consent.provision.actor.reference |
| category | token | Consent-category |
Classification of the consent statement - for indexing/retrieval |
Consent.category |
|
|
reference |
|
|
|
| data | reference | Consent-data |
The actual data reference |
Consent.provision.data.reference |
| date | date | clinical-date |
When
|
|
| grantee | reference | Consent-grantee | Who is agreeing to the policy and rules | Consent.grantee |
| identifier | token | clinical-identifier |
Identifier for this record (external references) |
Consent.identifier |
|
|
reference |
|
|
|
| patient | reference | clinical-patient |
Who the consent applies to |
|
| period | date | Consent-period |
Timeframe for this rule |
Consent.provision.period |
| purpose | token | Consent-purpose |
Context of activities covered by this rule |
Consent.provision.purpose |
|
|
token | Consent-security-label |
Security Labels that define affected resources |
Consent.provision.securityLabel |
| source-reference | reference | Consent-source-reference |
Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse |
|
| status | token | Consent-status |
draft
|
|
Consent.status |
| subject | reference | Consent-subject | Who the consent applies to | Consent.subject |
| verified | token | Consent-verified | Has been verified | Consent.verification.verified |
| verified-date | date | Consent-verified-date | When consent verified | Consent.verification.verificationDate |
| Contract TU | ||||
| authority | reference | Contract-authority |
The authority of the contract |
Contract.authority |
| domain | reference | Contract-domain |
The domain of the contract |
Contract.domain |
| identifier | token |
|
The identity of the contract |
Contract.identifier |
| instantiates | uri | Contract-instantiates |
A source definition of the contract |
Contract.instantiatesUri |
| issued | date | Contract-issued |
The date/time the contract was issued |
Contract.issued |
| patient | reference |
|
The identity of the subject of the contract (if a patient) |
Contract.subject.where(resolve() is Patient) |
| signer | reference | Contract-signer |
Contract Signatory Party |
Contract.signer.party |
| status | token | Contract-status |
The status of the contract |
Contract.status |
| subject | reference | Contract-subject |
The identity of the subject of the contract |
Contract.subject |
| url | uri | Contract-url |
The basal contract definition |
Contract.url |
| Coverage TU | ||||
| beneficiary | reference | Coverage-beneficiary |
Covered party |
Coverage.beneficiary |
| class-type | token | Coverage-class-type |
Coverage
class
|
Coverage.class.type |
| class-value |
|
Coverage-class-value |
Value
of
the
class
|
Coverage.class.value |
| dependent | string | Coverage-dependent |
Dependent number |
Coverage.dependent |
| identifier | token |
|
The primary identifier of the insured and the coverage |
Coverage.identifier |
| insurer | reference | Coverage-insurer | The identity of the insurer | Coverage.insurer |
| patient | reference |
|
Retrieve coverages for a patient |
Coverage.beneficiary |
|
|
reference |
|
|
|
| policy-holder | reference | Coverage-policy-holder |
Reference to the policyholder |
Coverage.policyHolder |
| status | token | Coverage-status |
The status of the Coverage |
Coverage.status |
| subscriber | reference | Coverage-subscriber |
Reference to the subscriber |
Coverage.subscriber |
| subscriberid | token | Coverage-subscriberid | Identifier of the subscriber | Coverage.subscriberId |
| type | token |
|
The kind of coverage (health plan, auto, Workers Compensation) |
Coverage.type |
| CoverageEligibilityRequest TU | ||||
| created | date | CoverageEligibilityRequest-created |
The creation date for the EOB |
CoverageEligibilityRequest.created |
| enterer | reference | CoverageEligibilityRequest-enterer |
The party who is responsible for the request |
CoverageEligibilityRequest.enterer |
| facility | reference | CoverageEligibilityRequest-facility |
Facility responsible for the goods and services |
CoverageEligibilityRequest.facility |
| identifier | token |
|
The business identifier of the Eligibility |
CoverageEligibilityRequest.identifier |
| patient | reference |
|
The reference to the patient |
CoverageEligibilityRequest.patient |
| provider | reference | CoverageEligibilityRequest-provider |
The reference to the provider |
CoverageEligibilityRequest.provider |
| status | token | CoverageEligibilityRequest-status |
The status of the EligibilityRequest |
CoverageEligibilityRequest.status |
| CoverageEligibilityResponse TU | ||||
| created | date | CoverageEligibilityResponse-created |
The creation date |
CoverageEligibilityResponse.created |
| disposition | string | CoverageEligibilityResponse-disposition |
The contents of the disposition message |
CoverageEligibilityResponse.disposition |
| identifier | token |
|
The business identifier |
CoverageEligibilityResponse.identifier |
| insurer | reference | CoverageEligibilityResponse-insurer |
The organization which generated this resource |
CoverageEligibilityResponse.insurer |
| outcome | token | CoverageEligibilityResponse-outcome |
The processing outcome |
CoverageEligibilityResponse.outcome |
| patient | reference |
|
The reference to the patient |
CoverageEligibilityResponse.patient |
| request | reference | CoverageEligibilityResponse-request |
The EligibilityRequest reference |
CoverageEligibilityResponse.request |
| requestor | reference | CoverageEligibilityResponse-requestor |
The EligibilityRequest provider |
CoverageEligibilityResponse.requestor |
| status | token | CoverageEligibilityResponse-status |
The EligibilityRequest status |
CoverageEligibilityResponse.status |
| DetectedIssue TU | ||||
| author | reference | DetectedIssue-author |
The provider or device that identified the issue |
DetectedIssue.author |
|
|
token |
|
Issue Category, e.g. drug-drug, duplicate therapy, etc. |
DetectedIssue.category |
| code | token | clinical-code | Issue Type, e.g. drug-drug, duplicate therapy, etc. | DetectedIssue.code |
| identified | date | DetectedIssue-identified |
When identified |
|
| identifier | token | clinical-identifier |
Unique id for the detected issue |
DetectedIssue.identifier |
| implicated | reference | DetectedIssue-implicated |
Problem resource |
DetectedIssue.implicated |
| patient | reference | clinical-patient |
Associated patient |
|
| status | token | DetectedIssue-status | The status of the issue | DetectedIssue.status |
| subject | reference | DetectedIssue-subject | Associated subject | DetectedIssue.subject |
| Device TU | ||||
| biological-source-event | token | Device-biological-source-event | The biological source for the device | Device.biologicalSourceEvent |
| code | token | Device-code | The definition / type of the device (code) | Device.definition.concept |
| code-value-concept | composite | Device-code-value-concept | Code and value parameter pair | Device |
| definition | reference | Device-definition | The definition / type of the device | Device.definition.reference |
| device-name | string | Device-device-name |
A
server
defined
search
that
may
match
any
of
the
string
fields
in
|
|
| expiration-date | date | Device-expiration-date | The expiration date of the device | Device.expirationDate |
| identifier | token | Device-identifier |
Instance id from manufacturer, owner, and others |
Device.identifier |
| location | reference | Device-location |
A location, where the resource is found |
Device.location |
| lot-number | string | Device-lot-number | The lot number of the device | Device.lotNumber |
| manufacture-date | date | Device-manufacture-date | The manufacture date of the device | Device.manufactureDate |
| manufacturer | string | Device-manufacturer |
The manufacturer of the device |
Device.manufacturer |
| model | string | Device-model |
The model of the device |
Device.modelNumber |
| organization | reference | Device-organization |
The organization responsible for the device |
Device.owner |
|
|
reference |
|
| Device.parent |
| serial-number | string | Device-serial-number |
The
serial
number
of
the
|
|
| specification | token | Device-specification | The standards, specifications, or formal guidances. | Device.conformsTo.specification |
| specification-version | composite | Device-specification-version | A composite of both specification and version | Device.conformsTo |
| status | token | Device-status |
active | inactive | entered-in-error | unknown |
Device.status |
| type | token | Device-type |
The type of the device |
Device.type |
| udi-carrier | string | Device-udi-carrier |
UDI Barcode (RFID or other technology) string in HRF format. |
Device.udiCarrier.carrierHRF |
| udi-di | string | Device-udi-di |
The udi Device Identifier (DI) |
Device.udiCarrier.deviceIdentifier |
| url | uri | Device-url |
Network address to contact device |
Device.url |
| version | string | Device-version | The specific version of the device | Device.version.value |
| DeviceAssociation D | ||||
| device | reference | DeviceAssociation-device | Search for products that match this code | DeviceAssociation.device |
| identifier | token | DeviceAssociation-identifier | The identifier of the device association | DeviceAssociation.identifier |
| operator | reference | DeviceAssociation-operator | The identity of a operator for whom to list associations | DeviceAssociation.operation.operator |
| patient | reference | DeviceAssociation-patient | The identity of a patient for whom to list associations | DeviceAssociation.subject |
| status | token | DeviceAssociation-status | The status of the device associations | DeviceAssociation.status |
| subject | reference | DeviceAssociation-subject | The identity of a patient for whom to list associations | DeviceAssociation.subject |
| DeviceDefinition TU | ||||
| device-name | string | DeviceDefinition-device-name | A server defined search that may match any of the string fields in DeviceDefinition.name or DeviceDefinition.classification.type - the latter to search for 'generic' devices. | DeviceDefinition.deviceName.name | DeviceDefinition.classification.type.coding.display | DeviceDefinition.classification.type.text |
| identifier | token | DeviceDefinition-identifier |
The identifier of the component |
DeviceDefinition.identifier |
|
|
reference |
|
The
|
|
| organization | reference | DeviceDefinition-organization | The organization responsible for the device | DeviceDefinition.owner |
| specification | token | DeviceDefinition-specification | The specification that the device conforms to | DeviceDefinition.conformsTo.specification |
| specification-version | composite | DeviceDefinition-specification-version | A composite of both specification and version | DeviceDefinition.conformsTo |
| type | token | DeviceDefinition-type |
The
device
|
|
|
|
||||
|
|
token |
| Search for devices that match this code | DeviceDispense.device.concept |
| identifier | token | DeviceDispense-identifier |
The
|
|
|
| reference | DeviceDispense-patient | Returns device dispenses for a specific patient | DeviceDispense.subject.where(resolve() is Patient) |
| status | token |
|
The
|
|
|
|
reference |
|
The
| DeviceDispense.subject |
|
DeviceMetric
| ||||
| category | token | DeviceMetric-category | The category of the metric |
|
|
|
reference |
|
The device resource |
|
| identifier | token | DeviceMetric-identifier | The identifier of the metric | DeviceMetric.identifier |
| type | token | DeviceMetric-type |
The
|
DeviceMetric.type |
| DeviceRequest TU | ||||
| authored-on | date | DeviceRequest-authored-on |
When the request transitioned to being actionable |
DeviceRequest.authoredOn |
| based-on | reference | DeviceRequest-based-on |
Plan/proposal/order fulfilled by this request |
DeviceRequest.basedOn |
| code | token | clinical-code |
Code for what is being requested/ordered |
|
| device | reference | DeviceRequest-device |
Reference to resource that is being requested/ordered |
|
| encounter | reference | clinical-encounter |
Encounter during which request was created |
DeviceRequest.encounter |
| event-date | date | DeviceRequest-event-date |
When service should occur |
|
| group-identifier | token | DeviceRequest-group-identifier |
Composite request this is part of |
DeviceRequest.groupIdentifier |
| identifier | token | clinical-identifier |
Business identifier for request/order |
DeviceRequest.identifier |
| instantiates-canonical | reference | DeviceRequest-instantiates-canonical |
Instantiates FHIR protocol or definition |
DeviceRequest.instantiatesCanonical |
| instantiates-uri | uri | DeviceRequest-instantiates-uri |
Instantiates external protocol or definition |
DeviceRequest.instantiatesUri |
| insurance | reference | DeviceRequest-insurance |
Associated insurance coverage |
DeviceRequest.insurance |
| intent | token | DeviceRequest-intent |
proposal | plan | original-order |reflex-order |
DeviceRequest.intent |
| patient | reference | clinical-patient |
Individual the service is ordered for |
DeviceRequest.subject.where(resolve() is Patient) |
| performer | reference | DeviceRequest-performer |
Desired performer for service |
|
| performer-code | token | DeviceRequest-performer-code | Desired performer for service | DeviceRequest.performer.concept |
| prior-request | reference | DeviceRequest-prior-request |
Request takes the place of referenced completed or terminated requests |
|
| requester | reference | DeviceRequest-requester |
Who/what is requesting service |
DeviceRequest.requester |
| status | token | DeviceRequest-status |
entered-in-error | draft | active |suspended | completed |
DeviceRequest.status |
| subject | reference | DeviceRequest-subject |
Individual the service is ordered for |
DeviceRequest.subject |
|
|
||||
| device |
|
|
Search by device |
|
| identifier | token |
|
Search by identifier |
|
| patient | reference | clinical-patient |
Search
by
|
|
|
|
|
|
|
|
| DiagnosticReport TU | ||||
| based-on | reference | DiagnosticReport-based-on |
Reference to the service request. |
DiagnosticReport.basedOn |
| category | token | DiagnosticReport-category |
Which diagnostic discipline/department created the report |
DiagnosticReport.category |
| code | token | clinical-code |
The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result |
DiagnosticReport.code |
| conclusion | token | DiagnosticReport-conclusion |
A coded conclusion (interpretation/impression) on the report |
DiagnosticReport.conclusionCode |
| date | date | clinical-date |
The clinically relevant time of the report |
|
| encounter | reference | clinical-encounter |
The Encounter when the order was made |
DiagnosticReport.encounter |
| identifier | token | clinical-identifier |
An identifier for the report |
DiagnosticReport.identifier |
| issued | date | DiagnosticReport-issued |
When the report was issued |
DiagnosticReport.issued |
| media | reference | DiagnosticReport-media |
A reference to the image source. |
DiagnosticReport.media.link |
| patient | reference | clinical-patient |
The subject of the report if a patient |
DiagnosticReport.subject.where(resolve() is Patient) |
| performer | reference | DiagnosticReport-performer |
Who is responsible for the report |
DiagnosticReport.performer |
| result | reference | DiagnosticReport-result |
Link to an atomic result (observation resource) |
DiagnosticReport.result |
| results-interpreter | reference | DiagnosticReport-results-interpreter |
Who was the source of the report |
DiagnosticReport.resultsInterpreter |
| specimen | reference | DiagnosticReport-specimen |
The specimen details |
DiagnosticReport.specimen |
| status | token | DiagnosticReport-status |
The status of the report |
DiagnosticReport.status |
|
|
reference |
|
|
|
|
|
reference |
|
|
|
|
|
||||
|
|
reference |
|
|
|
|
|
reference |
|
|
|
|
|
reference |
|
|
|
|
|
token |
|
|
|
|
|
reference |
|
|
|
|
|
|
|
|
|
|
|
token |
|
|
|
|
|
reference |
|
|
|
|
|
|
|
|
|
|
|
reference |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
token |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
reference |
|
|
|
|
|
token |
|
|
|
|
|
|
|
|
|
| identifier | token | clinical-identifier |
|
|
| language | token | DocumentReference-language |
Human language of the content (BCP-47) |
DocumentReference.content.attachment.language |
| location | uri | DocumentReference-location |
Uri where the data can be found |
DocumentReference.content.attachment.url |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| relatesto | reference | DocumentReference-relatesto |
Target of the relationship |
DocumentReference.relatesTo.target |
| relation | token | DocumentReference-relation |
replaces | transforms | signs | appends |
DocumentReference.relatesTo.code |
| relationship | composite | DocumentReference-relationship |
Combination of relation and relatesTo |
DocumentReference.relatesTo |
| security-label | token | DocumentReference-security-label |
Document security-tags |
DocumentReference.securityLabel |
| setting | token | DocumentReference-setting |
Additional details about where the content was created (e.g. clinical specialty) |
|
| status | token | DocumentReference-status |
current | superseded | entered-in-error |
DocumentReference.status |
| subject | reference | DocumentReference-subject |
Who/what is the subject of the document |
DocumentReference.subject |
| type | token | clinical-type |
Kind of document (LOINC if possible) |
DocumentReference.type |
| version | string | DocumentReference-version | The business version identifier | DocumentReference.version |
| Encounter TU | ||||
| account | reference | Encounter-account |
The set of accounts that may be used for billing for this Encounter |
Encounter.account |
| appointment | reference | Encounter-appointment |
The appointment that scheduled this encounter |
Encounter.appointment |
| based-on | reference | Encounter-based-on |
The ServiceRequest that initiated this encounter |
Encounter.basedOn |
| careteam | reference | Encounter-careteam | Careteam allocated to participate in the encounter | Encounter.careTeam |
| class | token | Encounter-class |
Classification of patient encounter |
Encounter.class |
| date | date | clinical-date |
A
date
within
the
|
|
| date-start | date | Encounter-date-start | The actual start date of the Encounter | Encounter.actualPeriod.start |
| diagnosis-code | token | Encounter-diagnosis-code | The diagnosis or procedure relevant to the encounter (coded) | Encounter.diagnosis.condition.concept |
| diagnosis-reference | reference |
|
The diagnosis or procedure relevant to the encounter (resource reference) |
|
| end-date | date | Encounter-end-date | The actual end date of the Encounter | Encounter.actualPeriod.end |
| episode-of-care | reference | Encounter-episode-of-care |
Episode(s) of care that this encounter should be recorded against |
Encounter.episodeOfCare |
| identifier | token | clinical-identifier |
Identifier(s) by which this encounter is known |
Encounter.identifier |
| length | quantity | Encounter-length |
Length of encounter in days |
Encounter.length |
| location | reference | Encounter-location |
Location the encounter takes place |
Encounter.location.location |
| location-period |
|
Encounter-location-period |
Time period during which the patient was present at the location |
|
| part-of | reference | Encounter-part-of |
Another Encounter this encounter is part of |
Encounter.partOf |
| participant | reference | Encounter-participant |
Persons involved in the encounter other than the patient |
|
| participant-type | token | Encounter-participant-type |
Role of participant in encounter |
Encounter.participant.type |
| patient | reference | clinical-patient |
The
patient
|
Encounter.subject.where(resolve() is Patient) |
| practitioner | reference | Encounter-practitioner |
Persons involved in the encounter other than the patient |
|
| reason-code | token | Encounter-reason-code |
|
|
| reason-reference | reference | Encounter-reason-reference |
|
|
| service-provider | reference | Encounter-service-provider |
The organization (facility) responsible for this encounter |
Encounter.serviceProvider |
| special-arrangement | token | Encounter-special-arrangement |
Wheelchair, translator, stretcher, etc. |
|
| status | token | Encounter-status |
planned
|
|
Encounter.status |
| subject | reference | Encounter-subject |
The patient or group present at the encounter |
Encounter.subject |
| subject-status | token | Encounter-subject-status | The current status of the subject in relation to the Encounter | Encounter.subjectStatus |
| type | token | clinical-type |
Specific type of encounter |
Encounter.type |
| EncounterHistory TU | ||||
| encounter | reference | clinical-encounter | The Encounter associated with this set of history values | EncounterHistory.encounter |
| identifier | token | EncounterHistory-identifier | Identifier(s) by which this encounter is known | EncounterHistory.identifier |
| patient | reference | EncounterHistory-patient | The patient present at the encounter | EncounterHistory.subject.where(resolve() is Patient) |
| status | token | EncounterHistory-status | Status of the Encounter history entry | EncounterHistory.status |
| subject | reference | EncounterHistory-subject | The patient or group present at the encounter | EncounterHistory.subject |
| Endpoint TU | ||||
| connection-type | token | Endpoint-connection-type |
Protocol/Profile/Standard to be used with this endpoint connection |
Endpoint.connectionType |
| identifier | token | Endpoint-identifier |
Identifies this endpoint across multiple systems |
Endpoint.identifier |
| name | string | Endpoint-name |
A name that this endpoint can be identified by |
Endpoint.name |
| organization | reference | Endpoint-organization |
The organization that is managing the endpoint |
Endpoint.managingOrganization |
| payload-type | token | Endpoint-payload-type |
The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) |
|
| status | token | Endpoint-status |
The current status of the Endpoint (usually expected to be active) |
Endpoint.status |
| EnrollmentRequest TU | ||||
| identifier | token |
|
The business identifier of the Enrollment |
EnrollmentRequest.identifier |
| patient | reference |
|
The party to be enrolled |
EnrollmentRequest.candidate |
| status | token | EnrollmentRequest-status |
The status of the enrollment |
EnrollmentRequest.status |
| subject | reference | EnrollmentRequest-subject |
The party to be enrolled |
EnrollmentRequest.candidate |
| EnrollmentResponse TU | ||||
| identifier | token | EnrollmentResponse-identifier |
The business identifier of the EnrollmentResponse |
EnrollmentResponse.identifier |
| request | reference | EnrollmentResponse-request |
The reference to the claim |
EnrollmentResponse.request |
| status | token | EnrollmentResponse-status |
The status of the enrollment response |
EnrollmentResponse.status |
| EpisodeOfCare TU | ||||
| care-manager | reference | EpisodeOfCare-care-manager |
Care manager/care coordinator for the patient |
EpisodeOfCare.careManager.where(resolve() is Practitioner) |
|
|
|
| The provided date search value falls within the episode of care's period | EpisodeOfCare.period |
| diagnosis-code | token | EpisodeOfCare-diagnosis-code |
Conditions/problems/diagnoses this episode of care is for (coded) |
|
|
|
|
|
|
|
| identifier | token | clinical-identifier |
Business Identifier(s) relevant for this EpisodeOfCare |
EpisodeOfCare.identifier |
| incoming-referral | reference | EpisodeOfCare-incoming-referral |
Incoming Referral Request |
EpisodeOfCare.referralRequest |
| organization | reference | EpisodeOfCare-organization |
The organization that has assumed the specific responsibilities of this EpisodeOfCare |
EpisodeOfCare.managingOrganization |
| patient | reference | clinical-patient |
The patient who is the focus of this episode of care |
EpisodeOfCare.patient |
| reason-code | token | EpisodeOfCare-reason-code | Reference to a concept (coded) | EpisodeOfCare.reason.value.concept |
| reason-reference | reference | EpisodeOfCare-reason-reference | Reference to a resource (resource reference) | EpisodeOfCare.reason.value.reference |
| status | token | EpisodeOfCare-status |
The current status of the Episode of Care as provided (does not check the status history collection) |
EpisodeOfCare.status |
| type | token | clinical-type |
Type/class - e.g. specialist referral, disease management |
EpisodeOfCare.type |
| EventDefinition TU | ||||
| composed-of | reference |
|
What resource is being referenced |
EventDefinition.relatedArtifact.where(type='composed-of').resource |
| context | token |
|
A use context assigned to the event definition |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the event definition |
|
| context-type | token |
|
A type of use context assigned to the event definition |
EventDefinition.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the event definition |
EventDefinition.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the event definition |
EventDefinition.useContext |
| date | date |
|
The event definition publication date |
EventDefinition.date |
| depends-on | reference |
|
What resource is being referenced |
EventDefinition.relatedArtifact.where(type='depends-on').resource |
| derived-from | reference |
|
What resource is being referenced |
EventDefinition.relatedArtifact.where(type='derived-from').resource |
| description | string |
|
The description of the event definition |
EventDefinition.description |
| effective | date |
|
The time during which the event definition is intended to be in use |
EventDefinition.effectivePeriod |
| identifier | token |
|
External identifier for the event definition |
EventDefinition.identifier |
| jurisdiction | token |
|
Intended jurisdiction for the event definition |
EventDefinition.jurisdiction |
| name | string |
|
Computationally friendly name of the event definition |
EventDefinition.name |
| predecessor | reference |
|
What resource is being referenced |
EventDefinition.relatedArtifact.where(type='predecessor').resource |
| publisher | string |
|
Name of the publisher of the event definition |
EventDefinition.publisher |
| status | token |
|
The current status of the event definition |
EventDefinition.status |
| successor | reference |
|
What resource is being referenced |
EventDefinition.relatedArtifact.where(type='successor').resource |
| title | string |
|
The human-friendly name of the event definition |
EventDefinition.title |
| topic | token |
|
Topics associated with the module |
EventDefinition.topic |
| url | uri |
|
The uri that identifies the event definition |
EventDefinition.url |
| version | token |
|
The business version of the event definition |
EventDefinition.version |
| Evidence TU | ||||
| context | token |
|
A use context assigned to the evidence |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the evidence |
|
| context-type | token |
|
A type of use context assigned to the evidence |
Evidence.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the evidence |
Evidence.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the evidence |
Evidence.useContext |
|
date
|
date |
|
The evidence publication date |
Evidence.date |
|
description
|
string |
|
The description of the evidence |
Evidence.description |
| identifier | token |
|
External identifier for the evidence |
Evidence.identifier |
|
publisher
|
string |
|
Name of the publisher of the evidence |
Evidence.publisher |
|
status
|
token |
|
The current status of the evidence |
Evidence.status |
|
title
|
string |
|
The human-friendly name of the evidence |
Evidence.title |
|
url
|
uri |
|
The uri that identifies the evidence |
Evidence.url |
|
version
|
token |
|
The business version of the evidence |
Evidence.version |
| EvidenceReport TU | ||||
| context | token |
|
A use context assigned to the evidence report |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the evidence report |
|
| context-type | token |
|
A type of use context assigned to the evidence report |
EvidenceReport.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the evidence report |
EvidenceReport.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the evidence report |
EvidenceReport.useContext |
| identifier | token |
|
External identifier for the evidence report |
EvidenceReport.identifier |
|
publisher
|
string |
|
Name of the publisher of the evidence report |
EvidenceReport.publisher |
|
status
|
token |
|
The current status of the evidence report |
EvidenceReport.status |
|
url
|
uri |
|
The uri that identifies the evidence report |
EvidenceReport.url |
| EvidenceVariable TU | ||||
| composed-of | reference | MetadataResource-composed-of | What resource is being referenced | EvidenceVariable.relatedArtifact.where(type='composed-of').resource |
| context | token |
|
A use context assigned to the evidence variable |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the evidence variable |
|
| context-type | token |
|
A type of use context assigned to the evidence variable |
EvidenceVariable.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the evidence variable |
EvidenceVariable.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the evidence variable |
EvidenceVariable.useContext |
|
date
|
date |
|
The evidence variable publication date |
EvidenceVariable.date |
|
| reference | MetadataResource-depends-on | What resource is being referenced | EvidenceVariable.relatedArtifact.where(type='depends-on').resource |
| derived-from | reference | MetadataResource-derived-from | What resource is being referenced | EvidenceVariable.relatedArtifact.where(type='derived-from').resource |
| description | string |
|
The description of the evidence variable |
EvidenceVariable.description |
| identifier | token |
|
External identifier for the evidence variable |
EvidenceVariable.identifier |
|
name
|
string |
|
Computationally friendly name of the evidence variable |
EvidenceVariable.name |
|
| reference | MetadataResource-predecessor | What resource is being referenced | EvidenceVariable.relatedArtifact.where(type='predecessor').resource |
| publisher | string |
|
Name of the publisher of the evidence variable |
EvidenceVariable.publisher |
|
status
|
token |
|
The current status of the evidence variable |
EvidenceVariable.status |
|
| reference | MetadataResource-successor | What resource is being referenced | EvidenceVariable.relatedArtifact.where(type='successor').resource |
| title | string |
|
The human-friendly name of the evidence variable |
EvidenceVariable.title |
|
| token | MetadataResource-topic | Topics associated with the EvidenceVariable | |
| url | uri |
|
The uri that identifies the evidence variable |
EvidenceVariable.url |
|
version
|
token |
|
The business version of the evidence variable |
EvidenceVariable.version |
| ExampleScenario TU | ||||
| context | token |
|
A use context assigned to the example scenario |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the example scenario |
|
| context-type | token |
|
A type of use context assigned to the example scenario |
ExampleScenario.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the example scenario |
ExampleScenario.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the example scenario |
ExampleScenario.useContext |
| date | date |
|
The example scenario publication date |
ExampleScenario.date |
| identifier | token |
|
External identifier for the example scenario |
ExampleScenario.identifier |
| jurisdiction | token |
|
Intended jurisdiction for the example scenario |
ExampleScenario.jurisdiction |
| name | string |
|
Computationally friendly name of the example scenario |
ExampleScenario.name |
| publisher | string |
|
Name of the publisher of the example scenario |
ExampleScenario.publisher |
| status | token |
|
The current status of the example scenario |
ExampleScenario.status |
| url | uri |
|
The uri that identifies the example scenario |
ExampleScenario.url |
| version | token |
|
The business version of the example scenario |
ExampleScenario.version |
| ExplanationOfBenefit TU | ||||
| care-team | reference | ExplanationOfBenefit-care-team |
Member of the CareTeam |
ExplanationOfBenefit.careTeam.provider |
| claim | reference | ExplanationOfBenefit-claim |
The reference to the claim |
ExplanationOfBenefit.claim |
| coverage | reference | ExplanationOfBenefit-coverage |
The plan under which the claim was adjudicated |
ExplanationOfBenefit.insurance.coverage |
| created | date | ExplanationOfBenefit-created |
The creation date for the EOB |
ExplanationOfBenefit.created |
| detail-udi | reference | ExplanationOfBenefit-detail-udi |
UDI associated with a line item detail product or service |
ExplanationOfBenefit.item.detail.udi |
| disposition | string | ExplanationOfBenefit-disposition |
The contents of the disposition message |
ExplanationOfBenefit.disposition |
| encounter | reference |
|
Encounters associated with a billed line item |
ExplanationOfBenefit.item.encounter |
| enterer | reference | ExplanationOfBenefit-enterer |
The party responsible for the entry of the Claim |
ExplanationOfBenefit.enterer |
| facility | reference | ExplanationOfBenefit-facility |
Facility responsible for the goods and services |
ExplanationOfBenefit.facility |
| identifier | token |
|
The business identifier of the Explanation of Benefit |
ExplanationOfBenefit.identifier |
| item-udi | reference | ExplanationOfBenefit-item-udi |
UDI associated with a line item product or service |
ExplanationOfBenefit.item.udi |
| patient | reference |
|
The reference to the patient |
ExplanationOfBenefit.patient |
| payee | reference | ExplanationOfBenefit-payee |
The party receiving any payment for the Claim |
ExplanationOfBenefit.payee.party |
| procedure-udi | reference | ExplanationOfBenefit-procedure-udi |
UDI associated with a procedure |
ExplanationOfBenefit.procedure.udi |
| provider | reference | ExplanationOfBenefit-provider |
The reference to the provider |
ExplanationOfBenefit.provider |
| status | token | ExplanationOfBenefit-status |
Status of the instance |
ExplanationOfBenefit.status |
| subdetail-udi | reference | ExplanationOfBenefit-subdetail-udi |
UDI associated with a line item detail subdetail product or service |
ExplanationOfBenefit.item.detail.subDetail.udi |
| FamilyMemberHistory TU | ||||
| code | token | clinical-code |
A search by a condition code |
FamilyMemberHistory.condition.code |
| date | date | clinical-date |
When history was recorded or last updated |
FamilyMemberHistory.date |
| identifier | token | clinical-identifier |
A search by a record identifier |
FamilyMemberHistory.identifier |
| instantiates-canonical | reference | FamilyMemberHistory-instantiates-canonical |
Instantiates FHIR protocol or definition |
FamilyMemberHistory.instantiatesCanonical |
| instantiates-uri | uri | FamilyMemberHistory-instantiates-uri |
Instantiates external protocol or definition |
FamilyMemberHistory.instantiatesUri |
| patient | reference | clinical-patient |
The identity of a subject to list family member history items for |
FamilyMemberHistory.patient |
| relationship | token | FamilyMemberHistory-relationship |
A search by a relationship type |
FamilyMemberHistory.relationship |
| sex | token | FamilyMemberHistory-sex |
A search by a sex code of a family member |
FamilyMemberHistory.sex |
| status | token | FamilyMemberHistory-status |
partial | completed | entered-in-error | health-unknown |
FamilyMemberHistory.status |
| Flag TU | ||||
| author | reference | Flag-author |
Flag creator |
Flag.author |
| category | token | Flag-category | The category of the flag, such as clinical, administrative, etc. | Flag.category |
| date | date | clinical-date |
Time period when flag is active |
Flag.period |
| encounter | reference | clinical-encounter |
Alert relevant during encounter |
Flag.encounter |
| identifier | token |
|
Business identifier |
Flag.identifier |
| patient | reference | clinical-patient |
The identity of a subject to list flags for |
Flag.subject.where(resolve() is Patient) |
| status | token | Flag-status | active | inactive | entered-in-error | Flag.status |
| subject | reference | Flag-subject |
The identity of a subject to list flags for |
Flag.subject |
| FormularyItem TU | ||||
| code | token | FormularyItem-code | Returns formulary items for a specific code | FormularyItem.code |
| identifier | token | FormularyItem-identifier | Returns formulary items with this external identifier | FormularyItem.identifier |
| GenomicStudy TU | ||||
| focus | reference | GenomicStudy-focus | What the genomic study analysis is about, when it is not about the subject of record | GenomicStudy.analysis.focus |
| identifier | token | GenomicStudy-identifier | Identifiers for the Study | GenomicStudy.identifier |
| patient | reference | GenomicStudy-patient | Who the study is about | GenomicStudy.subject.where(resolve() is Patient) |
| status | token | GenomicStudy-status | The status of the study | GenomicStudy.status |
| subject | reference | GenomicStudy-subject | Who the study is about | GenomicStudy.subject |
| Goal TU | ||||
| achievement-status | token | Goal-achievement-status |
in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable |
Goal.achievementStatus |
| addresses | reference | Goal-addresses | Issues addressed by this goal | Goal.addresses |
| category | token | Goal-category |
E.g. Treatment, dietary, behavioral, etc. |
Goal.category |
| description | token | Goal-description | Code or text describing goal | Goal.description |
| identifier | token | clinical-identifier |
External Ids for this goal |
Goal.identifier |
| lifecycle-status | token | Goal-lifecycle-status |
proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected |
Goal.lifecycleStatus |
| patient | reference | clinical-patient |
Who this goal is intended for |
Goal.subject.where(resolve() is Patient) |
| start-date | date | Goal-start-date |
When goal pursuit begins |
|
| subject | reference | Goal-subject |
Who this goal is intended for |
Goal.subject |
| target-date | date | Goal-target-date |
Reach goal on or before |
|
| target-measure | token | Goal-target-measure | The parameter whose value is being tracked | Goal.target.measure |
| GraphDefinition TU | ||||
| context | token |
|
A use context assigned to the graph definition |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the graph definition |
|
| context-type | token |
|
A type of use context assigned to the graph definition |
GraphDefinition.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the graph definition |
GraphDefinition.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the graph definition |
GraphDefinition.useContext |
| date | date |
|
The graph definition publication date |
GraphDefinition.date |
| description | string |
|
The description of the graph definition |
GraphDefinition.description |
| identifier | token | CanonicalResource-identifier | External identifier for the graph definition | GraphDefinition.identifier |
| jurisdiction | token |
|
Intended jurisdiction for the graph definition |
GraphDefinition.jurisdiction |
| name | string |
|
Computationally friendly name of the graph definition |
GraphDefinition.name |
| publisher | string |
|
Name of the publisher of the graph definition |
GraphDefinition.publisher |
| start | token | GraphDefinition-start |
Type of resource at which the graph starts |
GraphDefinition.start |
| status | token |
|
The current status of the graph definition |
GraphDefinition.status |
| url | uri |
|
The uri that identifies the graph definition |
GraphDefinition.url |
| version | token |
|
The business version of the graph definition |
GraphDefinition.version |
| Group TU | ||||
|
|
token |
|
|
|
|
|
|
|
|
|
| characteristic-value | composite | Group-characteristic-value |
A composite of both characteristic and value |
Group.characteristic |
| code | token | Group-code |
The kind of resources contained |
Group.code |
| exclude | token | Group-exclude |
Group includes or excludes |
Group.characteristic.exclude |
| identifier | token | Group-identifier |
Unique id |
Group.identifier |
| managing-entity | reference | Group-managing-entity |
Entity that is the custodian of the Group's definition |
Group.managingEntity |
| member | reference | Group-member |
Reference to the group member |
Group.member.entity |
| membership | token | Group-membership | Definitional or enumerated group | Group.membership |
| name | string | Group-name | A portion of the Group's name | Group.name |
| type | token | Group-type |
The type of resources the group contains |
Group.type |
| value | token | Group-value |
Value held by characteristic |
|
| GuidanceResponse TU | ||||
| identifier | token |
|
The identifier of the guidance response |
GuidanceResponse.identifier |
| patient | reference |
|
The identity of a patient to search for guidance response results |
GuidanceResponse.subject.where(resolve() is Patient) |
| request | token | GuidanceResponse-request |
The identifier of the request associated with the response |
GuidanceResponse.requestIdentifier |
| status | token | GuidanceResponse-status | The status of the guidance response | GuidanceResponse.status |
| subject | reference | GuidanceResponse-subject |
The subject that the guidance response is about |
GuidanceResponse.subject |
| HealthcareService TU | ||||
| active | token | HealthcareService-active |
The Healthcare Service is currently marked as active |
HealthcareService.active |
| characteristic | token | HealthcareService-characteristic |
One of the HealthcareService's characteristics |
HealthcareService.characteristic |
| communication | token | HealthcareService-communication | Languages that are available at this service | HealthcareService.communication |
| coverage-area | reference | HealthcareService-coverage-area |
Location(s) service is intended for/available to |
HealthcareService.coverageArea |
| eligibility | token | HealthcareService-eligibility | One of the HealthcareService's eligibility requirements | HealthcareService.eligibility.code |
| endpoint | reference | HealthcareService-endpoint |
Technical endpoints providing access to electronic services operated for the healthcare service |
HealthcareService.endpoint |
| identifier | token | HealthcareService-identifier |
External identifiers for this item |
HealthcareService.identifier |
| location | reference | HealthcareService-location |
The location of the Healthcare Service |
HealthcareService.location |
| name | string | HealthcareService-name |
A portion of the Healthcare service name |
HealthcareService.name |
| offered-in | reference | HealthcareService-offered-in | The service within which this service is offered | HealthcareService.offeredIn |
| organization | reference | HealthcareService-organization |
The organization that provides this Healthcare Service |
HealthcareService.providedBy |
| program | token | HealthcareService-program |
One of the Programs supported by this HealthcareService |
HealthcareService.program |
| service-category | token | HealthcareService-service-category |
Service Category of the Healthcare Service |
HealthcareService.category |
| service-type | token | HealthcareService-service-type |
The type of service provided by this healthcare service |
HealthcareService.type |
| specialty | token | HealthcareService-specialty |
The specialty of the service provided by this healthcare service |
HealthcareService.specialty |
| ImagingSelection TU | ||||
| based-on | reference | ImagingSelection-based-on | The request associated with an imaging selection | ImagingSelection.basedOn |
| body-site | token | ImagingSelection-body-site | The body site code associated with the imaging selection | ImagingSelection.bodySite.concept |
| body-structure | reference | ImagingSelection-body-structure | The body structure associated with the imaging selection | ImagingSelection.bodySite.reference |
| code | token | clinical-code | The imaging selection status | ImagingSelection.status |
| derived-from | reference | ImagingSelection-derived-from | The imaging study from which the imaging selection was derived | ImagingSelection.derivedFrom |
| identifier | token | clinical-identifier | Identifiers for the imaging selection | ImagingSelection.identifier |
| issued | date | ImagingSelection-issued | The date / time the imaging selection was created | ImagingSelection.issued |
| patient | reference | clinical-patient | Who the study is about | ImagingSelection.subject.where(resolve() is Patient) |
| status | token | ImagingSelection-status | The status of the imaging selection | ImagingSelection.status |
| study-uid | token | ImagingSelection-study-uid | The DICOM Study Instance UID from which the images were selected | ImagingSelection.studyUid |
| subject | reference | ImagingSelection-subject | The subject of the Imaging Selection, such as the associated Patient | ImagingSelection.subject |
| ImagingStudy TU | ||||
|
|
reference |
|
The
order
for
the
|
ImagingStudy.basedOn |
|
|
token |
|
The body site code studied |
|
| body-structure | reference | ImagingStudy-body-structure | The body structure resource associated with the ImagingStudy | ImagingStudy.series.bodySite.reference |
| dicom-class | token | ImagingStudy-dicom-class |
The type of the instance |
ImagingStudy.series.instance.sopClass |
| encounter | reference |
|
The context of the study |
ImagingStudy.encounter |
| endpoint | reference | ImagingStudy-endpoint |
The endpoint for the study or series |
ImagingStudy.endpoint | ImagingStudy.series.endpoint |
| identifier | token | clinical-identifier |
Identifiers
for
the
Study,
such
as
DICOM
Study
Instance
UID
|
ImagingStudy.identifier |
| instance | token | ImagingStudy-instance |
SOP Instance UID for an instance |
ImagingStudy.series.instance.uid |
|
|
token | ImagingStudy-modality |
The modality of the series |
ImagingStudy.series.modality |
| patient | reference | clinical-patient |
Who the study is about |
ImagingStudy.subject.where(resolve() is Patient) |
| performer | reference | ImagingStudy-performer |
The person who performed the study |
ImagingStudy.series.performer.actor |
| reason | token | ImagingStudy-reason |
The reason for the study |
|
| referrer | reference | ImagingStudy-referrer |
The referring physician |
ImagingStudy.referrer |
| series | token | ImagingStudy-series |
DICOM Series Instance UID for a series |
ImagingStudy.series.uid |
| started | date | ImagingStudy-started |
When the study was started |
ImagingStudy.started |
| status | token | ImagingStudy-status |
The status of the study |
ImagingStudy.status |
| subject | reference | ImagingStudy-subject |
Who the study is about |
ImagingStudy.subject |
| Immunization TU | ||||
| date | date | clinical-date |
Vaccination (non)-Administration Date |
|
| identifier | token | clinical-identifier |
Business identifier |
Immunization.identifier |
| location | reference | Immunization-location |
The service delivery location or facility in which the vaccine was / was to be administered |
Immunization.location |
| lot-number | string | Immunization-lot-number |
Vaccine Lot Number |
Immunization.lotNumber |
| manufacturer | reference | Immunization-manufacturer |
Vaccine Manufacturer |
|
| patient | reference | clinical-patient |
The patient for the vaccination record |
Immunization.patient |
| performer | reference | Immunization-performer |
The
|
Immunization.performer.actor |
| reaction | reference | Immunization-reaction |
Additional information on reaction |
|
| reaction-date | date | Immunization-reaction-date |
When reaction started |
Immunization.reaction.date |
| reason-code | token | Immunization-reason-code |
Reason why the vaccine was administered |
|
| reason-reference | reference | Immunization-reason-reference |
|
|
| series | string | Immunization-series |
The series being followed by the provider |
Immunization.protocolApplied.series |
| status | token | Immunization-status |
Immunization event status |
Immunization.status |
| status-reason | token | Immunization-status-reason |
Reason why the vaccine was not administered |
Immunization.statusReason |
| target-disease | token | Immunization-target-disease |
The target disease the dose is being administered against |
Immunization.protocolApplied.targetDisease |
| vaccine-code | token | Immunization-vaccine-code |
Vaccine Product Administered |
Immunization.vaccineCode |
| ImmunizationEvaluation TU | ||||
| date | date |
|
Date the evaluation was generated |
ImmunizationEvaluation.date |
| dose-status | token | ImmunizationEvaluation-dose-status |
The status of the dose relative to published recommendations |
ImmunizationEvaluation.doseStatus |
| identifier | token |
|
ID of the evaluation |
ImmunizationEvaluation.identifier |
| immunization-event | reference | ImmunizationEvaluation-immunization-event |
The vaccine administration event being evaluated |
ImmunizationEvaluation.immunizationEvent |
| patient | reference |
|
The patient being evaluated |
ImmunizationEvaluation.patient |
| status | token | ImmunizationEvaluation-status |
Immunization evaluation status |
ImmunizationEvaluation.status |
| target-disease | token | ImmunizationEvaluation-target-disease |
The vaccine preventable disease being evaluated against |
ImmunizationEvaluation.targetDisease |
| ImmunizationRecommendation TU | ||||
| date | date |
|
Date recommendation(s) created |
ImmunizationRecommendation.date |
| identifier | token |
|
Business identifier |
ImmunizationRecommendation.identifier |
| information | reference | ImmunizationRecommendation-information |
Patient observations supporting recommendation |
ImmunizationRecommendation.recommendation.supportingPatientInformation |
| patient | reference |
|
Who this profile is for |
ImmunizationRecommendation.patient |
| status | token | ImmunizationRecommendation-status |
Vaccine recommendation status |
ImmunizationRecommendation.recommendation.forecastStatus |
| support | reference | ImmunizationRecommendation-support |
Past immunizations supporting recommendation |
ImmunizationRecommendation.recommendation.supportingImmunization |
| target-disease | token | ImmunizationRecommendation-target-disease |
Disease to be immunized against |
ImmunizationRecommendation.recommendation.targetDisease |
| vaccine-type | token | ImmunizationRecommendation-vaccine-type |
Vaccine or vaccine group recommendation applies to |
ImmunizationRecommendation.recommendation.vaccineCode |
| ImplementationGuide TU | ||||
| context | token |
|
A use context assigned to the implementation guide |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the implementation guide |
|
| context-type | token |
|
A type of use context assigned to the implementation guide |
ImplementationGuide.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the implementation guide |
ImplementationGuide.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the implementation guide |
ImplementationGuide.useContext |
| date | date |
|
The implementation guide publication date |
ImplementationGuide.date |
| depends-on | reference | ImplementationGuide-depends-on |
Identity of the IG that this depends on |
ImplementationGuide.dependsOn.uri |
| description | string |
|
The description of the implementation guide |
ImplementationGuide.description |
| experimental | token | ImplementationGuide-experimental |
For testing purposes, not real usage |
ImplementationGuide.experimental |
| global | reference | ImplementationGuide-global |
Profile that all resources must conform to |
ImplementationGuide.global.profile |
| identifier | token | CanonicalResource-identifier | External identifier for the implementation guide | ImplementationGuide.identifier |
| jurisdiction | token |
|
Intended jurisdiction for the implementation guide |
ImplementationGuide.jurisdiction |
| name | string |
|
Computationally friendly name of the implementation guide |
ImplementationGuide.name |
| publisher | string |
|
Name of the publisher of the implementation guide |
ImplementationGuide.publisher |
| resource | reference | ImplementationGuide-resource |
Location of the resource |
ImplementationGuide.definition.resource.reference |
| status | token |
|
The current status of the implementation guide |
ImplementationGuide.status |
| title | string |
|
The human-friendly name of the implementation guide |
ImplementationGuide.title |
| url | uri |
|
The uri that identifies the implementation guide |
ImplementationGuide.url |
| version | token |
|
The business version of the implementation guide |
ImplementationGuide.version |
| Ingredient TU | ||||
| for | reference | Ingredient-for |
The product which this ingredient is a constituent part of |
Ingredient.for |
| function | token | Ingredient-function |
A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent |
Ingredient.function |
| identifier | token | Ingredient-identifier |
An identifier or code by which the ingredient can be referenced |
Ingredient.identifier |
| manufacturer | reference | Ingredient-manufacturer |
The organization that manufactures this ingredient |
|
| role | token | Ingredient-role |
A classification of the ingredient identifying its purpose within the product, e.g. active, inactive |
Ingredient.role |
|
| token | Ingredient-status | The status of this ingredient. Enables tracking the life-cycle of the content | Ingredient.status |
| strength-concentration-quantity | quantity | Ingredient-strength-concentration-quantity | Ingredient concentration strength as quantity | Ingredient.substance.strength.concentration.ofType(Quantity) |
| strength-concentration-ratio | composite | Ingredient-strength-concentration-ratio | Ingredient concentration strength as ratio, numerator and denominator parameter pair | Ingredient.substance.strength.concentration.ofType(Ratio) |
| strength-presentation-quantity | quantity | Ingredient-strength-presentation-quantity | Ingredient presentation strength as quantity | Ingredient.substance.strength.presentation.ofType(Quantity) |
| strength-presentation-ratio | composite | Ingredient-strength-presentation-ratio | Ingredient presentation strength as ratio, numerator and denominator parameter pair | Ingredient.substance.strength.presentation.ofType(Ratio) |
| substance | reference | Ingredient-substance |
Reference to a resource (by instance) |
Ingredient.substance.code.reference |
|
substance-code
|
token | Ingredient-substance-code |
Reference to a concept (by class) |
Ingredient.substance.code.concept |
|
substance-definition
|
reference | Ingredient-substance-definition |
Reference to a resource (by instance) |
Ingredient.substance.code.reference |
| InsurancePlan TU | ||||
| address | string | InsurancePlan-address |
A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
InsurancePlan.contact.address |
| address-city | string | InsurancePlan-address-city |
A city specified in an address |
InsurancePlan.contact.address.city |
| address-country | string | InsurancePlan-address-country |
A country specified in an address |
InsurancePlan.contact.address.country |
| address-postalcode | string | InsurancePlan-address-postalcode |
A postal code specified in an address |
InsurancePlan.contact.address.postalCode |
| address-state | string | InsurancePlan-address-state |
A state specified in an address |
InsurancePlan.contact.address.state |
| address-use | token | InsurancePlan-address-use |
A use code specified in an address |
InsurancePlan.contact.address.use |
| administered-by | reference | InsurancePlan-administered-by |
Product administrator |
InsurancePlan.administeredBy |
| endpoint | reference | InsurancePlan-endpoint |
Technical endpoint |
InsurancePlan.endpoint |
| identifier | token | InsurancePlan-identifier |
Any identifier for the organization (not the accreditation issuer's identifier) |
InsurancePlan.identifier |
| name | string | InsurancePlan-name |
A portion of the organization's name or alias |
|
| owned-by | reference | InsurancePlan-owned-by |
An organization of which this organization forms a part |
InsurancePlan.ownedBy |
| phonetic | string | InsurancePlan-phonetic |
A portion of the organization's name using some kind of phonetic matching algorithm |
InsurancePlan.name |
| status | token | InsurancePlan-status |
Is the Organization record active |
InsurancePlan.status |
| type | token | InsurancePlan-type |
A code for the type of organization |
InsurancePlan.type |
| InventoryItem D | ||||
| code | token | InventoryItem-code | Search for products that match this code | InventoryItem.code |
| identifier | token | InventoryItem-identifier | The identifier of the item | InventoryItem.identifier |
| status | token | InventoryItem-status | The status of the item | InventoryItem.status |
| subject | reference | InventoryItem-subject | The identity of a patient for whom to list associations | InventoryItem.instance.subject |
| InventoryReport TU | ||||
| identifier | token | InventoryReport-identifier | Search by identifier | InventoryReport.identifier |
| item | token | InventoryReport-item | Search by items in inventory report | InventoryReport.inventoryListing.item.item.concept |
| item-reference | reference | InventoryReport-item-reference | Search by items in inventory report | InventoryReport.inventoryListing.item.item.reference |
| status | token | InventoryReport-status | Search by status | InventoryReport.status |
| Invoice TU | ||||
| account | reference | Invoice-account |
Account that is being balanced |
Invoice.account |
| date | date |
|
Invoice date / posting date |
Invoice.date |
| identifier | token |
|
Business Identifier for item |
Invoice.identifier |
| issuer | reference | Invoice-issuer |
Issuing Organization of Invoice |
Invoice.issuer |
| participant | reference | Invoice-participant |
Individual who was involved |
Invoice.participant.actor |
| participant-role | token | Invoice-participant-role |
Type of involvement in creation of this Invoice |
Invoice.participant.role |
| patient | reference |
|
Recipient(s) of goods and services |
Invoice.subject.where(resolve() is Patient) |
| recipient | reference | Invoice-recipient |
Recipient of this invoice |
Invoice.recipient |
| status | token | Invoice-status |
draft | issued | balanced | cancelled | entered-in-error |
Invoice.status |
| subject | reference | Invoice-subject |
Recipient(s) of goods and services |
Invoice.subject |
| totalgross | quantity | Invoice-totalgross |
Gross total of this Invoice |
Invoice.totalGross |
| totalnet | quantity | Invoice-totalnet |
Net total of this Invoice |
Invoice.totalNet |
| type | token |
|
Type of Invoice |
Invoice.type |
| Library TU | ||||
| composed-of | reference |
|
What resource is being referenced |
Library.relatedArtifact.where(type='composed-of').resource |
|
content-type
|
token | Library-content-type |
The type of content in the library (e.g. text/cql) |
Library.content.contentType |
| context | token |
|
A use context assigned to the library |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the library |
|
| context-type | token |
|
A type of use context assigned to the library |
Library.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the library |
Library.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the library |
Library.useContext |
|
date
|
date |
|
The library publication date |
Library.date |
| depends-on | reference |
|
What resource is being referenced |
Library.relatedArtifact.where(type='depends-on').resource |
| derived-from | reference |
|
What resource is being referenced |
Library.relatedArtifact.where(type='derived-from').resource |
|
description
|
string |
|
The description of the library |
Library.description |
| effective | date |
|
The time during which the library is intended to be in use |
Library.effectivePeriod |
| identifier | token |
|
External identifier for the library |
Library.identifier |
| jurisdiction | token |
|
Intended jurisdiction for the library |
Library.jurisdiction |
|
name
|
string |
|
Computationally friendly name of the library |
Library.name |
| predecessor | reference |
|
What resource is being referenced |
Library.relatedArtifact.where(type='predecessor').resource |
|
publisher
|
string |
|
Name of the publisher of the library |
Library.publisher |
|
status
|
token |
|
The current status of the library |
Library.status |
| successor | reference |
|
What resource is being referenced |
Library.relatedArtifact.where(type='successor').resource |
|
title
|
string |
|
The human-friendly name of the library |
Library.title |
| topic | token |
|
Topics associated with the module |
Library.topic |
| type | token | Library-type |
The type of the library (e.g. logic-library, model-definition, asset-collection, module-definition) |
Library.type |
|
url
|
uri |
|
The uri that identifies the library |
Library.url |
|
version
|
token |
|
The business version of the library |
Library.version |
| Linkage TU | ||||
| author | reference | Linkage-author |
Author of the Linkage |
Linkage.author |
| item | reference | Linkage-item |
Matches on any item in the Linkage |
Linkage.item.resource |
| source | reference | Linkage-source |
Matches on any item in the Linkage with a type of 'source' |
Linkage.item.resource |
| List TU | ||||
| code | token | clinical-code |
What the purpose of this list is |
List.code |
| date | date | clinical-date |
When the list was prepared |
List.date |
| empty-reason | token | List-empty-reason |
Why list is empty |
List.emptyReason |
| encounter | reference | clinical-encounter |
Context in which list created |
List.encounter |
| identifier | token | clinical-identifier |
Business identifier |
List.identifier |
| item | reference | List-item |
Actual entry |
List.entry.item |
| notes | string | List-notes |
The annotation - text content (as markdown) |
List.note.text |
| patient | reference | clinical-patient |
If all resources have the same subject |
List.subject.where(resolve() is Patient) |
| source | reference | List-source |
Who and/or what defined the list contents (aka Author) |
List.source |
| status | token | List-status |
current | retired | entered-in-error |
List.status |
| subject | reference | List-subject |
If all resources have the same subject |
List.subject |
| title | string | List-title |
Descriptive name for the list |
List.title |
| Location TU | ||||
| address | string | Location-address |
A (part of the) address of the location |
Location.address |
| address-city | string | Location-address-city |
A city specified in an address |
Location.address.city |
| address-country | string | Location-address-country |
A country specified in an address |
Location.address.country |
| address-postalcode | string | Location-address-postalcode |
A postal code specified in an address |
Location.address.postalCode |
| address-state | string | Location-address-state |
A state specified in an address |
Location.address.state |
| address-use | token | Location-address-use |
A use code specified in an address |
Location.address.use |
| characteristic | token | Location-characteristic | One of the Location's characteristics | Location.characteristic |
| contains | special | Location-contains | Select locations that contain the specified co-ordinates | Location.extension('http://hl7.org/fhir/StructureDefinition/location-boundary-geojson').value |
| endpoint | reference | Location-endpoint |
Technical endpoints providing access to services operated for the location |
Location.endpoint |
| identifier | token | Location-identifier |
An identifier for the location |
Location.identifier |
| name | string | Location-name |
A portion of the location's name or alias |
Location.name | Location.alias |
| near | special | Location-near |
Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes).
Servers
which
support
the
near
parameter
SHALL
support
the
unit
string
'km'
for
kilometers
and
SHOULD
support
'[mi_us]'
for
miles,
support
for
other
units
is
optional.
If
the
units
are
omitted,
then
kms
should
be
assumed.
If
the
distance
is
omitted,
then
the
server
can
use
its
own
discretion
as
to
what
distances
should
be
considered
near
(and
units
are
|
Location.position |
| operational-status | token | Location-operational-status |
Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping) |
Location.operationalStatus |
| organization | reference | Location-organization |
Searches for locations that are managed by the provided organization |
Location.managingOrganization |
| partof | reference | Location-partof |
A location of which this location is a part |
Location.partOf |
| status | token | Location-status |
Searches for locations with a specific kind of status |
Location.status |
| type | token | Location-type |
A code for the type of location |
Location.type |
| ManufacturedItemDefinition TU | ||||
| dose-form | token | ManufacturedItemDefinition-dose-form |
Dose form as manufactured and before any transformation into the pharmaceutical product |
ManufacturedItemDefinition.manufacturedDoseForm |
| identifier | token | ManufacturedItemDefinition-identifier |
Unique identifier |
ManufacturedItemDefinition.identifier |
|
ingredient
|
token | ManufacturedItemDefinition-ingredient |
An ingredient of this item |
ManufacturedItemDefinition.ingredient |
| name | token | ManufacturedItemDefinition-name | A descriptive name applied to this item | ManufacturedItemDefinition.name |
| status | token | ManufacturedItemDefinition-status | The status of this item. Enables tracking the life-cycle of the content. | ManufacturedItemDefinition.status |
| Measure TU | ||||
| composed-of | reference |
|
What resource is being referenced |
Measure.relatedArtifact.where(type='composed-of').resource |
| context | token |
|
A use context assigned to the measure |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the measure |
|
| context-type | token |
|
A type of use context assigned to the measure |
Measure.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the measure |
Measure.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the measure |
Measure.useContext |
|
date
|
date |
|
The measure publication date |
Measure.date |
| depends-on | reference |
|
What resource is being referenced |
Measure.relatedArtifact.where(type='depends-on').resource | Measure.library |
| derived-from | reference |
|
What resource is being referenced |
Measure.relatedArtifact.where(type='derived-from').resource |
|
description
|
string |
|
The description of the measure |
Measure.description |
| effective | date |
|
The time during which the measure is intended to be in use |
Measure.effectivePeriod |
| identifier | token |
|
External identifier for the measure |
Measure.identifier |
| jurisdiction | token |
|
Intended jurisdiction for the measure |
Measure.jurisdiction |
|
name
|
string |
|
Computationally friendly name of the measure |
Measure.name |
| predecessor | reference |
|
What resource is being referenced |
Measure.relatedArtifact.where(type='predecessor').resource |
|
publisher
|
string |
|
Name of the publisher of the measure |
Measure.publisher |
|
status
|
token |
|
The current status of the measure |
Measure.status |
| successor | reference |
|
What resource is being referenced |
Measure.relatedArtifact.where(type='successor').resource |
|
title
|
string |
|
The human-friendly name of the measure |
Measure.title |
| topic | token |
|
Topics associated with the measure |
Measure.topic |
|
url
|
uri |
|
The uri that identifies the measure |
Measure.url |
|
version
|
token |
|
The business version of the measure |
Measure.version |
| MeasureReport TU | ||||
|
date
|
date |
|
The date of the measure report |
MeasureReport.date |
| evaluated-resource | reference | MeasureReport-evaluated-resource |
An evaluated resource referenced by the measure report |
MeasureReport.evaluatedResource |
| identifier | token |
|
External identifier of the measure report to be returned |
MeasureReport.identifier |
|
| reference | MeasureReport-location | The location to return measure report results for | MeasureReport.location |
| measure | reference | MeasureReport-measure |
The measure to return measure report results for |
MeasureReport.measure |
| patient | reference |
|
The identity of a patient to search for individual measure report results for |
MeasureReport.subject.where(resolve() is Patient) |
| period | date | MeasureReport-period |
The period of the measure report |
MeasureReport.period |
| reporter | reference | MeasureReport-reporter |
The reporter to return measure report results for |
MeasureReport.reporter |
|
status
|
token | MeasureReport-status |
The status of the measure report |
MeasureReport.status |
| subject | reference | MeasureReport-subject |
The identity of a subject to search for individual measure report results for |
MeasureReport.subject |
|
|
||||
| code | token | clinical-code |
Returns medications for a specific code |
Medication.code |
| expiration-date | date | Medication-expiration-date |
Returns medications in a batch with this expiration date |
Medication.batch.expirationDate |
| form | token | Medication-form |
Returns medications for a specific dose form |
|
| identifier | token |
|
Returns medications with this external identifier |
Medication.identifier |
| ingredient | reference | Medication-ingredient |
Returns medications for this ingredient reference |
|
| ingredient-code | token | Medication-ingredient-code |
Returns medications for this ingredient code |
|
| lot-number | token | Medication-lot-number |
Returns medications in a batch with this lot number |
Medication.batch.lotNumber |
|
|
reference |
|
Returns
medications
made
or
sold
for
this
|
|
| serial-number | token | Medication-serial-number | Returns medications in a batch with this lot number | Medication.identifier |
| status | token | Medication-status |
Returns medications for this status |
Medication.status |
| MedicationAdministration TU | ||||
| code | token | clinical-code |
Return administrations of this medication code |
|
|
|
|
|
|
|
| device | reference | MedicationAdministration-device |
Return administrations with this administration device identity |
|
|
|
|
|
|
|
| identifier | token | clinical-identifier |
Return administrations with this external identifier |
MedicationAdministration.identifier |
| medication | reference | medications-medication |
Return
administrations
of
this
medication
|
|
| patient | reference | clinical-patient |
The identity of a patient to list administrations for |
MedicationAdministration.subject.where(resolve() is Patient) |
| performer | reference | MedicationAdministration-performer |
The identity of the individual who administered the medication |
|
|
|
token | MedicationAdministration-performer-device-code | The identity of the individual who administered the medication | MedicationAdministration.performer.actor.concept |
| reason-given | reference | MedicationAdministration-reason-given |
Reference to a resource (by instance) | MedicationAdministration.reason.reference |
| reason-given-code | token | MedicationAdministration-reason-given-code | Reasons for administering the medication |
|
| reason-not-given | token | MedicationAdministration-reason-not-given |
Reasons for not administering the medication |
MedicationAdministration.statusReason |
| request | reference | MedicationAdministration-request |
The identity of a request to list administrations from |
MedicationAdministration.request |
| status | token | medications-status |
MedicationAdministration event status (for example one of active/paused/completed/nullified) |
MedicationAdministration.status |
| subject | reference | MedicationAdministration-subject |
The identity of the individual or group to list administrations for |
MedicationAdministration.subject |
| MedicationDispense TU | ||||
| code | token | clinical-code |
Returns dispenses of this medicine code |
|
|
|
reference |
|
Returns
dispenses
|
|
|
|
reference |
|
Returns
dispenses
|
|
| identifier | token | clinical-identifier |
Returns dispenses with this external identifier |
MedicationDispense.identifier |
| location | reference | MedicationDispense-location | Returns dispense for a given location | MedicationDispense.location |
| medication | reference | medications-medication |
Returns dispenses of this medicine resource |
|
| patient | reference | clinical-patient |
The identity of a patient to list dispenses for |
MedicationDispense.subject.where(resolve() is Patient) |
| performer | reference | MedicationDispense-performer |
Returns dispenses performed by a specific individual |
MedicationDispense.performer.actor |
| prescription | reference | medications-prescription |
Multiple Resources:
|
MedicationDispense.authorizingPrescription |
| receiver | reference | MedicationDispense-receiver |
The identity of a receiver to list dispenses for |
MedicationDispense.receiver |
| recorded | date | MedicationDispense-recorded | Returns dispenses where dispensing activity began on this date | MedicationDispense.recorded |
| responsibleparty | reference | MedicationDispense-responsibleparty |
Returns dispenses with the specified responsible party |
MedicationDispense.substitution.responsibleParty |
| status | token | medications-status |
Returns dispenses with a specified dispense status |
MedicationDispense.status |
| subject | reference | MedicationDispense-subject |
The identity of a patient for whom to list dispenses |
MedicationDispense.subject |
| type | token |
|
Returns dispenses of a specific type |
MedicationDispense.type |
| whenhandedover | date | MedicationDispense-whenhandedover |
Returns dispenses handed over on this date |
MedicationDispense.whenHandedOver |
| whenprepared | date | MedicationDispense-whenprepared |
Returns dispenses prepared on this date |
MedicationDispense.whenPrepared |
| MedicationKnowledge TU | ||||
| classification | token | MedicationKnowledge-classification |
Specific category assigned to the medication |
MedicationKnowledge.medicineClassification.classification |
| classification-type | token | MedicationKnowledge-classification-type |
The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification) |
MedicationKnowledge.medicineClassification.type |
| code | token | MedicationKnowledge-code |
Code that identifies this medication |
MedicationKnowledge.code |
| doseform | token | MedicationKnowledge-doseform |
powder | tablets | capsule + |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| monitoring-program-name | token | MedicationKnowledge-monitoring-program-name |
Name of the reviewing program |
MedicationKnowledge.monitoringProgram.name |
| monitoring-program-type | token | MedicationKnowledge-monitoring-program-type |
Type of program under which the medication is monitored |
MedicationKnowledge.monitoringProgram.type |
| monograph | reference | MedicationKnowledge-monograph |
Associated documentation about the medication |
MedicationKnowledge.monograph.source |
| monograph-type | token | MedicationKnowledge-monograph-type |
The category of medication document |
MedicationKnowledge.monograph.type |
| packaging-cost | quantity | MedicationKnowledge-packaging-cost | The cost of the packaged medication, if the cost is Money | |
| packaging-cost-concept | token | MedicationKnowledge-packaging-cost-concept | The cost of the packaged medication, if the cost is a CodeableConcept | |
| product-type | token | MedicationKnowledge-product-type | Category of the medication or product | MedicationKnowledge.productType |
| source-cost | token | MedicationKnowledge-source-cost |
The source or owner for the price information |
MedicationKnowledge.cost.source |
| status | token |
|
active | inactive | entered-in-error |
MedicationKnowledge.status |
| MedicationRequest TU | ||||
| authoredon | date | MedicationRequest-authoredon |
Return prescriptions written on this date |
MedicationRequest.authoredOn |
| category | token | MedicationRequest-category |
Returns prescriptions with different categories |
MedicationRequest.category |
| code | token | clinical-code |
Return prescriptions of this medication code |
|
|
|
date |
|
|
MedicationRequest.dosageInstruction.timing.event | (MedicationRequest.dosageInstruction.timing.repeat.bounds.ofType(Period)) |
| encounter | reference | medications-encounter |
|
MedicationRequest.encounter |
| group-identifier | token | MedicationRequest-group-identifier | Composite request this is part of | MedicationRequest.groupIdentifier |
| identifier | token | clinical-identifier |
Return prescriptions with this external identifier |
MedicationRequest.identifier |
| intended-dispenser | reference | MedicationRequest-intended-dispenser |
Returns prescriptions intended to be dispensed by this Organization |
|
| intended-performer | reference | MedicationRequest-intended-performer |
Returns the intended performer of the administration of the medication request |
MedicationRequest.performer |
| intended-performertype | token | MedicationRequest-intended-performertype |
Returns requests for a specific type of performer |
MedicationRequest.performerType |
| intent | token | MedicationRequest-intent |
Returns prescriptions with different intents |
MedicationRequest.intent |
| medication | reference | medications-medication |
Return prescriptions for this medication reference |
|
| patient | reference | clinical-patient |
Returns prescriptions for a specific patient |
MedicationRequest.subject.where(resolve() is Patient) |
| priority | token | MedicationRequest-priority |
Returns prescriptions with different priorities |
MedicationRequest.priority |
| requester | reference | MedicationRequest-requester |
Returns prescriptions prescribed by this prescriber |
MedicationRequest.requester |
| status | token | medications-status |
Status of the prescription |
MedicationRequest.status |
| subject | reference | MedicationRequest-subject |
The identity of a patient to list orders for |
MedicationRequest.subject |
| MedicationStatement TU | ||||
|
|
token |
|
Returns
statements
|
|
|
|
token |
|
|
|
|
|
|
|
|
|
| effective | date | MedicationStatement-effective |
Date when patient was taking (or not taking) the medication |
|
|
|
|
|
|
|
|
|
|
|
Return
statements
|
|
|
|
reference |
|
|
|
| patient | reference | clinical-patient |
Returns statements for a specific patient. |
MedicationStatement.subject.where(resolve() is Patient) |
| source | reference | MedicationStatement-source |
Who or where the information in the statement came from |
MedicationStatement.informationSource |
| status | token | medications-status |
Return statements that match the given status |
MedicationStatement.status |
| subject | reference | MedicationStatement-subject |
The identity of a patient, animal or group to list statements for |
MedicationStatement.subject |
| MedicinalProductDefinition TU | ||||
| characteristic | token | MedicinalProductDefinition-characteristic |
Allows the key product features to be recorded, such as "sugar free", "modified release", "parallel import" |
|
| characteristic-type | token | MedicinalProductDefinition-characteristic-type |
A category for the characteristic |
MedicinalProductDefinition.characteristic.type |
| contact | reference | MedicinalProductDefinition-contact |
A product specific contact, person (in a role), or an organization |
MedicinalProductDefinition.contact.contact |
| domain | token | MedicinalProductDefinition-domain |
If this medicine applies to human or veterinary uses |
MedicinalProductDefinition.domain |
| identifier | token | MedicinalProductDefinition-identifier |
Business identifier for this product. Could be an MPID |
MedicinalProductDefinition.identifier |
|
ingredient
|
token | MedicinalProductDefinition-ingredient |
An ingredient of this product |
MedicinalProductDefinition.ingredient |
| master-file | reference | MedicinalProductDefinition-master-file |
A master file for to the medicinal product (e.g. Pharmacovigilance System Master File) |
MedicinalProductDefinition.masterFile |
|
name
|
string | MedicinalProductDefinition-name |
The full product name |
MedicinalProductDefinition.name.productName |
| name-language | token | MedicinalProductDefinition-name-language |
Language code for this name |
|
| product-classification | token | MedicinalProductDefinition-product-classification |
Allows the product to be classified by various systems |
MedicinalProductDefinition.classification |
| status | token | MedicinalProductDefinition-status |
The status within the lifecycle of this product record. A high-level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization status |
MedicinalProductDefinition.status |
| type | token | MedicinalProductDefinition-type |
Regulatory type, e.g. Investigational or Authorized |
MedicinalProductDefinition.type |
| MessageDefinition TU | ||||
| category | token | MessageDefinition-category |
The behavior associated with the message |
MessageDefinition.category |
| context | token |
|
A use context assigned to the message definition |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the message definition |
|
| context-type | token |
|
A type of use context assigned to the message definition |
MessageDefinition.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the message definition |
MessageDefinition.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the message definition |
MessageDefinition.useContext |
| date | date |
|
The message definition publication date |
MessageDefinition.date |
| description | string |
|
The description of the message definition |
MessageDefinition.description |
| event | token | MessageDefinition-event |
The event that triggers the message or link to the event definition. |
|
| focus | token | MessageDefinition-focus |
A resource that is a permitted focus of the message |
MessageDefinition.focus.code |
| identifier | token |
|
External identifier for the message definition |
MessageDefinition.identifier |
| jurisdiction | token |
|
Intended jurisdiction for the message definition |
MessageDefinition.jurisdiction |
| name | string |
|
Computationally friendly name of the message definition |
MessageDefinition.name |
| parent | reference | MessageDefinition-parent |
A resource that is the parent of the definition |
MessageDefinition.parent |
| publisher | string |
|
Name of the publisher of the message definition |
MessageDefinition.publisher |
| status | token |
|
The current status of the message definition |
MessageDefinition.status |
| title | string |
|
The human-friendly name of the message definition |
MessageDefinition.title |
| url | uri |
|
The uri that identifies the message definition |
MessageDefinition.url |
| version | token |
|
The business version of the message definition |
MessageDefinition.version |
| MessageHeader TU | ||||
| author | reference | MessageHeader-author |
The source of the decision |
MessageHeader.author |
| code | token | MessageHeader-code |
ok | transient-error | fatal-error |
MessageHeader.response.code |
| destination | string | MessageHeader-destination |
Name of system |
MessageHeader.destination.name |
|
|
token | MessageHeader-event |
Code for the event this message represents or link to event definition |
|
| focus | reference | MessageHeader-focus |
The actual content of the message |
MessageHeader.focus |
| receiver | reference | MessageHeader-receiver |
Intended "real-world" recipient for the data |
MessageHeader.destination.receiver |
| response-id | token | MessageHeader-response-id |
Id of original message |
MessageHeader.response.identifier |
| responsible | reference | MessageHeader-responsible |
Final responsibility for event |
MessageHeader.responsible |
| sender | reference | MessageHeader-sender |
Real world sender of the message |
MessageHeader.sender |
| source | string | MessageHeader-source |
Name of system |
MessageHeader.source.name |
|
|
reference | MessageHeader-target |
Particular delivery destination within the destination |
MessageHeader.destination.target |
| MolecularSequence TU | ||||
|
|
|
|
|
|
| identifier | token |
|
The unique identity for a particular sequence |
MolecularSequence.identifier |
| patient | reference |
|
The
subject
that
the
|
|
|
|
|
|
|
|
| type | token |
|
Amino Acid Sequence/ DNA Sequence / RNA Sequence |
MolecularSequence.type |
| NamingSystem TU | ||||
| contact | string | NamingSystem-contact |
Name of an individual to contact |
NamingSystem.contact.name |
| context | token |
|
A use context assigned to the naming system |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the naming system |
|
| context-type | token |
|
A type of use context assigned to the naming system |
NamingSystem.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the naming system |
NamingSystem.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the naming system |
NamingSystem.useContext |
| date | date |
|
The naming system publication date |
NamingSystem.date |
| derived-from | reference | MetadataResource-derived-from | A resource that the NamingSystem is derived from | NamingSystem.relatedArtifact.where(type='derived-from').resource |
| description | string |
|
The description of the naming system |
NamingSystem.description |
| effective | date | MetadataResource-effective | The time during which the NamingSystem is intended to be in use | NamingSystem.effectivePeriod |
| id-type | token | NamingSystem-id-type |
oid | uuid | uri | other |
NamingSystem.uniqueId.type |
| identifier | token | CanonicalResource-identifier | External identifier for the naming system | NamingSystem.identifier |
| jurisdiction | token |
|
Intended jurisdiction for the naming system |
NamingSystem.jurisdiction |
| kind | token | NamingSystem-kind |
codesystem | identifier | root |
NamingSystem.kind |
| name | string |
|
Computationally friendly name of the naming system |
NamingSystem.name |
| period | date | NamingSystem-period |
When is identifier valid? |
NamingSystem.uniqueId.period |
| predecessor | reference | MetadataResource-predecessor | The predecessor of the NamingSystem | NamingSystem.relatedArtifact.where(type='predecessor').resource |
| publisher | string |
|
Name of the publisher of the naming system |
NamingSystem.publisher |
| responsible | string | NamingSystem-responsible |
Who maintains system namespace? |
NamingSystem.responsible |
| status | token |
|
The current status of the naming system |
NamingSystem.status |
| telecom | token | NamingSystem-telecom |
Contact details for individual or organization |
NamingSystem.contact.telecom |
| topic | token | MetadataResource-topic | Topics associated with the NamingSystem | NamingSystem.topic |
| type | token | NamingSystem-type |
e.g. driver, provider, patient, bank etc. |
NamingSystem.type |
| url | uri | CanonicalResource-url | The uri that identifies the naming system | NamingSystem.url |
| value | string | NamingSystem-value |
The unique identifier |
NamingSystem.uniqueId.value |
| version | token | CanonicalResource-version | The business version of the naming system | NamingSystem.version |
| NutritionIntake TU | ||||
| code | token | clinical-code | Returns statements of this code of NutritionIntake | NutritionIntake.code |
| date | date | clinical-date | Date when patient was taking (or not taking) the medication | NutritionIntake.occurrence.ofType(dateTime) | NutritionIntake.occurrence.ofType(Period) |
| encounter | reference | clinical-encounter | Returns statements for a specific encounter | NutritionIntake.encounter |
| identifier | token | clinical-identifier | Return statements with this external identifier | NutritionIntake.identifier |
| nutrition | token | NutritionIntake-nutrition | Return intakes for a specific consumed item | NutritionIntake.consumedItem.nutritionProduct.concept |
| patient | reference | clinical-patient | Returns statements for a specific patient. | NutritionIntake.subject.where(resolve() is Patient) |
| source | reference | NutritionIntake-source | Who or where the information in the statement came from | (NutritionIntake.reported as Reference) |
| status | token | NutritionIntake-status | Return statements that match the given status | NutritionIntake.status |
| subject | reference | NutritionIntake-subject | The identity of a patient, animal or group to list statements for | NutritionIntake.subject |
| NutritionOrder TU | ||||
| additive | token | NutritionOrder-additive |
Type of module component to add to the feeding |
|
| datetime | date | NutritionOrder-datetime |
Return nutrition orders requested on this date |
NutritionOrder.dateTime |
| encounter | reference | clinical-encounter |
Return nutrition orders with this encounter identifier |
NutritionOrder.encounter |
| formula | token | NutritionOrder-formula |
Type of enteral or infant formula |
|
|
|
token |
|
|
|
|
|
|
|
|
|
| oraldiet | token | NutritionOrder-oraldiet |
Type of diet that can be consumed orally (i.e., take via the mouth). |
NutritionOrder.oralDiet.type |
| patient | reference | clinical-patient |
The
identity
of
the
|
|
| provider | reference | NutritionOrder-provider |
The identity of the provider who placed the nutrition order |
NutritionOrder.orderer |
| status | token | NutritionOrder-status |
Status of the nutrition order. |
NutritionOrder.status |
| subject | reference | NutritionOrder-subject | The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement | NutritionOrder.subject |
| supplement | token | NutritionOrder-supplement |
Type of supplement product requested |
|
| NutritionProduct TU | ||||
| code | token | NutritionProduct-code | The code identifying a specific nutrition product | NutritionProduct.code |
| identifier | token | NutritionProduct-identifier |
The identifier for the physical instance, typically a serial number |
NutritionProduct.instance.identifier |
|
| token | NutritionProduct-lot-number | The lot number | NutritionProduct.instance.lotNumber |
| serial-number | token | NutritionProduct-serial-number | The serial number | NutritionProduct.instance.identifier |
| status | token | NutritionProduct-status |
|
|
| Observation N | ||||
|
based-on
|
reference | Observation-based-on |
Reference to the service request. |
Observation.basedOn |
|
category
|
token | Observation-category |
The classification of the type of observation |
Observation.category |
| code TU | token | clinical-code |
The code of the observation type |
Observation.code |
|
code-value-concept
|
composite | Observation-code-value-concept |
Code and coded value parameter pair |
Observation |
|
code-value-date
|
composite | Observation-code-value-date |
Code and date/time value parameter pair |
Observation |
|
code-value-quantity
|
composite | Observation-code-value-quantity |
Code and quantity value parameter pair |
Observation |
|
code-value-string
|
composite | Observation-code-value-string |
Code and string value parameter pair |
Observation |
|
combo-code
|
token | Observation-combo-code |
The code of the observation type or component type |
Observation.code | Observation.component.code |
|
combo-code-value-concept
|
composite | Observation-combo-code-value-concept |
Code and coded value parameter pair, including in components |
Observation | Observation.component |
|
combo-code-value-quantity
|
composite | Observation-combo-code-value-quantity |
Code and quantity value parameter pair, including in components |
Observation | Observation.component |
|
combo-data-absent-reason
|
token | Observation-combo-data-absent-reason |
The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing. |
Observation.dataAbsentReason | Observation.component.dataAbsentReason |
|
combo-value-concept
|
token | Observation-combo-value-concept |
The value or component value of the observation, if the value is a CodeableConcept |
|
|
combo-value-quantity
|
quantity | Observation-combo-value-quantity |
The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
|
|
component-code
|
token | Observation-component-code |
The component code of the observation type |
Observation.component.code |
|
component-code-value-concept
|
composite | Observation-component-code-value-concept |
Component code and component coded value parameter pair |
Observation.component |
|
component-code-value-quantity
|
composite | Observation-component-code-value-quantity |
Component code and component quantity value parameter pair |
Observation.component |
|
component-data-absent-reason
|
token | Observation-component-data-absent-reason |
The reason why the expected value in the element Observation.component.value[x] is missing. |
Observation.component.dataAbsentReason |
|
| uri | Observation-component-value-canonical | URL contained in valueCanonical. | Observation.component.value.ofType(canonical) |
| component-value-concept | token | Observation-component-value-concept |
The value of the component observation, if the value is a CodeableConcept |
|
|
component-value-quantity
|
quantity | Observation-component-value-quantity |
The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
|
|
| reference | Observation-component-value-reference | Reference contained in valueReference. | Observation.component.value.ofType(Reference) |
| data-absent-reason | token | Observation-data-absent-reason |
The reason why the expected value in the element Observation.value[x] is missing. |
Observation.dataAbsentReason |
| date TU | date | clinical-date |
Obtained date/time. If the obtained element is a period, a date that falls in the period |
|
|
derived-from
|
reference | Observation-derived-from |
Related measurements the observation is made from |
Observation.derivedFrom |
|
device
|
reference | Observation-device |
The Device that generated the observation data. |
Observation.device |
| encounter TU | reference | clinical-encounter |
Encounter related to the observation |
Observation.encounter |
| focus TU | reference | Observation-focus |
The focus of an observation when the focus is not the patient of record. |
Observation.focus |
|
has-member
|
reference | Observation-has-member |
Related resource that belongs to the Observation group |
Observation.hasMember |
| identifier TU | token | clinical-identifier |
The unique id for a particular observation |
Observation.identifier |
|
method
|
token | Observation-method |
The method used for the observation |
Observation.method |
|
part-of
|
reference | Observation-part-of |
Part of referenced event |
Observation.partOf |
| patient TU | reference | clinical-patient |
The subject that the observation is about (if patient) |
Observation.subject.where(resolve() is Patient) |
|
performer
|
reference | Observation-performer |
Who performed the observation |
Observation.performer |
|
specimen
|
reference | Observation-specimen |
Specimen used for this observation |
Observation.specimen |
|
status
|
token | Observation-status |
The status of the observation |
Observation.status |
|
subject
|
reference | Observation-subject |
The subject that the observation is about |
Observation.subject |
|
| uri | Observation-value-canonical | URL contained in valueCanonical. | Observation.value.ofType(canonical) |
| value-concept | token | Observation-value-concept |
The value of the observation, if the value is a CodeableConcept |
|
|
value-date
|
date | Observation-value-date |
The value of the observation, if the value is a date or period of time |
|
|
| string | Observation-value-markdown | The value of the observation, if the value is a string, and also searches in CodeableConcept.text | Observation.value.ofType(markdown) | Observation.value.ofType(CodeableConcept).text |
| value-quantity | quantity | Observation-value-quantity |
The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
|
|
| reference | Observation-value-reference | Reference contained in valueReference. | Observation.value.ofType(Reference) |
| ObservationDefinition TU | ||||
| category | token | ObservationDefinition-category | Category (class) of observation | ObservationDefinition.category |
| code | token | ObservationDefinition-code | Observation code | ObservationDefinition.code |
| experimental | token | ObservationDefinition-experimental | Not for genuine usage (true) | ObservationDefinition.experimental |
| identifier | token | CanonicalResource-identifier | The unique identifier associated with the specimen definition | ObservationDefinition.identifier |
| method | token | ObservationDefinition-method | Method of observation | ObservationDefinition.method |
| status | token | CanonicalResource-status | Publication status of the ObservationDefinition: draft, active, retired, unknown | ObservationDefinition.status |
| title | string |
|
| ObservationDefinition.title |
| url | uri | CanonicalResource-url |
The
uri
that
identifies
the
|
|
| OperationDefinition N | ||||
|
base
|
reference | OperationDefinition-base |
Marks this as a profile of the base |
OperationDefinition.base |
|
code
|
token | OperationDefinition-code |
Name used to invoke the operation |
OperationDefinition.code |
| context TU | token |
|
A use context assigned to the operation definition |
|
| context-quantity TU | quantity |
|
A quantity- or range-valued use context assigned to the operation definition |
|
| context-type TU | token |
|
A type of use context assigned to the operation definition |
OperationDefinition.useContext.code |
| context-type-quantity TU | composite |
|
A use context type and quantity- or range-based value assigned to the operation definition |
OperationDefinition.useContext |
| context-type-value TU | composite |
|
A use context type and value assigned to the operation definition |
OperationDefinition.useContext |
| date TU | date |
|
The operation definition publication date |
OperationDefinition.date |
| description TU | string |
|
The description of the operation definition |
OperationDefinition.description |
|
|
token | CanonicalResource-identifier | External identifier for the search parameter | OperationDefinition.identifier |
| input-profile | reference | OperationDefinition-input-profile |
Validation information for in parameters |
OperationDefinition.inputProfile |
|
instance
|
token | OperationDefinition-instance |
Invoke on an instance? |
OperationDefinition.instance |
| jurisdiction TU | token |
|
Intended jurisdiction for the operation definition |
OperationDefinition.jurisdiction |
|
kind
|
token | OperationDefinition-kind |
operation | query |
OperationDefinition.kind |
| name TU | string |
|
Computationally friendly name of the operation definition |
OperationDefinition.name |
|
output-profile
|
reference | OperationDefinition-output-profile |
Validation information for out parameters |
OperationDefinition.outputProfile |
| publisher TU | string |
|
Name of the publisher of the operation definition |
OperationDefinition.publisher |
| status TU | token |
|
The current status of the operation definition |
OperationDefinition.status |
|
system
|
token | OperationDefinition-system |
Invoke at the system level? |
OperationDefinition.system |
| title TU | string |
|
The human-friendly name of the operation definition |
OperationDefinition.title |
|
type
|
token | OperationDefinition-type |
Invoke at the type level? |
OperationDefinition.type |
| url TU | uri |
|
The uri that identifies the operation definition |
OperationDefinition.url |
| version TU | token |
|
The business version of the operation definition |
OperationDefinition.version |
| Organization TU | ||||
| active | token | Organization-active |
Is the Organization record active |
Organization.active |
| address | string | Organization-address |
A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
|
| address-city | string | Organization-address-city |
A city specified in an address |
|
| address-country | string | Organization-address-country |
A country specified in an address |
|
| address-postalcode | string | Organization-address-postalcode |
A postal code specified in an address |
|
| address-state | string | Organization-address-state |
A state specified in an address |
|
| address-use | token | Organization-address-use |
A use code specified in an address |
|
| endpoint | reference | Organization-endpoint |
Technical endpoints providing access to services operated for the organization |
Organization.endpoint |
| identifier | token | Organization-identifier |
Any identifier for the organization (not the accreditation issuer's identifier) |
Organization.identifier | Organization.qualification.identifier |
| name | string | Organization-name |
A portion of the organization's name or alias |
Organization.name | Organization.alias |
| partof | reference | Organization-partof |
An organization of which this organization forms a part |
Organization.partOf |
| phonetic | string | Organization-phonetic |
A portion of the organization's name using some kind of phonetic matching algorithm |
Organization.name |
| type | token | Organization-type |
A code for the type of organization |
Organization.type |
| OrganizationAffiliation TU | ||||
| active | token | OrganizationAffiliation-active |
Whether this organization affiliation record is in active use |
OrganizationAffiliation.active |
| date | date | OrganizationAffiliation-date |
The period during which the participatingOrganization is affiliated with the primary organization |
OrganizationAffiliation.period |
| token | OrganizationAffiliation-email |
A value in an email contact |
|
|
| endpoint | reference | OrganizationAffiliation-endpoint |
Technical endpoints providing access to services operated for this role |
OrganizationAffiliation.endpoint |
| identifier | token | OrganizationAffiliation-identifier |
An organization affiliation's Identifier |
OrganizationAffiliation.identifier |
| location | reference | OrganizationAffiliation-location |
The location(s) at which the role occurs |
OrganizationAffiliation.location |
| network | reference | OrganizationAffiliation-network |
Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) |
OrganizationAffiliation.network |
| participating-organization | reference | OrganizationAffiliation-participating-organization |
The organization that provides services to the primary organization |
OrganizationAffiliation.participatingOrganization |
| phone | token | OrganizationAffiliation-phone |
A value in a phone contact |
|
| primary-organization | reference | OrganizationAffiliation-primary-organization |
The organization that receives the services from the participating organization |
OrganizationAffiliation.organization |
| role | token | OrganizationAffiliation-role |
Definition of the role the participatingOrganization plays |
OrganizationAffiliation.code |
| service | reference | OrganizationAffiliation-service |
Healthcare services provided through the role |
OrganizationAffiliation.healthcareService |
| specialty | token | OrganizationAffiliation-specialty |
Specific specialty of the participatingOrganization in the context of the role |
OrganizationAffiliation.specialty |
| telecom | token | OrganizationAffiliation-telecom |
The value in any kind of contact |
|
| PackagedProductDefinition TU | ||||
|
biological
|
reference | PackagedProductDefinition-biological |
A biologically derived product within this packaged product |
|
|
contained-item
|
reference | PackagedProductDefinition-contained-item |
Any of the contained items within this packaged product |
|
|
device
|
reference | PackagedProductDefinition-device |
A device within this packaged product |
|
| identifier | token | PackagedProductDefinition-identifier |
Unique identifier |
PackagedProductDefinition.identifier |
|
manufactured-item
|
reference | PackagedProductDefinition-manufactured-item |
A manufactured item of medication within this packaged product |
|
|
medication
|
reference | PackagedProductDefinition-medication |
A manufactured item of medication within this packaged product |
|
|
name
|
token | PackagedProductDefinition-name |
A
name
for
this
package.
Typically
what
it
would
be
listed
as
in
a
drug
formulary
or
catalogue,
inventory
|
PackagedProductDefinition.name |
|
nutrition
|
reference | PackagedProductDefinition-nutrition |
A nutrition product within this packaged product |
|
|
package
|
reference | PackagedProductDefinition-package |
A complete packaged product within this packaged product |
|
| package-for | reference | PackagedProductDefinition-package-for |
The product that this is a pack for |
PackagedProductDefinition.packageFor |
| status | token | PackagedProductDefinition-status |
The status within the lifecycle of this item. A high level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization or marketing status |
PackagedProductDefinition.status |
| Patient N | ||||
|
active
|
token | Patient-active |
Whether the patient record is active |
Patient.active |
|
address
|
string | individual-address |
A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
Patient.address |
|
address-city
|
string | individual-address-city |
A city specified in an address |
Patient.address.city |
|
address-country
|
string | individual-address-country |
A country specified in an address |
Patient.address.country |
|
address-postalcode
|
string | individual-address-postalcode |
A postalCode specified in an address |
Patient.address.postalCode |
|
address-state
|
string | individual-address-state |
A state specified in an address |
Patient.address.state |
|
address-use
|
token | individual-address-use |
A use code specified in an address |
Patient.address.use |
|
birthdate
|
date | individual-birthdate |
The patient's date of birth |
Patient.birthDate |
|
death-date
|
date | Patient-death-date |
The date of death has been provided and satisfies this search value |
|
|
deceased
|
token | Patient-deceased |
This patient has been marked as deceased, or has a death date entered |
Patient.deceased.exists() and Patient.deceased != false |
|
email
|
token | individual-email |
A value in an email contact |
Patient.telecom.where(system='email') |
|
family
|
string | individual-family |
A portion of the family name of the patient |
Patient.name.family |
|
gender
|
token | individual-gender |
Gender of the patient |
Patient.gender |
|
general-practitioner
|
reference | Patient-general-practitioner |
Patient's nominated general practitioner, not the organization that manages the record |
Patient.generalPractitioner |
|
given
|
string | individual-given |
A portion of the given name of the patient |
Patient.name.given |
|
identifier
|
token | Patient-identifier |
A patient identifier |
Patient.identifier |
|
language
|
token | Patient-language |
Language code (irrespective of use value) |
Patient.communication.language |
|
link
|
reference | Patient-link |
All
|
Patient.link.other |
|
name
|
string | Patient-name |
A
server
defined
search
that
may
match
any
of
the
string
fields
in
the
HumanName,
including
family,
|
Patient.name |
|
organization
|
reference | Patient-organization |
The organization that is the custodian of the patient record |
Patient.managingOrganization |
|
phone
|
token | individual-phone |
A value in a phone contact |
Patient.telecom.where(system='phone') |
|
phonetic
|
string | individual-phonetic |
A portion of either family or given name using some kind of phonetic matching algorithm |
Patient.name |
|
telecom
|
token | individual-telecom |
The value in any kind of telecom details of the patient |
Patient.telecom |
| PaymentNotice TU | ||||
| created | date | PaymentNotice-created |
Creation
date
|
PaymentNotice.created |
| identifier | token | PaymentNotice-identifier |
The business identifier of the notice |
PaymentNotice.identifier |
| payment-status | token | PaymentNotice-payment-status |
The type of payment notice |
PaymentNotice.paymentStatus |
|
|
reference |
|
The
reference
to
the
|
|
| request | reference | PaymentNotice-request |
The Claim |
PaymentNotice.request |
| response | reference | PaymentNotice-response |
The ClaimResponse |
PaymentNotice.response |
| status | token | PaymentNotice-status |
The status of the payment notice |
PaymentNotice.status |
| PaymentReconciliation TU | ||||
| allocation-account | reference | PaymentReconciliation-allocation-account | The account to which payment or adjustment was applied. | PaymentReconciliation.allocation.account |
| allocation-encounter | reference | PaymentReconciliation-allocation-encounter | The encounter to which payment or adjustment was applied. | PaymentReconciliation.allocation.encounter |
| created | date | PaymentReconciliation-created |
The creation date |
PaymentReconciliation.created |
| disposition | string | PaymentReconciliation-disposition |
The contents of the disposition message |
PaymentReconciliation.disposition |
| identifier | token | PaymentReconciliation-identifier |
The business identifier of the ExplanationOfBenefit |
PaymentReconciliation.identifier |
| outcome | token | PaymentReconciliation-outcome |
The processing outcome |
PaymentReconciliation.outcome |
| payment-issuer | reference | PaymentReconciliation-payment-issuer |
The organization which generated this resource |
PaymentReconciliation.paymentIssuer |
| request | reference | PaymentReconciliation-request |
The reference to the claim |
PaymentReconciliation.request |
| requestor | reference | PaymentReconciliation-requestor |
The reference to the provider who submitted the claim |
PaymentReconciliation.requestor |
| status | token | PaymentReconciliation-status |
The status of the payment reconciliation |
PaymentReconciliation.status |
| Permission TU | ||||
| status | token | Permission-status | active | entered-in-error | draft | rejected | Permission.status |
| Person TU | ||||
| address N | string | individual-address |
A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
Person.address |
| address-city N | string | individual-address-city |
A city specified in an address |
Person.address.city |
| address-country N | string | individual-address-country |
A country specified in an address |
Person.address.country |
| address-postalcode N | string | individual-address-postalcode |
A postal code specified in an address |
Person.address.postalCode |
| address-state N | string | individual-address-state |
A state specified in an address |
Person.address.state |
| address-use N | token | individual-address-use |
A use code specified in an address |
Person.address.use |
| birthdate N | date | individual-birthdate |
The person's date of birth |
Person.birthDate |
| death-date | date | Person-death-date | The date of death has been provided and satisfies this search value | (Person.deceased.ofType(dateTime)) |
| deceased | token | Person-deceased | This person has been marked as deceased, or has a death date entered | Person.deceased.exists() and Person.deceased != false |
| email N | token | individual-email |
A value in an email contact |
Person.telecom.where(system='email') |
| family | string | Person-family | A portion of the family name of the person | Person.name.family |
| gender N | token | individual-gender |
The gender of the person |
Person.gender |
| given | string | Person-given | A portion of the given name of the person | Person.name.given |
| identifier | token |
|
A person Identifier |
Person.identifier |
| link | reference | Person-link |
Any link has this Patient, Person, RelatedPerson or Practitioner reference |
Person.link.target |
| name | string | Person-name |
A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
Person.name |
| organization | reference | Person-organization |
The organization at which this person record is being managed |
Person.managingOrganization |
| patient | reference |
|
The Person links to this Patient |
Person.link.target.where(resolve() is Patient) |
| phone N | token | individual-phone |
A value in a phone contact |
Person.telecom.where(system='phone') |
| phonetic N | string | individual-phonetic |
A portion of name using some kind of phonetic matching algorithm |
Person.name |
| practitioner | reference | Person-practitioner |
The Person links to this Practitioner |
Person.link.target.where(resolve() is Practitioner) |
| relatedperson | reference | Person-relatedperson |
The Person links to this RelatedPerson |
Person.link.target.where(resolve() is RelatedPerson) |
| telecom N | token | individual-telecom |
The value in any kind of contact |
Person.telecom |
| PlanDefinition TU | ||||
| composed-of | reference |
|
What resource is being referenced |
PlanDefinition.relatedArtifact.where(type='composed-of').resource |
| context | token |
|
A use context assigned to the plan definition |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the plan definition |
|
| context-type | token |
|
A type of use context assigned to the plan definition |
PlanDefinition.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the plan definition |
PlanDefinition.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the plan definition |
PlanDefinition.useContext |
|
date
|
date |
|
The plan definition publication date |
PlanDefinition.date |
| definition | reference | PlanDefinition-definition |
Activity or plan definitions used by plan definition |
|
| depends-on | reference |
|
What resource is being referenced |
PlanDefinition.relatedArtifact.where(type='depends-on').resource | PlanDefinition.library |
| derived-from | reference |
|
What resource is being referenced |
PlanDefinition.relatedArtifact.where(type='derived-from').resource |
|
description
|
string |
|
The description of the plan definition |
PlanDefinition.description |
| effective | date |
|
The time during which the plan definition is intended to be in use |
PlanDefinition.effectivePeriod |
| identifier | token |
|
External identifier for the plan definition |
PlanDefinition.identifier |
| jurisdiction | token |
|
Intended jurisdiction for the plan definition |
PlanDefinition.jurisdiction |
|
name
|
string |
|
Computationally friendly name of the plan definition |
PlanDefinition.name |
| predecessor | reference |
|
What resource is being referenced |
PlanDefinition.relatedArtifact.where(type='predecessor').resource |
|
publisher
|
string |
|
Name of the publisher of the plan definition |
PlanDefinition.publisher |
|
status
|
token |
|
The current status of the plan definition |
PlanDefinition.status |
| successor | reference |
|
What resource is being referenced |
PlanDefinition.relatedArtifact.where(type='successor').resource |
|
title
|
string |
|
The human-friendly name of the plan definition |
PlanDefinition.title |
| topic | token |
|
Topics associated with the module |
PlanDefinition.topic |
| type | token | PlanDefinition-type |
The type of artifact the plan (e.g. order-set, eca-rule, protocol) |
PlanDefinition.type |
|
url
|
uri |
|
The uri that identifies the plan definition |
PlanDefinition.url |
|
version
|
token |
|
The business version of the plan definition |
PlanDefinition.version |
| Practitioner TU | ||||
| active | token | Practitioner-active |
Whether the practitioner record is active |
Practitioner.active |
| address N | string | individual-address |
A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
Practitioner.address |
| address-city N | string | individual-address-city |
A city specified in an address |
Practitioner.address.city |
| address-country N | string | individual-address-country |
A country specified in an address |
Practitioner.address.country |
| address-postalcode N | string | individual-address-postalcode |
A postalCode specified in an address |
Practitioner.address.postalCode |
| address-state N | string | individual-address-state |
A state specified in an address |
Practitioner.address.state |
| address-use N | token | individual-address-use |
A use code specified in an address |
Practitioner.address.use |
| communication | token | Practitioner-communication |
|
|
| death-date | date | Practitioner-death-date | The date of death has been provided and satisfies this search value | (Practitioner.deceased.ofType(dateTime)) |
| deceased | token | Practitioner-deceased | This Practitioner has been marked as deceased, or has a death date entered | Practitioner.deceased.exists() and Practitioner.deceased != false |
| email N | token | individual-email |
A value in an email contact |
Practitioner.telecom.where(system='email') |
| family N | string | individual-family |
A portion of the family name |
Practitioner.name.family |
| gender N | token | individual-gender |
Gender of the practitioner |
Practitioner.gender |
| given N | string | individual-given |
A portion of the given name |
Practitioner.name.given |
| identifier | token | Practitioner-identifier |
A practitioner's Identifier |
Practitioner.identifier | Practitioner.qualification.identifier |
| name | string | Practitioner-name |
A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
Practitioner.name |
| phone N | token | individual-phone |
A value in a phone contact |
Practitioner.telecom.where(system='phone') |
| phonetic N | string | individual-phonetic |
A portion of either family or given name using some kind of phonetic matching algorithm |
Practitioner.name |
| qualification-period | date | Practitioner-qualification-period | The date(s) a qualification is valid for | Practitioner.qualification.period |
| telecom N | token | individual-telecom |
The value in any kind of contact |
Practitioner.telecom |
| PractitionerRole TU | ||||
| active | token | PractitionerRole-active |
Whether this practitioner role record is in active use |
PractitionerRole.active |
| characteristic | token | PractitionerRole-characteristic | One of the PractitionerRole's characteristics | PractitionerRole.characteristic |
| communication | token | PractitionerRole-communication | One of the languages that the practitioner can communicate with | PractitionerRole.communication |
| date | date | PractitionerRole-date |
The period during which the practitioner is authorized to perform in these role(s) |
PractitionerRole.period |
| email N | token | individual-email |
A value in an email contact |
|
| endpoint | reference | PractitionerRole-endpoint |
Technical endpoints providing access to services operated for the practitioner with this role |
PractitionerRole.endpoint |
| identifier | token | PractitionerRole-identifier |
A practitioner's Identifier |
PractitionerRole.identifier |
| location | reference | PractitionerRole-location |
One of the locations at which this practitioner provides care |
PractitionerRole.location |
| organization | reference | PractitionerRole-organization |
The identity of the organization the practitioner represents / acts on behalf of |
PractitionerRole.organization |
| phone N | token | individual-phone |
A value in a phone contact |
|
| practitioner | reference | PractitionerRole-practitioner |
Practitioner that is able to provide the defined services for the organization |
PractitionerRole.practitioner |
| role | token | PractitionerRole-role |
The practitioner can perform this role at for the organization |
PractitionerRole.code |
| service | reference | PractitionerRole-service |
The list of healthcare services that this worker provides for this role's Organization/Location(s) |
PractitionerRole.healthcareService |
| specialty | token | PractitionerRole-specialty |
The practitioner has this specialty at an organization |
PractitionerRole.specialty |
| telecom N | token | individual-telecom |
The value in any kind of contact |
|
| Procedure TU | ||||
| based-on | reference | Procedure-based-on |
A request for this procedure |
Procedure.basedOn |
| category | token | Procedure-category |
Classification of the procedure |
Procedure.category |
| code | token | clinical-code |
A code to identify a procedure |
Procedure.code |
| date | date | clinical-date |
When
the
procedure
|
|
| encounter | reference | clinical-encounter |
The
Encounter
during
which
this
Procedure
was
created
|
Procedure.encounter |
| identifier | token | clinical-identifier |
A unique identifier for a procedure |
Procedure.identifier |
| instantiates-canonical | reference | Procedure-instantiates-canonical |
Instantiates FHIR protocol or definition |
Procedure.instantiatesCanonical |
| instantiates-uri | uri | Procedure-instantiates-uri |
Instantiates external protocol or definition |
Procedure.instantiatesUri |
| location | reference | Procedure-location |
Where the procedure happened |
Procedure.location |
| part-of | reference | Procedure-part-of |
Part of referenced event |
Procedure.partOf |
| patient | reference | clinical-patient |
Search by subject - a patient |
Procedure.subject.where(resolve() is Patient) |
| performer | reference | Procedure-performer |
|
Procedure.performer.actor |
| reason-code | token | Procedure-reason-code |
|
|
| reason-reference | reference | Procedure-reason-reference |
| Procedure.reason.reference |
| report | reference | Procedure-report |
Any
report
resulting
from
the
procedure
|
|
| status | token | Procedure-status |
preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
Procedure.status |
| subject | reference | Procedure-subject |
Search by subject |
Procedure.subject |
| Provenance TU | ||||
| activity | token | Provenance-activity | Activity that occurred | Provenance.activity |
| agent | reference | Provenance-agent |
Who participated |
Provenance.agent.who |
| agent-role | token | Provenance-agent-role |
What the agents role was |
Provenance.agent.role |
| agent-type | token | Provenance-agent-type |
How the agent participated |
Provenance.agent.type |
| based-on | reference | Provenance-based-on | Reference to the service request. | Provenance.basedOn |
| encounter | reference | clinical-encounter | Encounter related to the Provenance | Provenance.encounter |
| entity | reference | Provenance-entity |
Identity of entity |
Provenance.entity.what |
| location | reference | Provenance-location |
Where the activity occurred, if relevant |
Provenance.location |
| patient | reference |
|
|
|
| recorded | date | Provenance-recorded |
When the activity was recorded / updated |
Provenance.recorded |
| signature-type | token | Provenance-signature-type |
Indication of the reason the entity signed the object(s) |
Provenance.signature.type |
| target | reference | Provenance-target |
Target Reference(s) (usually version specific) |
Provenance.target |
| when | date | Provenance-when |
When the activity occurred |
|
| Questionnaire TU | ||||
|
|
token |
|
A code that corresponds to one of its items in the questionnaire |
Questionnaire.code | Questionnaire.item.code |
| context | token |
|
A use context assigned to the questionnaire |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the questionnaire |
|
| context-type | token |
|
A type of use context assigned to the questionnaire |
Questionnaire.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the questionnaire |
Questionnaire.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the questionnaire |
Questionnaire.useContext |
| date | date |
|
The questionnaire publication date |
Questionnaire.date |
| definition | uri | Questionnaire-definition |
ElementDefinition - details for the item |
Questionnaire.item.definition |
| description | string |
|
The description of the questionnaire |
Questionnaire.description |
| effective | date |
|
The time during which the questionnaire is intended to be in use |
Questionnaire.effectivePeriod |
| identifier | token |
|
External identifier for the questionnaire |
Questionnaire.identifier |
| item-code | token | Questionnaire-item-code | A code that corresponds to one of the items in the questionnaire | Questionnaire.item.code |
| jurisdiction | token |
|
Intended jurisdiction for the questionnaire |
Questionnaire.jurisdiction |
| name | string |
|
Computationally friendly name of the questionnaire |
Questionnaire.name |
| publisher | string |
|
Name of the publisher of the questionnaire |
Questionnaire.publisher |
| questionnaire-code | token | Questionnaire-questionnaire-code | A code that matches one of the Questionnaire.code codings | Questionnaire.code |
| status | token |
|
The current status of the questionnaire |
Questionnaire.status |
| subject-type | token | Questionnaire-subject-type |
Resource that can be subject of QuestionnaireResponse |
Questionnaire.subjectType |
| title | string |
|
The human-friendly name of the questionnaire |
Questionnaire.title |
| url | uri |
|
The uri that identifies the questionnaire |
Questionnaire.url |
| version | token |
|
The business version of the questionnaire |
Questionnaire.version |
| QuestionnaireResponse TU | ||||
| author | reference | QuestionnaireResponse-author |
The author of the questionnaire response |
QuestionnaireResponse.author |
| authored | date | QuestionnaireResponse-authored |
When the questionnaire response was last changed |
QuestionnaireResponse.authored |
| based-on | reference | QuestionnaireResponse-based-on |
Plan/proposal/order fulfilled by this questionnaire response |
QuestionnaireResponse.basedOn |
| encounter | reference |
|
Encounter associated with the questionnaire response |
QuestionnaireResponse.encounter |
| identifier | token |
|
The unique identifier for the questionnaire response |
QuestionnaireResponse.identifier |
| item-subject | reference | QuestionnaireResponse-item-subject | Allows searching for QuestionnaireResponses by item value where the item has isSubject=true | QuestionnaireResponse.item.where(extension('http://hl7.org/fhir/StructureDefinition/questionnaireresponse-isSubject').exists()).answer.value.ofType(Reference) |
| part-of | reference | QuestionnaireResponse-part-of |
Procedure or observation this questionnaire response was performed as a part of |
QuestionnaireResponse.partOf |
| patient | reference |
|
The patient that is the subject of the questionnaire response |
QuestionnaireResponse.subject.where(resolve() is Patient) |
| questionnaire | reference | QuestionnaireResponse-questionnaire |
The questionnaire the answers are provided for |
QuestionnaireResponse.questionnaire |
| source | reference | QuestionnaireResponse-source |
The individual providing the information reflected in the questionnaire respose |
QuestionnaireResponse.source |
| status | token | QuestionnaireResponse-status |
The status of the questionnaire response |
QuestionnaireResponse.status |
| subject | reference | QuestionnaireResponse-subject |
The subject of the questionnaire response |
QuestionnaireResponse.subject |
| RegulatedAuthorization TU | ||||
| case | token | RegulatedAuthorization-case |
The case or procedure number |
RegulatedAuthorization.case.identifier |
| case-type | token | RegulatedAuthorization-case-type |
The defining type of case |
RegulatedAuthorization.case.type |
| holder | reference | RegulatedAuthorization-holder |
The organization that holds the granted authorization |
RegulatedAuthorization.holder |
| identifier | token | RegulatedAuthorization-identifier |
Business identifier for the authorization, typically assigned by the authorizing body |
RegulatedAuthorization.identifier |
| region | token | RegulatedAuthorization-region |
The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted |
RegulatedAuthorization.region |
| status | token | RegulatedAuthorization-status |
The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications |
RegulatedAuthorization.status |
| subject | reference | RegulatedAuthorization-subject |
The type of regulated product, treatment, facility or activity that is being authorized |
RegulatedAuthorization.subject |
| RelatedPerson TU | ||||
| active | token | RelatedPerson-active |
Indicates if the related person record is active |
RelatedPerson.active |
| address N | string | individual-address |
A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
RelatedPerson.address |
| address-city N | string | individual-address-city |
A city specified in an address |
RelatedPerson.address.city |
| address-country N | string | individual-address-country |
A country specified in an address |
RelatedPerson.address.country |
| address-postalcode N | string | individual-address-postalcode |
A postal code specified in an address |
RelatedPerson.address.postalCode |
| address-state N | string | individual-address-state |
A state specified in an address |
RelatedPerson.address.state |
| address-use N | token | individual-address-use |
A use code specified in an address |
RelatedPerson.address.use |
| birthdate N | date | individual-birthdate |
The Related Person's date of birth |
RelatedPerson.birthDate |
| email N | token | individual-email |
A value in an email contact |
RelatedPerson.telecom.where(system='email') |
| family | string | RelatedPerson-family | A portion of the family name of the related person | RelatedPerson.name.family |
| gender N | token | individual-gender |
Gender of the related person |
RelatedPerson.gender |
| given | string | RelatedPerson-given | A portion of the given name of the related person | RelatedPerson.name.given |
| identifier | token |
|
An Identifier of the RelatedPerson |
RelatedPerson.identifier |
| name | string | RelatedPerson-name |
A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
RelatedPerson.name |
| patient | reference |
|
The patient this related person is related to |
RelatedPerson.patient |
| phone N | token | individual-phone |
A value in a phone contact |
RelatedPerson.telecom.where(system='phone') |
| phonetic N | string | individual-phonetic |
A portion of name using some kind of phonetic matching algorithm |
RelatedPerson.name |
| relationship | token | RelatedPerson-relationship |
The relationship between the patient and the relatedperson |
RelatedPerson.relationship |
| telecom N | token | individual-telecom |
The value in any kind of contact |
RelatedPerson.telecom |
|
|
||||
| author | reference |
|
The
author
of
the
request
|
|
| authored | date |
|
The
date
the
request
|
|
| based-on | reference | RequestOrchestration-based-on | What this request fullfills. | RequestOrchestration.basedOn |
| code | token |
|
The
code
of
the
request
|
|
| encounter | reference |
|
The
encounter
the
request
|
|
| group-identifier | token |
|
The
group
identifier
for
the
request
|
|
| identifier | token |
|
External
identifiers
for
the
request
|
|
| instantiates-canonical | reference |
|
The
FHIR-based
definition
from
which
the
request
|
|
| instantiates-uri | uri |
|
The
external
definition
from
which
the
request
|
|
| intent | token |
|
The
intent
of
the
request
|
|
| participant | reference |
|
The
participant
in
the
requests
in
the
|
|
| patient | reference |
|
The
identity
of
a
patient
to
search
for
request
|
|
| priority | token |
|
The
priority
of
the
request
|
|
| status | token |
|
The
status
of
the
request
|
|
| subject | reference |
|
The
subject
that
the
request
|
|
|
|
||||
|
|
reference |
|
|
|
| context | token |
|
A
use
context
assigned
to
the
|
|
| context-quantity | quantity |
|
A
quantity-
or
range-valued
use
context
assigned
to
the
|
|
| context-type | token |
|
A
type
of
use
context
assigned
to
the
|
|
| context-type-quantity | composite |
|
A
use
context
type
and
quantity-
or
range-based
value
assigned
to
the
|
|
| context-type-value | composite |
|
A
use
context
type
and
value
assigned
to
the
|
|
| date | date |
|
The
|
|
| derived-from | reference |
|
|
|
| description | string |
|
The
description
of
the
|
|
| identifier | token |
|
External
identifier
for
the
|
|
| jurisdiction | token |
|
Intended
jurisdiction
for
the
|
|
| name | string |
|
Computationally
friendly
name
of
the
|
|
| publisher | string |
|
Name
of
the
publisher
of
the
|
|
| status | token |
|
The
current
status
of
the
|
|
| title | string |
|
The
human-friendly
name
of
the
|
|
| url | uri |
|
The
uri
that
identifies
the
|
|
| version | token |
|
The
business
version
of
the
|
|
|
|
||||
|
|
token |
|
|
|
|
|
token |
|
|
|
| date | date |
|
|
|
|
|
|
|
|
|
|
|
reference |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| identifier | token |
|
|
|
|
|
token |
|
|
|
| name | string |
|
|
|
|
|
string |
|
|
|
|
|
token |
|
The
|
|
|
|
reference |
|
|
|
|
|
token |
|
The
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
token |
|
Geographic
|
|
|
|
reference |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
token |
|
|
|
|
|
reference |
|
|
|
|
|
reference |
|
Who or what is part of study |
|
|
|
token |
|
candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn |
|
| RiskAssessment TU | ||||
| condition | reference | RiskAssessment-condition |
Condition assessed |
RiskAssessment.condition |
| date | date | clinical-date |
When was assessment made? |
|
| encounter | reference | clinical-encounter |
Where was assessment performed? |
RiskAssessment.encounter |
| identifier | token | clinical-identifier |
Unique identifier for the assessment |
RiskAssessment.identifier |
| method | token | RiskAssessment-method |
Evaluation mechanism |
RiskAssessment.method |
| patient | reference | clinical-patient |
Who/what does assessment apply to? |
RiskAssessment.subject.where(resolve() is Patient) |
| performer | reference | RiskAssessment-performer |
Who did assessment? |
RiskAssessment.performer |
| probability | number | RiskAssessment-probability |
Likelihood of specified outcome |
|
| risk | token | RiskAssessment-risk |
Likelihood of specified outcome as a qualitative value |
RiskAssessment.prediction.qualitativeRisk |
| subject | reference | RiskAssessment-subject |
Who/what does assessment apply to? |
RiskAssessment.subject |
| Schedule TU | ||||
| active | token | Schedule-active |
Is the schedule in active use |
Schedule.active |
| actor | reference | Schedule-actor |
The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for |
Schedule.actor |
| date | date | Schedule-date |
Search for Schedule resources that have a period that contains this date specified |
Schedule.planningHorizon |
| identifier | token | Schedule-identifier |
A Schedule Identifier |
Schedule.identifier |
| name | string | Schedule-name | A portion of the Schedule name | Schedule.name |
| service-category | token | Schedule-service-category |
High-level category |
Schedule.serviceCategory |
| service-type | token | Schedule-service-type |
The type (by coding) of appointments that can be booked into associated slot(s) |
|
| service-type-reference | reference | Schedule-service-type-reference | The type (by HealthcareService) of appointments that can be booked into associated slot(s) | Schedule.serviceType.reference |
| specialty | token | Schedule-specialty |
Type of specialty needed |
Schedule.specialty |
| SearchParameter TU | ||||
| base | token | SearchParameter-base |
The resource type(s) this search parameter applies to |
SearchParameter.base |
| code | token | SearchParameter-code |
Code used in URL |
SearchParameter.code |
| component | reference | SearchParameter-component |
Defines how the part works |
SearchParameter.component.definition |
| context | token |
|
A use context assigned to the search parameter |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the search parameter |
|
| context-type | token |
|
A type of use context assigned to the search parameter |
SearchParameter.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the search parameter |
SearchParameter.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the search parameter |
SearchParameter.useContext |
| date | date |
|
The search parameter publication date |
SearchParameter.date |
| derived-from | reference | SearchParameter-derived-from |
Original definition for the search parameter |
SearchParameter.derivedFrom |
| description | string |
|
The description of the search parameter |
SearchParameter.description |
| identifier | token | CanonicalResource-identifier | External identifier for the search parameter | SearchParameter.identifier |
| jurisdiction | token |
|
Intended jurisdiction for the search parameter |
SearchParameter.jurisdiction |
| name | string |
|
Computationally friendly name of the search parameter |
SearchParameter.name |
| publisher | string |
|
Name of the publisher of the search parameter |
SearchParameter.publisher |
| status | token |
|
The current status of the search parameter |
SearchParameter.status |
| target | token | SearchParameter-target |
Types of resource (if a resource reference) |
SearchParameter.target |
| type | token | SearchParameter-type |
number | date | string | token | reference | composite | quantity | uri | special |
SearchParameter.type |
| url | uri |
|
The uri that identifies the search parameter |
SearchParameter.url |
| version | token |
|
The business version of the search parameter |
SearchParameter.version |
| ServiceRequest TU | ||||
| authored | date | ServiceRequest-authored |
Date request signed |
ServiceRequest.authoredOn |
| based-on | reference | ServiceRequest-based-on |
What request fulfills |
ServiceRequest.basedOn |
| body-site | token | ServiceRequest-body-site |
Where procedure is going to be done |
ServiceRequest.bodySite |
| body-structure | reference | ServiceRequest-body-structure | Body structure Where procedure is going to be done | ServiceRequest.bodyStructure |
| category | token | ServiceRequest-category |
Classification of service |
ServiceRequest.category |
|
|
token |
|
What is being requested/ordered |
|
| code-reference | reference | ServiceRequest-code-reference | What is being requested/ordered | ServiceRequest.code.reference |
| encounter | reference | clinical-encounter |
An encounter in which this request is made |
ServiceRequest.encounter |
| identifier | token | clinical-identifier |
Identifiers assigned to this order |
ServiceRequest.identifier |
| instantiates-canonical | reference | ServiceRequest-instantiates-canonical |
Instantiates FHIR protocol or definition |
ServiceRequest.instantiatesCanonical |
| instantiates-uri | uri | ServiceRequest-instantiates-uri |
Instantiates external protocol or definition |
ServiceRequest.instantiatesUri |
| intent | token | ServiceRequest-intent |
proposal
|
plan
|
directive
|
order
|
ServiceRequest.intent |
| occurrence | date | ServiceRequest-occurrence |
When service should occur |
|
| patient | reference | clinical-patient |
Search by subject - a patient |
ServiceRequest.subject.where(resolve() is Patient) |
| performer | reference | ServiceRequest-performer |
Requested performer |
ServiceRequest.performer |
| performer-type | token | ServiceRequest-performer-type |
Performer role |
ServiceRequest.performerType |
| priority | token | ServiceRequest-priority |
routine | urgent | asap | stat |
ServiceRequest.priority |
| replaces | reference | ServiceRequest-replaces |
What request replaces |
ServiceRequest.replaces |
| requester | reference | ServiceRequest-requester |
Who/what is requesting service |
ServiceRequest.requester |
| requisition | token | ServiceRequest-requisition |
Composite Request ID |
ServiceRequest.requisition |
| specimen | reference | ServiceRequest-specimen |
Specimen to be tested |
ServiceRequest.specimen |
| status | token | ServiceRequest-status |
draft | active | on-hold | revoked | completed | entered-in-error | unknown |
ServiceRequest.status |
| subject | reference | ServiceRequest-subject |
Search by subject |
ServiceRequest.subject |
| Slot TU | ||||
| appointment-type | token | Slot-appointment-type |
The style of appointment or patient that may be booked in the slot (not service type) |
Slot.appointmentType |
| identifier | token | Slot-identifier |
A Slot Identifier |
Slot.identifier |
| schedule | reference | Slot-schedule |
The Schedule Resource that we are seeking a slot within |
Slot.schedule |
| service-category | token | Slot-service-category |
A broad categorization of the service that is to be performed during this appointment |
Slot.serviceCategory |
| service-type | token | Slot-service-type |
The type (by coding) of appointments that can be booked into the slot |
|
| service-type-reference | reference | Slot-service-type-reference | The type (by HealthcareService) of appointments that can be booked into the slot | Slot.serviceType.reference |
| specialty | token | Slot-specialty |
The specialty of a practitioner that would be required to perform the service requested in this appointment |
Slot.specialty |
| start | date | Slot-start |
Appointment date/time. |
Slot.start |
| status | token | Slot-status |
The free/busy status of the appointment |
Slot.status |
| Specimen TU | ||||
| accession | token | Specimen-accession |
The accession number associated with the specimen |
Specimen.accessionIdentifier |
| bodysite |
|
Specimen-bodysite |
|
|
| collected | date | Specimen-collected |
The date the specimen was collected |
|
| collector | reference | Specimen-collector |
Who collected the specimen |
Specimen.collection.collector |
|
|
|
|
The
|
|
|
|
token |
|
The
unique
identifier
associated
with
the
specimen
|
|
|
|
|
|
The
|
|
|
|
reference |
|
The
|
|
|
|
reference |
|
The
|
|
| status | token | Specimen-status |
available | unavailable | unsatisfactory | entered-in-error |
Specimen.status |
| subject | reference | Specimen-subject |
The subject of the specimen |
Specimen.subject |
| type | token |
|
The specimen type |
Specimen.type |
| SpecimenDefinition TU | ||||
| container | token | SpecimenDefinition-container |
The type of specimen conditioned in container expected by the lab |
SpecimenDefinition.typeTested.container.type |
| experimental | token | SpecimenDefinition-experimental | Not for genuine usage (true) | SpecimenDefinition.experimental |
| identifier | token |
|
The
unique
identifier
associated
with
the
|
SpecimenDefinition.identifier |
| is-derived | token | SpecimenDefinition-is-derived | Primary specimen (false) or derived specimen (true) | SpecimenDefinition.typeTested.isDerived |
| status | token | CanonicalResource-status | Publication status of the SpecimenDefinition: draft, active, retired, unknown | SpecimenDefinition.status |
| title | string | CanonicalResource-title | Human-friendly name of the SpecimenDefinition | SpecimenDefinition.title |
| type | token | SpecimenDefinition-type |
The type of collected specimen |
SpecimenDefinition.typeCollected |
| type-tested | token | SpecimenDefinition-type-tested | The type of specimen conditioned for testing | SpecimenDefinition.typeTested.type |
| url | uri | CanonicalResource-url | The uri that identifies the specimen definition | SpecimenDefinition.url |
| StructureDefinition N | ||||
|
abstract
|
token | StructureDefinition-abstract |
Whether the structure is abstract |
StructureDefinition.abstract |
|
base
|
reference | StructureDefinition-base |
Definition that this type is constrained/specialized from |
StructureDefinition.baseDefinition |
|
base-path
|
token | StructureDefinition-base-path |
Path that identifies the base element |
StructureDefinition.snapshot.element.base.path | StructureDefinition.differential.element.base.path |
| context TU | token |
|
A use context assigned to the structure definition |
|
| context-quantity TU | quantity |
|
A quantity- or range-valued use context assigned to the structure definition |
|
| context-type TU | token |
|
A type of use context assigned to the structure definition |
StructureDefinition.useContext.code |
| context-type-quantity TU | composite |
|
A use context type and quantity- or range-based value assigned to the structure definition |
StructureDefinition.useContext |
| context-type-value TU | composite |
|
A use context type and value assigned to the structure definition |
StructureDefinition.useContext |
| date TU | date |
|
The structure definition publication date |
StructureDefinition.date |
|
derivation
|
token | StructureDefinition-derivation |
specialization | constraint - How relates to base definition |
StructureDefinition.derivation |
| description TU | string |
|
The description of the structure definition |
StructureDefinition.description |
|
experimental
|
token | StructureDefinition-experimental |
For testing purposes, not real usage |
StructureDefinition.experimental |
|
ext-context
|
composite | StructureDefinition-ext-context | An extension context assigned to the structure definition | StructureDefinition.context |
| ext-context-expression | token |
|
| StructureDefinition.context.expression |
| ext-context-type | token | StructureDefinition-ext-context-type |
A
type
of
extension
context
assigned
to
the
|
StructureDefinition.context.type |
| identifier TU | token |
|
External identifier for the structure definition |
StructureDefinition.identifier |
| jurisdiction TU | token |
|
Intended jurisdiction for the structure definition |
StructureDefinition.jurisdiction |
|
keyword
|
token | StructureDefinition-keyword |
A code for the StructureDefinition |
StructureDefinition.keyword |
|
kind
|
token | StructureDefinition-kind |
primitive-type | complex-type | resource | logical |
StructureDefinition.kind |
| name TU | string |
|
Computationally friendly name of the structure definition |
StructureDefinition.name |
|
path
|
token | StructureDefinition-path |
A path that is constrained in the StructureDefinition |
StructureDefinition.snapshot.element.path | StructureDefinition.differential.element.path |
| publisher TU | string |
|
Name of the publisher of the structure definition |
StructureDefinition.publisher |
| status TU | token |
|
The current status of the structure definition |
StructureDefinition.status |
| title TU | string |
|
The human-friendly name of the structure definition |
StructureDefinition.title |
|
type
|
uri | StructureDefinition-type |
Type defined or constrained by this structure |
StructureDefinition.type |
| url TU | uri |
|
The uri that identifies the structure definition |
StructureDefinition.url |
|
valueset
|
reference | StructureDefinition-valueset |
A vocabulary binding reference |
StructureDefinition.snapshot.element.binding.valueSet |
| version TU | token |
|
The business version of the structure definition |
StructureDefinition.version |
| StructureMap TU | ||||
| context | token |
|
A use context assigned to the structure map |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the structure map |
|
| context-type | token |
|
A type of use context assigned to the structure map |
StructureMap.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the structure map |
StructureMap.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the structure map |
StructureMap.useContext |
| date | date |
|
The structure map publication date |
StructureMap.date |
| description | string |
|
The description of the structure map |
StructureMap.description |
| identifier | token |
|
External identifier for the structure map |
StructureMap.identifier |
| jurisdiction | token |
|
Intended jurisdiction for the structure map |
StructureMap.jurisdiction |
| name | string |
|
Computationally friendly name of the structure map |
StructureMap.name |
| publisher | string |
|
Name of the publisher of the structure map |
StructureMap.publisher |
| status | token |
|
The current status of the structure map |
StructureMap.status |
| title | string |
|
The human-friendly name of the structure map |
StructureMap.title |
| url | uri |
|
The uri that identifies the structure map |
StructureMap.url |
| version | token |
|
The business version of the structure map |
StructureMap.version |
| Subscription TU | ||||
| contact | token | Subscription-contact |
Contact details for the subscription |
Subscription.contact |
|
| token | Subscription-content-level | Content level included in notifications | Subscription.content |
| filter-value | string |
|
|
|
| identifier | token | Subscription-identifier | A subscription identifier | Subscription.identifier |
| name | string | Subscription-name | A human-readable name | Subscription.name |
| owner | reference | Subscription-owner | The managing entity | Subscription.managingEntity |
| payload | token | Subscription-payload |
The
mime-type
of
|
|
| status | token | Subscription-status |
The current state of the subscription |
Subscription.status |
| topic | uri | Subscription-topic | The canonical topic url that triggers notifications | Subscription.topic |
| type | token | Subscription-type |
The type of channel for the sent notifications |
|
| url | uri | Subscription-url |
The uri that will receive the notifications |
|
|
SubscriptionTopic
|
||||
|
date
|
date |
|
Date status first applied |
SubscriptionTopic.date |
|
derived-or-self
|
uri | SubscriptionTopic-derived-or-self |
A server defined search that matches either the url or derivedFrom |
SubscriptionTopic.url | SubscriptionTopic.derivedFrom |
|
| date | SubscriptionTopic-effective | Effective period | SubscriptionTopic.effectivePeriod |
| event | token |
| Event trigger | SubscriptionTopic.eventTrigger.event |
| identifier | token | CanonicalResource-identifier |
Business Identifier for SubscriptionTopic |
SubscriptionTopic.identifier |
|
resource
|
uri | SubscriptionTopic-resource |
Allowed
|
SubscriptionTopic.resourceTrigger.resource | SubscriptionTopic.eventTrigger.resource | SubscriptionTopic.canFilterBy.resource | SubscriptionTopic.notificationShape.resource |
|
status
|
token |
|
draft | active | retired | unknown |
SubscriptionTopic.status |
|
title
|
string |
|
Name for this SubscriptionTopic (Human friendly) |
SubscriptionTopic.title |
|
trigger-description
|
string | SubscriptionTopic-trigger-description |
Text representation of the trigger |
SubscriptionTopic.resourceTrigger.description |
|
url
|
uri |
|
Logical canonical URL to reference this SubscriptionTopic (globally unique) |
SubscriptionTopic.url |
|
version
|
token |
|
Business version of the SubscriptionTopic |
SubscriptionTopic.version |
| Substance TU | ||||
| category | token | Substance-category |
The category of the substance |
Substance.category |
|
code
|
token | Substance-code |
The code of the substance or ingredient |
|
|
|
|
|
|
|
|
expiry
|
date | Substance-expiry |
Expiry date of package or container of substance |
|
| identifier | token | Substance-identifier |
Unique identifier for the substance |
Substance.identifier |
| quantity | quantity | Substance-quantity |
Amount of substance in the package |
|
|
status
|
token | Substance-status |
active | inactive | entered-in-error |
Substance.status |
| substance-reference | reference | Substance-substance-reference |
A component of the substance |
|
| SubstanceDefinition TU | ||||
| classification | token | SubstanceDefinition-classification |
High or low level categorization, e.g. polymer vs. nucleic acid or linear vs. branch chain |
SubstanceDefinition.classification |
| code | token | SubstanceDefinition-code |
The specific code |
SubstanceDefinition.code.code |
| domain | token | SubstanceDefinition-domain |
If the substance applies to only human or veterinary use |
SubstanceDefinition.domain |
| identifier | token | SubstanceDefinition-identifier |
Identifier by which this substance is known |
SubstanceDefinition.identifier |
|
name
|
string | SubstanceDefinition-name |
The actual name |
SubstanceDefinition.name.name |
| SupplyDelivery TU | ||||
| identifier | token | clinical-identifier |
External identifier |
SupplyDelivery.identifier |
| patient | reference | clinical-patient |
Patient for whom the item is supplied |
SupplyDelivery.patient |
| receiver | reference | SupplyDelivery-receiver |
Who collected the Supply |
SupplyDelivery.receiver |
| status | token | SupplyDelivery-status |
in-progress | completed | abandoned | entered-in-error |
SupplyDelivery.status |
| supplier | reference | SupplyDelivery-supplier |
Dispenser |
SupplyDelivery.supplier |
| SupplyRequest TU | ||||
| category | token | SupplyRequest-category |
The kind of supply (central, non-stock, etc.) |
SupplyRequest.category |
| date | date | clinical-date |
When the request was made |
SupplyRequest.authoredOn |
| identifier | token | clinical-identifier |
Business Identifier for SupplyRequest |
SupplyRequest.identifier |
| patient | reference | clinical-patient | The patient or subject for whom the supply is destined | SupplyRequest.deliverFor |
| requester | reference | SupplyRequest-requester |
Individual making the request |
SupplyRequest.requester |
| status | token | SupplyRequest-status |
draft | active | suspended + |
SupplyRequest.status |
| subject | reference | SupplyRequest-subject |
The destination of the supply |
SupplyRequest.deliverTo |
| supplier | reference | SupplyRequest-supplier |
Who is intended to fulfill the request |
SupplyRequest.supplier |
| Task TU | ||||
| actor | reference | Task-actor | Search by specific performer. | Task.performer.actor |
| authored-on | date | Task-authored-on |
Search by creation date |
Task.authoredOn |
| based-on | reference | Task-based-on |
Search by requests this task is based on |
Task.basedOn |
| business-status | token | Task-business-status |
Search by business status |
Task.businessStatus |
| code | token |
|
Search by task code |
Task.code |
| encounter | reference |
|
Search by encounter |
Task.encounter |
| focus | reference | Task-focus |
Search by task focus |
Task.focus |
| group-identifier | token | Task-group-identifier |
Search by group identifier |
Task.groupIdentifier |
| identifier | token |
|
Search for a task instance by its business identifier |
Task.identifier |
| intent | token | Task-intent |
Search by task intent |
Task.intent |
| modified | date | Task-modified |
Search by last modification date |
Task.lastModified |
| output | reference | Task-output | Search by task output | Task.output.value.ofType(Reference) |
| owner | reference | Task-owner |
Search by task owner |
Task.owner |
| part-of | reference | Task-part-of |
Search by task this task is part of |
Task.partOf |
| patient | reference |
|
Search by patient |
Task.for.where(resolve() is Patient) |
| performer | token | Task-performer |
Search by recommended type of performer (e.g., Requester, Performer, Scheduler). |
|
| period | date | Task-period |
Search by period Task is/was underway |
Task.executionPeriod |
| priority | token | Task-priority |
Search by task priority |
Task.priority |
| requestedperformer-reference | reference | Task-requestedperformer-reference | Search by specific requested performer. | Task.requestedPerformer.reference |
| requester | reference | Task-requester |
Search by task requester |
Task.requester |
| status | token | Task-status |
Search by task status |
Task.status |
| subject | reference | Task-subject |
Search by subject |
Task.for |
| TerminologyCapabilities TU | ||||
| context | token |
|
A use context assigned to the terminology capabilities |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the terminology capabilities |
|
| context-type | token |
|
A type of use context assigned to the terminology capabilities |
TerminologyCapabilities.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the terminology capabilities |
TerminologyCapabilities.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the terminology capabilities |
TerminologyCapabilities.useContext |
| date | date |
|
The terminology capabilities publication date |
TerminologyCapabilities.date |
| description | string |
|
The description of the terminology capabilities |
TerminologyCapabilities.description |
| identifier | token | CanonicalResource-identifier | External identifier for the terminology capabilities | TerminologyCapabilities.identifier |
| jurisdiction | token |
|
Intended jurisdiction for the terminology capabilities |
TerminologyCapabilities.jurisdiction |
| name | string |
|
Computationally friendly name of the terminology capabilities |
TerminologyCapabilities.name |
| publisher | string |
|
Name of the publisher of the terminology capabilities |
TerminologyCapabilities.publisher |
| status | token |
|
The current status of the terminology capabilities |
TerminologyCapabilities.status |
| title | string |
|
The human-friendly name of the terminology capabilities |
TerminologyCapabilities.title |
| url | uri |
|
The uri that identifies the terminology capabilities |
TerminologyCapabilities.url |
| version | token |
|
The business version of the terminology capabilities |
TerminologyCapabilities.version |
| TestReport TU | ||||
| identifier | token | TestReport-identifier |
An external identifier for the test report |
TestReport.identifier |
| issued | date | TestReport-issued |
The test report generation date |
TestReport.issued |
| participant | uri | TestReport-participant |
The reference to a participant in the test execution |
TestReport.participant.uri |
| result | token | TestReport-result |
The result disposition of the test execution |
TestReport.result |
| tester | string | TestReport-tester |
The name of the testing organization |
TestReport.tester |
| testscript | reference | TestReport-testscript |
The test script executed to produce this report |
TestReport.testScript |
| TestScript TU | ||||
| context | token |
|
A use context assigned to the test script |
|
| context-quantity | quantity |
|
A quantity- or range-valued use context assigned to the test script |
|
| context-type | token |
|
A type of use context assigned to the test script |
TestScript.useContext.code |
| context-type-quantity | composite |
|
A use context type and quantity- or range-based value assigned to the test script |
TestScript.useContext |
| context-type-value | composite |
|
A use context type and value assigned to the test script |
TestScript.useContext |
| date | date |
|
The test script publication date |
TestScript.date |
| description | string |
|
The description of the test script |
TestScript.description |
| identifier | token |
|
External identifier for the test script |
TestScript.identifier |
| jurisdiction | token |
|
Intended jurisdiction for the test script |
TestScript.jurisdiction |
| name | string |
|
Computationally friendly name of the test script |
TestScript.name |
| publisher | string |
|
Name of the publisher of the test script |
TestScript.publisher |
| scope-artifact | reference | TestScript-scope-artifact | The artifact under test | TestScript.scope.artifact |
| scope-artifact-conformance | composite | TestScript-scope-artifact-conformance | The artifact under test and conformance testing expectation | TestScript.scope |
| scope-artifact-phase | composite | TestScript-scope-artifact-phase | The artifact under test and phase of testing | TestScript.scope |
| status | token |
|
The current status of the test script |
TestScript.status |
| testscript-capability | string | TestScript-testscript-capability |
TestScript required and validated capability |
TestScript.metadata.capability.description |
| title | string |
|
The human-friendly name of the test script |
TestScript.title |
| url | uri |
|
The uri that identifies the test script |
TestScript.url |
| version | token |
|
The business version of the test script |
TestScript.version |
| Transport TU | ||||
| identifier | token | Transport-identifier | External identifier | Transport.identifier |
| status | token | Transport-status | in-progress | completed | entered-in-error | Transport.status |
| ValueSet N | ||||
|
code
|
token | ValueSet-code |
This special parameter searches for codes in the value set. See additional notes on the ValueSet resource |
ValueSet.expansion.contains.code | ValueSet.compose.include.concept.code |
| context TU | token |
|
A use context assigned to the value set |
|
| context-quantity TU | quantity |
|
A quantity- or range-valued use context assigned to the value set |
|
| context-type TU | token |
|
A type of use context assigned to the value set |
ValueSet.useContext.code |
| context-type-quantity TU | composite |
|
A use context type and quantity- or range-based value assigned to the value set |
ValueSet.useContext |
| context-type-value TU | composite |
|
A use context type and value assigned to the value set |
ValueSet.useContext |
| date TU | date |
|
The value set publication date |
ValueSet.date |
| derived-from TU | reference | MetadataResource-derived-from | A resource that the ValueSet is derived from | ValueSet.relatedArtifact.where(type='derived-from').resource |
| description TU | string |
|
The description of the value set |
ValueSet.description |
|
|
date | MetadataResource-effective | The time during which the ValueSet is intended to be in use | ValueSet.effectivePeriod |
| expansion | uri | ValueSet-expansion |
Identifies the value set expansion (business identifier) |
ValueSet.expansion.identifier |
| identifier TU | token |
|
External identifier for the value set |
ValueSet.identifier |
| jurisdiction TU | token |
|
Intended jurisdiction for the value set |
ValueSet.jurisdiction |
| name TU | string |
|
Computationally friendly name of the value set |
ValueSet.name |
| predecessor TU | reference | MetadataResource-predecessor | The predecessor of the ValueSet | ValueSet.relatedArtifact.where(type='predecessor').resource |
| publisher TU | string |
|
Name of the publisher of the value set |
ValueSet.publisher |
|
reference
|
uri | ValueSet-reference |
A code system included or excluded in the value set or an imported value set |
ValueSet.compose.include.system |
| status TU | token |
|
The current status of the value set |
ValueSet.status |
| title TU | string |
|
The human-friendly name of the value set |
ValueSet.title |
| topic TU | token | MetadataResource-topic | Topics associated with the ValueSet | ValueSet.topic |
| url TU | uri |
|
The uri that identifies the value set |
ValueSet.url |
| version TU | token |
|
The business version of the value set |
ValueSet.version |
| VerificationResult TU | ||||
| attestation-method | token | VerificationResult-attestation-method | Select validation information for data that was attested to using the specified method | VerificationResult.attestation.communicationMethod |
| attestation-onbehalfof | reference | VerificationResult-attestation-onbehalfof | Select validation information for data that was attested to on behalf of the specified source | VerificationResult.attestation.onBehalfOf |
| attestation-who | reference | VerificationResult-attestation-who | Select validation information for data that was attested to by the specified source | VerificationResult.attestation.who |
| primarysource-date | date | VerificationResult-primarysource-date | Select validation information for data that was validated against a primary source on the specified date | VerificationResult.primarySource.validationDate |
| primarysource-type | token | VerificationResult-primarysource-type | Select validation information for data that was validated against the specified type of primary source organization | VerificationResult.primarySource.type |
| primarysource-who | reference | VerificationResult-primarysource-who | Select validation information for data that was validated against the specified primary source | VerificationResult.primarySource.who |
| status-date | date | VerificationResult-status-date | Select validation information with a validation status that occurred at the specified date/time | VerificationResult.statusDate |
| target | reference | VerificationResult-target |
A resource that was validated |
VerificationResult.target |
| validation-status | token | VerificationResult-validation-status | Select validation information with the specified status | VerificationResult.status |
| validator-organization | reference | VerificationResult-validator-organization | Select validation information for data that was validated by the specified organization | VerificationResult.validator.organization |
| VisionPrescription TU | ||||
| datewritten | date | VisionPrescription-datewritten |
Return prescriptions written on this date |
VisionPrescription.dateWritten |
| encounter | reference | clinical-encounter |
Return prescriptions with this encounter identifier |
VisionPrescription.encounter |
| identifier | token | clinical-identifier |
Return prescriptions with this external identifier |
VisionPrescription.identifier |
| patient | reference | clinical-patient |
The identity of a patient to list dispenses for |
VisionPrescription.patient |
| prescriber | reference | VisionPrescription-prescriber |
Who authorized the vision prescription |
VisionPrescription.prescriber |
| status | token | VisionPrescription-status |
The status of the vision prescription |
VisionPrescription.status |
FHIR
®©
HL7.org
2011+.
FHIR
Release
4B
(v4.3.0)
hl7.fhir.r4b.core#4.3.0
R5
hl7.fhir.core#5.0.0-draft-final
generated
on
Sat,
May
28,
2022
12:58+1000.
Wed,
Mar
1,
2023
23:07+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Glossary
|
QA
Page
|
Compare
to
R4
R4B
|
Compare
to
R5
Draft
|
|
Propose
a
change