Release 5 Preview #2
ExchangeThis page is part of the FHIR Specification (v4.4.0: R5 Preview #2). 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. 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 | string | Resource-content | Search on the entire content of the resource | |
| _id | token | Resource-id | Logical id of this artifact | Resource.id |
| _lastUpdated | date | Resource-lastUpdated | When the resource version last changed | Resource.meta.lastUpdated |
| _profile | uri | Resource-profile | Profiles this resource claims to conform to | Resource.meta.profile |
| _query TU | token | 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 |
| DomainResource N | ||||
| _text TU | string | DomainResource-text | Search on the narrative of the resource | |
| Common Search Parameters | ||||
| address TU | 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:
| AllergyIntolerance.code | AllergyIntolerance.reaction.substance | Condition.code | DeviceRequest.code.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationUsage.medication.concept | Observation.code | Procedure.code | ServiceRequest.code |
| context TU | token | conformance-context | Multiple Resources:
| (CapabilityStatement.useContext.value as CodeableConcept) | (CodeSystem.useContext.value as CodeableConcept) | (CompartmentDefinition.useContext.value as CodeableConcept) | (ConceptMap.useContext.value as CodeableConcept) | (GraphDefinition.useContext.value as CodeableConcept) | (ImplementationGuide.useContext.value as CodeableConcept) | (MessageDefinition.useContext.value as CodeableConcept) | (NamingSystem.useContext.value as CodeableConcept) | (OperationDefinition.useContext.value as CodeableConcept) | (SearchParameter.useContext.value as CodeableConcept) | (StructureDefinition.useContext.value as CodeableConcept) | (StructureMap.useContext.value as CodeableConcept) | (TerminologyCapabilities.useContext.value as CodeableConcept) | (ValueSet.useContext.value as CodeableConcept) |
| context-quantity TU | quantity | conformance-context-quantity | Multiple Resources:
| (CapabilityStatement.useContext.value as Quantity) | (CapabilityStatement.useContext.value as Range) | (CodeSystem.useContext.value as Quantity) | (CodeSystem.useContext.value as Range) | (CompartmentDefinition.useContext.value as Quantity) | (CompartmentDefinition.useContext.value as Range) | (ConceptMap.useContext.value as Quantity) | (ConceptMap.useContext.value as Range) | (GraphDefinition.useContext.value as Quantity) | (GraphDefinition.useContext.value as Range) | (ImplementationGuide.useContext.value as Quantity) | (ImplementationGuide.useContext.value as Range) | (MessageDefinition.useContext.value as Quantity) | (MessageDefinition.useContext.value as Range) | (NamingSystem.useContext.value as Quantity) | (NamingSystem.useContext.value as Range) | (OperationDefinition.useContext.value as Quantity) | (OperationDefinition.useContext.value as Range) | (SearchParameter.useContext.value as Quantity) | (SearchParameter.useContext.value as Range) | (StructureDefinition.useContext.value as Quantity) | (StructureDefinition.useContext.value as Range) | (StructureMap.useContext.value as Quantity) | (StructureMap.useContext.value as Range) | (TerminologyCapabilities.useContext.value as Quantity) | (TerminologyCapabilities.useContext.value as Range) | (ValueSet.useContext.value as Quantity) | (ValueSet.useContext.value as Range) |
| context-type TU | token | conformance-context-type | Multiple Resources:
| CapabilityStatement.useContext.code | CodeSystem.useContext.code | CompartmentDefinition.useContext.code | ConceptMap.useContext.code | GraphDefinition.useContext.code | ImplementationGuide.useContext.code | MessageDefinition.useContext.code | NamingSystem.useContext.code | OperationDefinition.useContext.code | SearchParameter.useContext.code | StructureDefinition.useContext.code | StructureMap.useContext.code | TerminologyCapabilities.useContext.code | ValueSet.useContext.code |
| context-type-quantity TU | composite | conformance-context-type-quantity | Multiple Resources:
| CapabilityStatement.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | ValueSet.useContext |
| context-type-value TU | composite | conformance-context-type-value | Multiple Resources:
| CapabilityStatement.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | ValueSet.useContext |
| date N | date | conformance-date | Multiple Resources:
| CapabilityStatement.date | CodeSystem.date | CompartmentDefinition.date | ConceptMap.date | GraphDefinition.date | ImplementationGuide.date | MessageDefinition.date | NamingSystem.date | OperationDefinition.date | SearchParameter.date | StructureDefinition.date | StructureMap.date | TerminologyCapabilities.date | ValueSet.date |
| date N | date | clinical-date | Multiple Resources:
| AllergyIntolerance.recordedDate | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.dateTime | DiagnosticReport.effective | Encounter.period | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence as dateTime) | List.date | Observation.effective | Procedure.occurrence | (RiskAssessment.occurrence as dateTime) | SupplyRequest.authoredOn |
| date TU | date | medications-date | Multiple Resources:
| MedicationAdministration.occurence | MedicationRequest.dosageInstruction.timing.event |
| description N | string | conformance-description | Multiple Resources:
| CapabilityStatement.description | CodeSystem.description | CompartmentDefinition.description | ConceptMap.description | GraphDefinition.description | ImplementationGuide.description | MessageDefinition.description | NamingSystem.description | OperationDefinition.description | SearchParameter.description | StructureDefinition.description | StructureMap.description | TerminologyCapabilities.description | ValueSet.description |
| email TU | token | individual-email | Multiple Resources:
| Patient.telecom.where(system='email') | Person.telecom.where(system='email') | Practitioner.telecom.where(system='email') | PractitionerRole.telecom.where(system='email') | RelatedPerson.telecom.where(system='email') |
| encounter TU | reference | clinical-encounter | Multiple Resources:
| Composition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | DocumentReference.context.encounter | Flag.encounter | List.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | RiskAssessment.encounter | ServiceRequest.encounter | VisionPrescription.encounter |
| encounter TU | reference | medications-encounter | Multiple Resources:
| MedicationAdministration.encounter | MedicationRequest.encounter |
| family N | string | individual-family | Multiple Resources:
| Patient.name.family | Practitioner.name.family |
| gender N | token | individual-gender | Multiple Resources:
| Patient.gender | Person.gender | Practitioner.gender | RelatedPerson.gender |
| given N | string | individual-given | Multiple Resources:
| Patient.name.given | Practitioner.name.given |
| identifier TU | token | clinical-identifier | Multiple Resources:
| AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.masterIdentifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier |
| identifier TU | token | conformance-identifier | Multiple Resources:
| CodeSystem.identifier | ConceptMap.identifier | MessageDefinition.identifier | StructureDefinition.identifier | StructureMap.identifier | TerminologyCapabilities.identifier | ValueSet.identifier |
| jurisdiction TU | token | conformance-jurisdiction | Multiple Resources:
| CapabilityStatement.jurisdiction | CodeSystem.jurisdiction | ConceptMap.jurisdiction | GraphDefinition.jurisdiction | ImplementationGuide.jurisdiction | MessageDefinition.jurisdiction | NamingSystem.jurisdiction | OperationDefinition.jurisdiction | SearchParameter.jurisdiction | StructureDefinition.jurisdiction | StructureMap.jurisdiction | TerminologyCapabilities.jurisdiction | ValueSet.jurisdiction |
| medication D | reference | medications-medication | Multiple Resources:
| MedicationAdministration.medication.reference | MedicationDispense.medication.reference | MedicationRequest.medication.reference | MedicationUsage.medication.reference |
| name N | string | conformance-name | Multiple Resources:
| CapabilityStatement.name | CodeSystem.name | CompartmentDefinition.name | ConceptMap.name | GraphDefinition.name | ImplementationGuide.name | MessageDefinition.name | NamingSystem.name | OperationDefinition.name | SearchParameter.name | StructureDefinition.name | StructureMap.name | TerminologyCapabilities.name | ValueSet.name |
| patient TU | reference | clinical-patient | Multiple Resources:
| AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUseStatement.subject | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.patient | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | VisionPrescription.patient |
| phone TU | token | individual-phone | Multiple Resources:
| Patient.telecom.where(system='phone') | Person.telecom.where(system='phone') | Practitioner.telecom.where(system='phone') | PractitionerRole.telecom.where(system='phone') | RelatedPerson.telecom.where(system='phone') |
| phonetic TU | string | individual-phonetic | Multiple Resources:
| Patient.name | Person.name | Practitioner.name | RelatedPerson.name |
| publisher N | string | conformance-publisher | Multiple Resources:
| CapabilityStatement.publisher | CodeSystem.publisher | CompartmentDefinition.publisher | ConceptMap.publisher | GraphDefinition.publisher | ImplementationGuide.publisher | MessageDefinition.publisher | NamingSystem.publisher | OperationDefinition.publisher | SearchParameter.publisher | StructureDefinition.publisher | StructureMap.publisher | TerminologyCapabilities.publisher | ValueSet.publisher |
| status N | token | conformance-status | Multiple Resources:
| CapabilityStatement.status | CodeSystem.status | CompartmentDefinition.status | ConceptMap.status | GraphDefinition.status | ImplementationGuide.status | MessageDefinition.status | NamingSystem.status | OperationDefinition.status | SearchParameter.status | StructureDefinition.status | StructureMap.status | TerminologyCapabilities.status | ValueSet.status |
| status N | token | medications-status | Multiple Resources:
| MedicationAdministration.status | MedicationDispense.status | MedicationRequest.status | MedicationUsage.status |
| telecom TU | token | individual-telecom | Multiple Resources:
| Patient.telecom | Person.telecom | Practitioner.telecom | PractitionerRole.telecom | RelatedPerson.telecom |
| title N | string | conformance-title | Multiple Resources:
| CapabilityStatement.title | CodeSystem.title | ConceptMap.title | ImplementationGuide.title | MessageDefinition.title | OperationDefinition.title | StructureDefinition.title | StructureMap.title | TerminologyCapabilities.title | ValueSet.title |
| type N | token | clinical-type | Multiple Resources:
| AllergyIntolerance.type | Composition.type | DocumentManifest.type | DocumentReference.type | Encounter.type | EpisodeOfCare.type |
| url N | uri | conformance-url | Multiple Resources:
| CapabilityStatement.url | CodeSystem.url | CompartmentDefinition.url | ConceptMap.url | GraphDefinition.url | ImplementationGuide.url | MessageDefinition.url | NamingSystem.url | OperationDefinition.url | SearchParameter.url | StructureDefinition.url | StructureMap.url | TerminologyCapabilities.url | ValueSet.url |
| version N | token | conformance-version | Multiple Resources:
| CapabilityStatement.version | CodeSystem.version | CompartmentDefinition.version | ConceptMap.version | GraphDefinition.version | ImplementationGuide.version | MessageDefinition.version | NamingSystem.version | OperationDefinition.version | SearchParameter.version | StructureDefinition.version | StructureMap.version | TerminologyCapabilities.version | ValueSet.version |
| Account TU | ||||
| identifier | token | Account-identifier | Account number | Account.identifier |
| name N | string | Account-name | Human-readable label | Account.name |
| owner | reference | Account-owner | Entity managing the Account | Account.owner |
| patient | reference | Account-patient | The entity that caused the expenses | Account.subject.where(resolve() is Patient) |
| period | date | Account-period | Transaction window | Account.servicePeriod |
| status N | 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 | Account-type | E.g. patient, expense, depreciation | Account.type |
| ActivityDefinition TU | ||||
| composed-of | reference | ActivityDefinition-composed-of | What resource is being referenced | ActivityDefinition.relatedArtifact.where(type='composed-of').resource |
| context | token | ActivityDefinition-context | A use context assigned to the activity definition | (ActivityDefinition.useContext.value as CodeableConcept) |
| context-quantity | quantity | ActivityDefinition-context-quantity | A quantity- or range-valued use context assigned to the activity definition | (ActivityDefinition.useContext.value as Quantity) | (ActivityDefinition.useContext.value as Range) |
| context-type | token | ActivityDefinition-context-type | A type of use context assigned to the activity definition | ActivityDefinition.useContext.code |
| context-type-quantity | composite | ActivityDefinition-context-type-quantity | A use context type and quantity- or range-based value assigned to the activity definition | ActivityDefinition.useContext |
| context-type-value | composite | ActivityDefinition-context-type-value | A use context type and value assigned to the activity definition | ActivityDefinition.useContext |
| date N | date | ActivityDefinition-date | The activity definition publication date | ActivityDefinition.date |
| depends-on | reference | ActivityDefinition-depends-on | What resource is being referenced | ActivityDefinition.relatedArtifact.where(type='depends-on').resource | ActivityDefinition.library |
| derived-from | reference | ActivityDefinition-derived-from | What resource is being referenced | ActivityDefinition.relatedArtifact.where(type='derived-from').resource |
| description N | string | ActivityDefinition-description | The description of the activity definition | ActivityDefinition.description |
| effective | date | ActivityDefinition-effective | The time during which the activity definition is intended to be in use | ActivityDefinition.effectivePeriod |
| identifier | token | ActivityDefinition-identifier | External identifier for the activity definition | ActivityDefinition.identifier |
| jurisdiction | token | ActivityDefinition-jurisdiction | Intended jurisdiction for the activity definition | ActivityDefinition.jurisdiction |
| name N | string | ActivityDefinition-name | Computationally friendly name of the activity definition | ActivityDefinition.name |
| predecessor | reference | ActivityDefinition-predecessor | What resource is being referenced | ActivityDefinition.relatedArtifact.where(type='predecessor').resource |
| publisher N | string | ActivityDefinition-publisher | Name of the publisher of the activity definition | ActivityDefinition.publisher |
| status N | token | ActivityDefinition-status | The current status of the activity definition | ActivityDefinition.status |
| successor | reference | ActivityDefinition-successor | What resource is being referenced | ActivityDefinition.relatedArtifact.where(type='successor').resource |
| title N | string | ActivityDefinition-title | The human-friendly name of the activity definition | ActivityDefinition.title |
| topic | token | ActivityDefinition-topic | Topics associated with the module | ActivityDefinition.topic |
| url N | uri | ActivityDefinition-url | The uri that identifies the activity definition | ActivityDefinition.url |
| version N | token | ActivityDefinition-version | The business version of the activity definition | ActivityDefinition.version |
| AdministrableProductDefinition TU | ||||
| dose-form | token | AdministrableProductDefinition-dose-form | The administrable dose form, after necessary reconstitution | AdministrableProductDefinition.administrableDoseForm |
| identifier | token | AdministrableProductDefinition-identifier | An identifier for the pharmaceutical medicinal product | AdministrableProductDefinition.identifier |
| route | token | AdministrableProductDefinition-route | Coded expression for the route | AdministrableProductDefinition.routeOfAdministration.code |
| subject | reference | AdministrableProductDefinition-subject | The product that this is a pharmaceutical product of | AdministrableProductDefinition.subject |
| target-species | token | AdministrableProductDefinition-target-species | Coded expression for the species | AdministrableProductDefinition.routeOfAdministration.targetSpecies.code |
| AdverseEvent TU | ||||
| actuality N | token | AdverseEvent-actuality | actual | potential | AdverseEvent.actuality |
| category | token | AdverseEvent-category | wrong-patient | procedure-mishap | medication-mishap | device | unsafe-physical-environment | hospital-aquired-infection | wrong-body-site | AdverseEvent.category |
| code | token | AdverseEvent-code | Event or incident that occurred or was averted | AdverseEvent.code |
| date | date | AdverseEvent-date | When the event occurred | AdverseEvent.occurrence |
| identifier | token | AdverseEvent-identifier | Business identifier for the event | AdverseEvent.identifier |
| location | reference | AdverseEvent-location | Location where adverse event occurred | AdverseEvent.location |
| patient | reference | AdverseEvent-patient | Subject impacted by event | AdverseEvent.subject |
| recorder | reference | AdverseEvent-recorder | Who recorded the adverse event | AdverseEvent.recorder |
| resultingcondition | reference | AdverseEvent-resultingcondition | Effect on the subject due to this event | AdverseEvent.resultingCondition |
| seriousness | token | AdverseEvent-seriousness | Seriousness or gravity of the event | AdverseEvent.seriousness |
| status N | token | AdverseEvent-status | in-progress | completed | entered-in-error | unknown | AdverseEvent.status |
| study | reference | AdverseEvent-study | Research study that the subject is enrolled in | 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 | (AdverseEvent.suspectEntity.instance as Reference) |
| AllergyIntolerance TU | ||||
| asserter | reference | AllergyIntolerance-asserter | Source of the information about the allergy | AllergyIntolerance.asserter |
| category N | 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 N | token | AllergyIntolerance-criticality | low | high | unable-to-assess | AllergyIntolerance.criticality |
| date N | 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 N | date | AllergyIntolerance-last-date | Date(/time) of last known occurrence of a reaction | AllergyIntolerance.lastOccurrence |
| manifestation | token | AllergyIntolerance-manifestation | Clinical symptoms/signs associated with the Event | AllergyIntolerance.reaction.manifestation |
| patient | reference | clinical-patient | Who the sensitivity is for | AllergyIntolerance.patient |
| recorder | reference | AllergyIntolerance-recorder | Who recorded the sensitivity | AllergyIntolerance.recorder |
| route | token | AllergyIntolerance-route | How the subject was exposed to the substance | AllergyIntolerance.reaction.exposureRoute |
| severity N | token | AllergyIntolerance-severity | mild | moderate | severe (of event as a whole) | AllergyIntolerance.reaction.severity |
| type N | 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 N | date | Appointment-date | Appointment date/time. | Appointment.start |
| identifier | token | Appointment-identifier | 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 N | 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 | Appointment-patient | One of the individuals of the appointment is this patient | Appointment.participant.actor.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 D | token | Appointment-reason-code | Reference to a concept (by class) | Appointment.reason.concept |
| reason-reference D | reference | Appointment-reason-reference | Reference to a resource (by instance) | Appointment.reason.reference |
| 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 that is to be performed during this appointment | Appointment.serviceType |
| 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 N | token | Appointment-status | The overall status of the appointment | Appointment.status |
| 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 |
| identifier | token | AppointmentResponse-identifier | 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 N | token | AppointmentResponse-part-status | The participants acceptance status for this appointment | AppointmentResponse.participantStatus |
| patient | reference | AppointmentResponse-patient | 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) |
| AuditEvent TU | ||||
| action N | token | AuditEvent-action | Type of action performed during the event | AuditEvent.action |
| address N | string | AuditEvent-address | Identifier for the network access point of the user device | AuditEvent.agent.network.address |
| agent | reference | AuditEvent-agent | Identifier of who | AuditEvent.agent.who |
| agent-name N | string | AuditEvent-agent-name | Human friendly name for the agent | AuditEvent.agent.name |
| agent-role | token | AuditEvent-agent-role | Agent role in the event | AuditEvent.agent.role |
| altid N | token | AuditEvent-altid | Alternative User identity | AuditEvent.agent.altId |
| date N | date | AuditEvent-date | Time when the event was recorded | AuditEvent.recorded |
| entity | reference | AuditEvent-entity | Specific instance of resource | AuditEvent.entity.what |
| entity-name N | string | AuditEvent-entity-name | Descriptor for entity | AuditEvent.entity.name |
| entity-role | token | AuditEvent-entity-role | What role the entity played | AuditEvent.entity.role |
| entity-type | token | AuditEvent-entity-type | Type of entity involved | AuditEvent.entity.type |
| outcome | token | AuditEvent-outcome | Whether the event succeeded or failed | AuditEvent.outcome |
| patient | reference | AuditEvent-patient | Identifier of who | AuditEvent.agent.who.where(resolve() is Patient) | AuditEvent.entity.what.where(resolve() is Patient) |
| policy N | uri | AuditEvent-policy | Policy that authorized event | AuditEvent.agent.policy |
| purpose | token | AuditEvent-purpose | The purposeOfUse of the event | AuditEvent.purposeOfEvent | AuditEvent.agent.purposeOfUse |
| site N | token | AuditEvent-site | Logical source location within the enterprise | AuditEvent.source.site |
| source | reference | AuditEvent-source | The identity of source detecting the event | AuditEvent.source.observer |
| subtype | token | AuditEvent-subtype | More specific type/id for the event | AuditEvent.subtype |
| type | token | AuditEvent-type | Type/identifier of event | AuditEvent.type |
| Basic TU | ||||
| author | reference | Basic-author | Who created | Basic.author |
| code | token | Basic-code | Kind of Resource | Basic.code |
| created N | date | Basic-created | When created | Basic.created |
| identifier | token | Basic-identifier | Business identifier | Basic.identifier |
| patient | reference | Basic-patient | Identifies the focus of this resource | Basic.subject.where(resolve() is Patient) |
| subject | reference | Basic-subject | Identifies the focus of this resource | Basic.subject |
| BodyStructure TU | ||||
| identifier | token | BodyStructure-identifier | Bodystructure identifier | BodyStructure.identifier |
| location | token | BodyStructure-location | Body site | BodyStructure.location |
| morphology | token | BodyStructure-morphology | Kind of Structure | BodyStructure.morphology |
| patient | reference | BodyStructure-patient | Who this is about | BodyStructure.patient |
| Bundle N | ||||
| composition TU | 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 |
| identifier TU | token | Bundle-identifier | Persistent identifier for the bundle | Bundle.identifier |
| message TU | 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 |
| timestamp TU | 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 | conformance-context | A use context assigned to the capability statement | (CapabilityStatement.useContext.value as CodeableConcept) |
| context-quantity TU | quantity | conformance-context-quantity | A quantity- or range-valued use context assigned to the capability statement | (CapabilityStatement.useContext.value as Quantity) | (CapabilityStatement.useContext.value as Range) |
| context-type TU | token | conformance-context-type | A type of use context assigned to the capability statement | CapabilityStatement.useContext.code |
| context-type-quantity TU | composite | conformance-context-type-quantity | A use context type and quantity- or range-based value assigned to the capability statement | CapabilityStatement.useContext |
| context-type-value TU | composite | conformance-context-type-value | A use context type and value assigned to the capability statement | CapabilityStatement.useContext |
| date | date | conformance-date | The capability statement publication date | CapabilityStatement.date |
| description | string | conformance-description | The description of the capability statement | CapabilityStatement.description |
| fhirversion | token | CapabilityStatement-fhirversion | The version of FHIR | CapabilityStatement.version |
| format | token | CapabilityStatement-format | formats supported (xml | json | ttl | mime type) | CapabilityStatement.format |
| guide | reference | CapabilityStatement-guide | Implementation guides supported | CapabilityStatement.implementationGuide |
| jurisdiction TU | token | conformance-jurisdiction | Intended jurisdiction for the capability statement | CapabilityStatement.jurisdiction |
| mode | token | CapabilityStatement-mode | Mode - restful (server/client) or messaging (sender/receiver) | CapabilityStatement.rest.mode |
| name | string | conformance-name | Computationally friendly name of the capability statement | CapabilityStatement.name |
| publisher | string | conformance-publisher | 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 | token | conformance-status | The current status of the capability statement | CapabilityStatement.status |
| supported-profile | reference | CapabilityStatement-supported-profile | Profiles for use cases supported | CapabilityStatement.rest.resource.supportedProfile |
| title | string | conformance-title | The human-friendly name of the capability statement | CapabilityStatement.title |
| url | uri | conformance-url | The uri that identifies the capability statement | CapabilityStatement.url |
| version | token | conformance-version | The business version of the capability statement | CapabilityStatement.version |
| CapabilityStatement2 TU | ||||
| context | token | CapabilityStatement2-context | A use context assigned to the capability statement2 | (CapabilityStatement2.useContext.value as CodeableConcept) |
| context-quantity | quantity | CapabilityStatement2-context-quantity | A quantity- or range-valued use context assigned to the capability statement2 | (CapabilityStatement2.useContext.value as Quantity) | (CapabilityStatement2.useContext.value as Range) |
| context-type | token | CapabilityStatement2-context-type | A type of use context assigned to the capability statement2 | CapabilityStatement2.useContext.code |
| context-type-quantity | composite | CapabilityStatement2-context-type-quantity | A use context type and quantity- or range-based value assigned to the capability statement2 | CapabilityStatement2.useContext |
| context-type-value | composite | CapabilityStatement2-context-type-value | A use context type and value assigned to the capability statement2 | CapabilityStatement2.useContext |
| date N | date | CapabilityStatement2-date | The capability statement2 publication date | CapabilityStatement2.date |
| description N | string | CapabilityStatement2-description | The description of the capability statement2 | CapabilityStatement2.description |
| fhirversion N | token | CapabilityStatement2-fhirversion | The version of FHIR | CapabilityStatement2.version |
| format N | token | CapabilityStatement2-format | formats supported (xml | json | ttl | mime type) | CapabilityStatement2.format |
| guide N | reference | CapabilityStatement2-guide | Implementation guides supported | CapabilityStatement2.implementationGuide |
| jurisdiction | token | CapabilityStatement2-jurisdiction | Intended jurisdiction for the capability statement2 | CapabilityStatement2.jurisdiction |
| mode N | token | CapabilityStatement2-mode | Mode - restful (server/client) or messaging (sender/receiver) | CapabilityStatement2.rest.mode |
| name N | string | CapabilityStatement2-name | Computationally friendly name of the capability statement2 | CapabilityStatement2.name |
| publisher N | string | CapabilityStatement2-publisher | Name of the publisher of the capability statement2 | CapabilityStatement2.publisher |
| resource N | token | CapabilityStatement2-resource | Name of a resource mentioned in a capability statement | CapabilityStatement2.rest.resource.type |
| resource-profile N | reference | CapabilityStatement2-resource-profile | A profile id invoked in a capability statement | CapabilityStatement2.rest.resource.profile |
| software N | string | CapabilityStatement2-software | Part of the name of a software application | CapabilityStatement2.software.name |
| status N | token | CapabilityStatement2-status | The current status of the capability statement2 | CapabilityStatement2.status |
| supported-profile N | reference | CapabilityStatement2-supported-profile | Profiles for use cases supported | CapabilityStatement2.rest.resource.supportedProfile |
| title N | string | CapabilityStatement2-title | The human-friendly name of the capability statement2 | CapabilityStatement2.title |
| url N | uri | CapabilityStatement2-url | The uri that identifies the capability statement2 | CapabilityStatement2.url |
| version N | token | CapabilityStatement2-version | The business version of the capability statement2 | CapabilityStatement2.version |
| CarePlan TU | ||||
| activity-code | token | CarePlan-activity-code | Detail type of activity | CarePlan.activity.detail.code |
| activity-reference | reference | CarePlan-activity-reference | Activity details defined in specific resource | CarePlan.activity.reference |
| activity-scheduled-date | date | CarePlan-activity-scheduled-date | Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x] | CarePlan.activity.detail.scheduled.as(Timing) | CarePlan.activity.detail.scheduled.as(Period) |
| activity-scheduled-string | string | CarePlan-activity-scheduled-string | When activity is to occur | CarePlan.activity.detail.scheduled.as(string) |
| 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 D | reference | CarePlan-condition | Reference to a resource (by instance) | CarePlan.addresses.reference |
| date N | date | clinical-date | Time period plan covers | CarePlan.period |
| encounter | reference | CarePlan-encounter | 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 N | reference | CarePlan-instantiates-canonical | Instantiates FHIR protocol or definition | CarePlan.instantiatesCanonical |
| instantiates-uri N | uri | CarePlan-instantiates-uri | Instantiates external protocol or definition | CarePlan.instantiatesUri |
| intent N | 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) |
| performer | reference | CarePlan-performer | Matches if the practitioner is listed as a performer in any of the "simple" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.) | CarePlan.activity.detail.performer |
| replaces | reference | CarePlan-replaces | CarePlan replaced by this CarePlan | CarePlan.replaces |
| status N | 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 N | date | clinical-date | A date within the coverage time period. | |
| identifier | token | clinical-identifier | External Ids for this team | CareTeam.identifier |
| name N | string | CareTeam-name | Name of the team, such as crisis assessment team | CareTeam.name |
| 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 N | token | CareTeam-status | proposed | active | suspended | inactive | entered-in-error | CareTeam.status |
| subject | reference | CareTeam-subject | Who care team is for | CareTeam.subject |
| CatalogEntry TU | ||||
| identifier | token | CatalogEntry-identifier | Business identifier of the catalog entry | CatalogEntry.identifier |
| name N | string | CatalogEntry-name | Displayable name assigned to the catalog entry | CatalogEntry.name |
| orderable N | token | CatalogEntry-orderable | Is orderable | CatalogEntry.orderable |
| referenced-item | reference | CatalogEntry-referenced-item | Item attached to this entry of the catalog | CatalogEntry.referencedItem |
| related-entry | reference | CatalogEntry-related-entry | The reference to the related entry | CatalogEntry.relatedEntry.target |
| status N | token | CatalogEntry-status | Usability status of this entry in the catalog | CatalogEntry.status |
| type N | token | CatalogEntry-type | ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | MedicationKnowledge | Medication | Substance | Location | CatalogEntry.type |
| ChargeItem TU | ||||
| account | reference | ChargeItem-account | Account to place this charge | ChargeItem.account |
| code | token | ChargeItem-code | A code that identifies the charge, like a billing code | ChargeItem.code |
| context | reference | ChargeItem-context | Encounter / Episode associated with event | ChargeItem.context |
| entered-date N | date | ChargeItem-entered-date | Date the charge item was entered | ChargeItem.enteredDate |
| enterer | reference | ChargeItem-enterer | Individual who was entering | ChargeItem.enterer |
| factor-override N | number | ChargeItem-factor-override | Factor overriding the associated rules | ChargeItem.factorOverride |
| identifier | token | ChargeItem-identifier | Business Identifier for item | ChargeItem.identifier |
| occurrence | date | ChargeItem-occurrence | When the charged service was applied | ChargeItem.occurrence |
| patient | reference | ChargeItem-patient | 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 | ChargeItem.priceOverride |
| 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? | ChargeItem.service |
| subject | reference | ChargeItem-subject | Individual service was done for/to | ChargeItem.subject |
| ChargeItemDefinition TU | ||||
| context | token | ChargeItemDefinition-context | A use context assigned to the charge item definition | (ChargeItemDefinition.useContext.value as CodeableConcept) |
| context-quantity | quantity | ChargeItemDefinition-context-quantity | A quantity- or range-valued use context assigned to the charge item definition | (ChargeItemDefinition.useContext.value as Quantity) | (ChargeItemDefinition.useContext.value as Range) |
| context-type | token | ChargeItemDefinition-context-type | A type of use context assigned to the charge item definition | ChargeItemDefinition.useContext.code |
| context-type-quantity | composite | ChargeItemDefinition-context-type-quantity | A use context type and quantity- or range-based value assigned to the charge item definition | ChargeItemDefinition.useContext |
| context-type-value | composite | ChargeItemDefinition-context-type-value | A use context type and value assigned to the charge item definition | ChargeItemDefinition.useContext |
| date N | date | ChargeItemDefinition-date | The charge item definition publication date | ChargeItemDefinition.date |
| description N | string | ChargeItemDefinition-description | The description of the charge item definition | ChargeItemDefinition.description |
| effective | date | ChargeItemDefinition-effective | The time during which the charge item definition is intended to be in use | ChargeItemDefinition.effectivePeriod |
| identifier | token | ChargeItemDefinition-identifier | External identifier for the charge item definition | ChargeItemDefinition.identifier |
| jurisdiction | token | ChargeItemDefinition-jurisdiction | Intended jurisdiction for the charge item definition | ChargeItemDefinition.jurisdiction |
| publisher N | string | ChargeItemDefinition-publisher | Name of the publisher of the charge item definition | ChargeItemDefinition.publisher |
| status N | token | ChargeItemDefinition-status | The current status of the charge item definition | ChargeItemDefinition.status |
| title N | string | ChargeItemDefinition-title | The human-friendly name of the charge item definition | ChargeItemDefinition.title |
| url N | uri | ChargeItemDefinition-url | The uri that identifies the charge item definition | ChargeItemDefinition.url |
| version N | token | ChargeItemDefinition-version | The business version of the charge item definition | ChargeItemDefinition.version |
| Citation TU | ||||
| context | token | Citation-context | A use context assigned to the citation | (Citation.useContext.value as CodeableConcept) |
| context-quantity | quantity | Citation-context-quantity | A quantity- or range-valued use context assigned to the citation | (Citation.useContext.value as Quantity) | (Citation.useContext.value as Range) |
| context-type | token | Citation-context-type | A type of use context assigned to the citation | Citation.useContext.code |
| context-type-quantity | composite | Citation-context-type-quantity | A use context type and quantity- or range-based value assigned to the citation | Citation.useContext |
| context-type-value | composite | Citation-context-type-value | A use context type and value assigned to the citation | Citation.useContext |
| identifier | token | Citation-identifier | External identifier for the citation | Citation.identifier |
| status N | token | Citation-status | The current status of the citation | Citation.status |
| url N | uri | Citation-url | The uri that identifies the citation | Citation.url |
| version N | token | Citation-version | The business version of the citation | Citation.version |
| Claim TU | ||||
| care-team | reference | Claim-care-team | Member of the CareTeam | Claim.careTeam.provider |
| created N | 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 | Claim-encounter | 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 | Claim-identifier | 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 | Claim-patient | 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 N | 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 N | token | Claim-use | The kind of financial resource | Claim.use |
| ClaimResponse TU | ||||
| created N | date | ClaimResponse-created | The creation date | ClaimResponse.created |
| disposition N | string | ClaimResponse-disposition | The contents of the disposition message | ClaimResponse.disposition |
| identifier | token | ClaimResponse-identifier | The identity of the ClaimResponse | ClaimResponse.identifier |
| insurer | reference | ClaimResponse-insurer | The organization which generated this resource | ClaimResponse.insurer |
| outcome N | token | ClaimResponse-outcome | The processing outcome | ClaimResponse.outcome |
| patient | reference | ClaimResponse-patient | The subject of care | ClaimResponse.patient |
| payment-date N | 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 N | token | ClaimResponse-status | The status of the ClaimResponse | ClaimResponse.status |
| use N | token | ClaimResponse-use | The type of claim | ClaimResponse.use |
| ClinicalImpression TU | ||||
| date N | date | clinical-date | When the assessment was documented | ClinicalImpression.date |
| encounter | reference | ClinicalImpression-encounter | The Encounter during which this ClinicalImpression was created | ClinicalImpression.encounter |
| finding-code D | token | ClinicalImpression-finding-code | Reference to a concept (by class) | ClinicalImpression.finding.item.concept |
| finding-ref D | reference | ClinicalImpression-finding-ref | Reference to a resource (by instance) | ClinicalImpression.finding.item.reference |
| identifier | token | ClinicalImpression-identifier | Business identifier | ClinicalImpression.identifier |
| patient | reference | clinical-patient | Patient or group assessed | ClinicalImpression.subject.where(resolve() is Patient) |
| performer | reference | ClinicalImpression-performer | The clinician performing the assessment | ClinicalImpression.performer |
| previous | reference | ClinicalImpression-previous | Reference to last assessment | ClinicalImpression.previous |
| problem | reference | ClinicalImpression-problem | Relevant impressions of patient state | ClinicalImpression.problem |
| status N | 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 |
| ClinicalUseIssue TU | ||||
| contraindication | token | ClinicalUseIssue-contraindication | The situation that is being documented as contraindicating against this item | ClinicalUseIssue.contraindication.diseaseSymptomProcedure |
| effect | token | ClinicalUseIssue-effect | The situation in which the undesirable effect may manifest | ClinicalUseIssue.undesirableEffect.symptomConditionEffect |
| identifier | token | ClinicalUseIssue-identifier | Business identifier for this issue | ClinicalUseIssue.identifier |
| indication | token | ClinicalUseIssue-indication | The situation that is being documented as an indicaton for this item | ClinicalUseIssue.indication.diseaseSymptomProcedure |
| interaction | token | ClinicalUseIssue-interaction | The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction | ClinicalUseIssue.interaction.type |
| product | reference | ClinicalUseIssue-product | The medicinal product for which this is a clinical usage issue | ClinicalUseIssue.subject.where(resolve() is MedicinalProductDefinition) |
| subject | reference | ClinicalUseIssue-subject | The resource for which this is a clinical usage issue | ClinicalUseIssue.subject |
| type N | token | ClinicalUseIssue-type | indication | contraindication | interaction | undesirable-effect | warning | ClinicalUseIssue.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 | conformance-context | A use context assigned to the code system | (CodeSystem.useContext.value as CodeableConcept) |
| context-quantity TU | quantity | conformance-context-quantity | A quantity- or range-valued use context assigned to the code system | (CodeSystem.useContext.value as Quantity) | (CodeSystem.useContext.value as Range) |
| context-type TU | token | conformance-context-type | A type of use context assigned to the code system | CodeSystem.useContext.code |
| context-type-quantity TU | composite | conformance-context-type-quantity | A use context type and quantity- or range-based value assigned to the code system | CodeSystem.useContext |
| context-type-value TU | composite | conformance-context-type-value | A use context type and value assigned to the code system | CodeSystem.useContext |
| date | date | conformance-date | The code system publication date | CodeSystem.date |
| description | string | conformance-description | The description of the code system | CodeSystem.description |
| identifier TU | token | conformance-identifier | External identifier for the code system | CodeSystem.identifier |
| jurisdiction TU | token | conformance-jurisdiction | 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 | string | conformance-name | Computationally friendly name of the code system | CodeSystem.name |
| publisher | string | conformance-publisher | Name of the publisher of the code system | CodeSystem.publisher |
| status | token | conformance-status | The current status of the code system | CodeSystem.status |
| supplements | 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 | string | conformance-title | The human-friendly name of the code system | CodeSystem.title |
| url | uri | conformance-url | The uri that identifies the code system | CodeSystem.url |
| version | token | conformance-version | 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 | Communication-encounter | The Encounter during which this Communication was created | Communication.encounter |
| identifier | token | Communication-identifier | Unique identifier | Communication.identifier |
| instantiates-canonical N | reference | Communication-instantiates-canonical | Instantiates FHIR protocol or definition | Communication.instantiatesCanonical |
| instantiates-uri N | 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 referenced event (e.g. Communication, Procedure) | Communication.partOf |
| patient | reference | Communication-patient | Focus of message | Communication.subject.where(resolve() is Patient) |
| received N | date | Communication-received | When received | Communication.received |
| recipient | reference | Communication-recipient | Who the information is shared with | Communication.recipient |
| sender | reference | Communication-sender | Who shares the information | Communication.sender |
| sent N | date | Communication-sent | When sent | Communication.sent |
| status N | 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 N | 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 | CommunicationRequest-encounter | 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 | CommunicationRequest-identifier | 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 | CommunicationRequest.occurrence.as(dateTime) | CommunicationRequest.occurrence.as(Period) |
| patient | reference | CommunicationRequest-patient | Focus of message | CommunicationRequest.subject.where(resolve() is Patient) |
| priority N | token | CommunicationRequest-priority | routine | urgent | asap | stat | CommunicationRequest.priority |
| recipient | reference | CommunicationRequest-recipient | Who to share the information with | CommunicationRequest.recipient |
| replaces | reference | CommunicationRequest-replaces | Request(s) replaced by this request | CommunicationRequest.replaces |
| requester | reference | CommunicationRequest-requester | Who asks for the information to be shared | CommunicationRequest.requester |
| status N | 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 N | token | CompartmentDefinition-code | Patient | Encounter | RelatedPerson | Practitioner | Device | CompartmentDefinition.code |
| context | token | conformance-context | A use context assigned to the compartment definition | (CompartmentDefinition.useContext.value as CodeableConcept) |
| context-quantity | quantity | conformance-context-quantity | A quantity- or range-valued use context assigned to the compartment definition | (CompartmentDefinition.useContext.value as Quantity) | (CompartmentDefinition.useContext.value as Range) |
| context-type | token | conformance-context-type | A type of use context assigned to the compartment definition | CompartmentDefinition.useContext.code |
| context-type-quantity | composite | conformance-context-type-quantity | A use context type and quantity- or range-based value assigned to the compartment definition | CompartmentDefinition.useContext |
| context-type-value | composite | conformance-context-type-value | A use context type and value assigned to the compartment definition | CompartmentDefinition.useContext |
| date N | date | conformance-date | The compartment definition publication date | CompartmentDefinition.date |
| description N | string | conformance-description | The description of the compartment definition | CompartmentDefinition.description |
| name N | string | conformance-name | Computationally friendly name of the compartment definition | CompartmentDefinition.name |
| publisher N | string | conformance-publisher | Name of the publisher of the compartment definition | CompartmentDefinition.publisher |
| resource N | token | CompartmentDefinition-resource | Name of resource type | CompartmentDefinition.resource.code |
| status N | token | conformance-status | The current status of the compartment definition | CompartmentDefinition.status |
| url N | uri | conformance-url | The uri that identifies the compartment definition | CompartmentDefinition.url |
| version N | token | conformance-version | 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 |
| confidentiality N | token | Composition-confidentiality | As defined by affinity domain | Composition.confidentiality |
| context | token | Composition-context | Code(s) that apply to the event being documented | Composition.event.code |
| date N | 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 |
| related-id | token | Composition-related-id | Target of the relationship | (Composition.relatesTo.target as Identifier) |
| related-ref | reference | Composition-related-ref | Target of the relationship | (Composition.relatesTo.target as Reference) |
| section | token | Composition-section | Classification of section (recommended) | Composition.section.code |
| status N | 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 N | string | Composition-title | Human Readable name/title | Composition.title |
| type N | token | clinical-type | Kind of composition (LOINC if possible) | Composition.type |
| ConceptMap TU | ||||
| context | token | conformance-context | A use context assigned to the concept map | (ConceptMap.useContext.value as CodeableConcept) |
| context-quantity | quantity | conformance-context-quantity | A quantity- or range-valued use context assigned to the concept map | (ConceptMap.useContext.value as Quantity) | (ConceptMap.useContext.value as Range) |
| context-type | token | conformance-context-type | A type of use context assigned to the concept map | ConceptMap.useContext.code |
| context-type-quantity | composite | conformance-context-type-quantity | A use context type and quantity- or range-based value assigned to the concept map | ConceptMap.useContext |
| context-type-value | composite | conformance-context-type-value | A use context type and value assigned to the concept map | ConceptMap.useContext |
| date N | date | conformance-date | The concept map publication date | ConceptMap.date |
| dependson N | uri | ConceptMap-dependson | Reference to property mapping depends on | ConceptMap.group.element.target.dependsOn.property |
| description N | string | conformance-description | The description of the concept map | ConceptMap.description |
| identifier | token | conformance-identifier | External identifier for the concept map | ConceptMap.identifier |
| jurisdiction | token | conformance-jurisdiction | Intended jurisdiction for the concept map | ConceptMap.jurisdiction |
| name N | string | conformance-name | Computationally friendly name of the concept map | ConceptMap.name |
| other N | reference | ConceptMap-other | canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped | ConceptMap.group.unmapped.url |
| product N | uri | ConceptMap-product | Reference to property mapping depends on | ConceptMap.group.element.target.product.property |
| publisher N | string | conformance-publisher | Name of the publisher of the concept map | ConceptMap.publisher |
| source | reference | ConceptMap-source | The source value set that contains the concepts that are being mapped | (ConceptMap.source as canonical) |
| source-code N | token | ConceptMap-source-code | Identifies element being mapped | ConceptMap.group.element.code |
| source-system N | uri | ConceptMap-source-system | Source system where concepts to be mapped are defined | ConceptMap.group.source |
| source-uri | reference | ConceptMap-source-uri | The source value set that contains the concepts that are being mapped | (ConceptMap.source as uri) |
| status N | token | conformance-status | The current status of the concept map | ConceptMap.status |
| target | reference | ConceptMap-target | The target value set which provides context for the mappings | (ConceptMap.target as canonical) |
| target-code N | token | ConceptMap-target-code | Code that identifies the target element | ConceptMap.group.element.target.code |
| target-system N | uri | ConceptMap-target-system | Target system that the concepts are to be mapped to | ConceptMap.group.target |
| target-uri | reference | ConceptMap-target-uri | The target value set which provides context for the mappings | (ConceptMap.target as uri) |
| title N | string | conformance-title | The human-friendly name of the concept map | ConceptMap.title |
| url N | uri | conformance-url | The uri that identifies the concept map | ConceptMap.url |
| version N | token | conformance-version | The business version of the concept map | ConceptMap.version |
| Condition TU | ||||
| abatement-age | quantity | Condition-abatement-age | Abatement as age or age range | Condition.abatement.as(Age) | Condition.abatement.as(Range) |
| abatement-date | date | Condition-abatement-date | Date-related abatements (dateTime and period) | Condition.abatement.as(dateTime) | Condition.abatement.as(Period) |
| abatement-string | string | Condition-abatement-string | Abatement as a string | Condition.abatement.as(string) |
| asserter | reference | Condition-asserter | Person or device that asserts this condition | Condition.asserter |
| 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 | Condition-encounter | The Encounter during which this Condition was created | Condition.encounter |
| evidence | token | Condition-evidence | Manifestation/symptom | Condition.evidence.code |
| evidence-detail | reference | Condition-evidence-detail | Supporting information found elsewhere | Condition.evidence.detail |
| 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 | Condition.onset.as(Age) | Condition.onset.as(Range) |
| onset-date | date | Condition-onset-date | Date related onsets (dateTime and Period) | Condition.onset.as(dateTime) | Condition.onset.as(Period) |
| onset-info | string | Condition-onset-info | Onsets as a string | Condition.onset.as(string) |
| patient | reference | clinical-patient | Who has the condition? | Condition.subject.where(resolve() is Patient) |
| recorded-date N | 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 | ConditionDefinition-context | A use context assigned to the condition definition | (ConditionDefinition.useContext.value as CodeableConcept) |
| context-quantity | quantity | ConditionDefinition-context-quantity | A quantity- or range-valued use context assigned to the condition definition | (ConditionDefinition.useContext.value as Quantity) | (ConditionDefinition.useContext.value as Range) |
| context-type | token | ConditionDefinition-context-type | A type of use context assigned to the condition definition | ConditionDefinition.useContext.code |
| context-type-quantity | composite | ConditionDefinition-context-type-quantity | A use context type and quantity- or range-based value assigned to the condition definition | ConditionDefinition.useContext |
| context-type-value | composite | ConditionDefinition-context-type-value | A use context type and value assigned to the condition definition | ConditionDefinition.useContext |
| date N | date | ConditionDefinition-date | The condition definition publication date | ConditionDefinition.date |
| description N | string | ConditionDefinition-description | The description of the condition definition | ConditionDefinition.description |
| identifier | token | ConditionDefinition-identifier | External identifier for the condition definition | ConditionDefinition.identifier |
| jurisdiction | token | ConditionDefinition-jurisdiction | Intended jurisdiction for the condition definition | ConditionDefinition.jurisdiction |
| name N | string | ConditionDefinition-name | Computationally friendly name of the condition definition | ConditionDefinition.name |
| publisher N | string | ConditionDefinition-publisher | Name of the publisher of the condition definition | ConditionDefinition.publisher |
| status N | token | ConditionDefinition-status | The current status of the condition definition | ConditionDefinition.status |
| title N | string | ConditionDefinition-title | The human-friendly name of the condition definition | ConditionDefinition.title |
| url N | uri | ConditionDefinition-url | The uri that identifies the condition definition | ConditionDefinition.url |
| version N | token | ConditionDefinition-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 |
| consentor | reference | Consent-consentor | Who is agreeing to the policy and rules | Consent.performer |
| data | reference | Consent-data | The actual data reference | Consent.provision.data.reference |
| date N | date | clinical-date | When consent was agreed to | Consent.dateTime |
| identifier | token | clinical-identifier | Identifier for this record (external references) | Consent.identifier |
| organization | reference | Consent-organization | Custodian of the consent | Consent.organization |
| patient | reference | clinical-patient | Who the consent applies to | Consent.subject.where(resolve() is Patient) |
| period | date | Consent-period | Timeframe for this rule | Consent.provision.period |
| policy-uri N | uri | Consent-policy-uri | Search for Consents aligned with a specific policy or policy date/version. URIs should be complete with date/version and not assume the Resource will maintain versioning information | Consent.policy.uri |
| purpose | token | Consent-purpose | Context of activities covered by this rule | Consent.provision.purpose |
| scope | token | Consent-scope | Which of the four areas this resource covers (extensible) | Consent.scope |
| security-label | 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 | Consent.sourceReference |
| status N | token | Consent-status | draft | active | inactive | entered-in-error | unknown | Consent.status |
| subject | reference | Consent-subject | Who the consent applies to | Consent.subject |
| verified N | token | Consent-verified | Has been verified | Consent.verification.verified |
| verified-date N | 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 | Contract-identifier | The identity of the contract | Contract.identifier |
| instantiates N | uri | Contract-instantiates | A source definition of the contract | Contract.instantiatesUri |
| issued N | date | Contract-issued | The date/time the contract was issued | Contract.issued |
| patient | reference | Contract-patient | 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 N | 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 N | 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 (eg. plan, group) | Coverage.class.type |
| class-value N | string | Coverage-class-value | Value of the class (eg. Plan number, group number) | Coverage.class.value |
| dependent N | string | Coverage-dependent | Dependent number | Coverage.dependent |
| identifier | token | Coverage-identifier | The primary identifier of the insured and the coverage | Coverage.identifier |
| patient | reference | Coverage-patient | Retrieve coverages for a patient | Coverage.beneficiary |
| payor | reference | Coverage-payor | The identity of the insurer or party paying for services | Coverage.payor |
| policy-holder | reference | Coverage-policy-holder | Reference to the policyholder | Coverage.policyHolder |
| status N | token | Coverage-status | The status of the Coverage | Coverage.status |
| subscriber | reference | Coverage-subscriber | Reference to the subscriber | Coverage.subscriber |
| type | token | Coverage-type | The kind of coverage (health plan, auto, Workers Compensation) | Coverage.type |
| CoverageEligibilityRequest TU | ||||
| created N | 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 | CoverageEligibilityRequest-identifier | The business identifier of the Eligibility | CoverageEligibilityRequest.identifier |
| patient | reference | CoverageEligibilityRequest-patient | The reference to the patient | CoverageEligibilityRequest.patient |
| provider | reference | CoverageEligibilityRequest-provider | The reference to the provider | CoverageEligibilityRequest.provider |
| status N | token | CoverageEligibilityRequest-status | The status of the EligibilityRequest | CoverageEligibilityRequest.status |
| CoverageEligibilityResponse TU | ||||
| created N | date | CoverageEligibilityResponse-created | The creation date | CoverageEligibilityResponse.created |
| disposition N | string | CoverageEligibilityResponse-disposition | The contents of the disposition message | CoverageEligibilityResponse.disposition |
| identifier | token | CoverageEligibilityResponse-identifier | The business identifier | CoverageEligibilityResponse.identifier |
| insurer | reference | CoverageEligibilityResponse-insurer | The organization which generated this resource | CoverageEligibilityResponse.insurer |
| outcome N | token | CoverageEligibilityResponse-outcome | The processing outcome | CoverageEligibilityResponse.outcome |
| patient | reference | CoverageEligibilityResponse-patient | 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 N | token | CoverageEligibilityResponse-status | The EligibilityRequest status | CoverageEligibilityResponse.status |
| DetectedIssue TU | ||||
| author | reference | DetectedIssue-author | The provider or device that identified the issue | DetectedIssue.author |
| code | token | DetectedIssue-code | Issue Category, e.g. drug-drug, duplicate therapy, etc. | DetectedIssue.code |
| identified | date | DetectedIssue-identified | When identified | DetectedIssue.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 | DetectedIssue.patient |
| Device TU | ||||
| definition | reference | Device-definition | The definition / type of the device | Device.definition |
| device-name | string | Device-device-name | A server defined search that may match any of the string fields in Device.deviceName or Device.type. | Device.deviceName.name | Device.type.coding.display | Device.type.text |
| expiration-date N | 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 N | string | Device-lot-number | The lot number of the device | Device.lotNumber |
| manufacture-date N | date | Device-manufacture-date | The manufacture date of the device | Device.manufactureDate |
| manufacturer N | string | Device-manufacturer | The manufacturer of the device | Device.manufacturer |
| model N | string | Device-model | The model of the device | Device.modelNumber |
| organization | reference | Device-organization | The organization responsible for the device | Device.owner |
| parent | reference | Device-parent | The parent device | Device.parent |
| patient | reference | Device-patient | Patient information, if the resource is affixed to a person | Device.patient |
| serial-number N | string | Device-serial-number | The serial number of the device | Device.serialNumber |
| status N | 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 N | uri | Device-url | Network address to contact device | Device.url |
| version N | string | Device-version | The specific version of the device | Device.version.value |
| DeviceDefinition TU | ||||
| identifier | token | DeviceDefinition-identifier | The identifier of the component | DeviceDefinition.identifier |
| parent | reference | DeviceDefinition-parent | The parent DeviceDefinition resource | DeviceDefinition.parentDevice |
| type | token | DeviceDefinition-type | The device component type | DeviceDefinition.type |
| DeviceMetric TU | ||||
| category N | token | DeviceMetric-category | The category of the metric | DeviceMetric.category |
| identifier | token | DeviceMetric-identifier | The identifier of the metric | DeviceMetric.identifier |
| parent | reference | DeviceMetric-parent | The parent DeviceMetric resource | DeviceMetric.parent |
| source | reference | DeviceMetric-source | The device resource | DeviceMetric.source |
| type | token | DeviceMetric-type | The component type | DeviceMetric.type |
| DeviceRequest TU | ||||
| authored-on N | 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 | DeviceRequest.code.concept |
| device D | reference | DeviceRequest-device | Reference to resource that is being requested/ordered | DeviceRequest.code.reference |
| encounter | reference | clinical-encounter | Encounter during which request was created | DeviceRequest.encounter |
| event-date | date | DeviceRequest-event-date | When service should occur | (DeviceRequest.occurrence as dateTime) | (DeviceRequest.occurrence as Period) |
| 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 N | reference | DeviceRequest-instantiates-canonical | Instantiates FHIR protocol or definition | DeviceRequest.instantiatesCanonical |
| instantiates-uri N | uri | DeviceRequest-instantiates-uri | Instantiates external protocol or definition | DeviceRequest.instantiatesUri |
| insurance | reference | DeviceRequest-insurance | Associated insurance coverage | DeviceRequest.insurance |
| intent N | 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 | DeviceRequest.performer |
| prior-request | reference | DeviceRequest-prior-request | Request takes the place of referenced completed or terminated requests | DeviceRequest.priorRequest |
| requester | reference | DeviceRequest-requester | Who/what is requesting service | DeviceRequest.requester |
| status N | token | DeviceRequest-status | entered-in-error | draft | active |suspended | completed | DeviceRequest.status |
| subject | reference | DeviceRequest-subject | Individual the service is ordered for | DeviceRequest.subject |
| DeviceUseStatement TU | ||||
| device D | token | DeviceUseStatement-device | Search by device | DeviceUseStatement.device.concept |
| identifier | token | DeviceUseStatement-identifier | Search by identifier | DeviceUseStatement.identifier |
| patient | reference | clinical-patient | Search by subject - a patient | DeviceUseStatement.subject |
| subject | reference | DeviceUseStatement-subject | Search by subject | DeviceUseStatement.subject |
| 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 N | date | clinical-date | The clinically relevant time of the report | DiagnosticReport.effective |
| 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 N | 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 N | token | DiagnosticReport-status | The status of the report | DiagnosticReport.status |
| subject | reference | DiagnosticReport-subject | The subject of the report | DiagnosticReport.subject |
| DocumentManifest TU | ||||
| author | reference | DocumentManifest-author | Who and/or what authored the DocumentManifest | DocumentManifest.author |
| created N | date | DocumentManifest-created | When this document manifest created | DocumentManifest.created |
| description N | string | DocumentManifest-description | Human-readable description (title) | DocumentManifest.description |
| identifier | token | clinical-identifier | Unique Identifier for the set of documents | DocumentManifest.masterIdentifier | DocumentManifest.identifier |
| item | reference | DocumentManifest-item | Items in manifest | DocumentManifest.content |
| patient | reference | clinical-patient | The subject of the set of documents | DocumentManifest.subject.where(resolve() is Patient) |
| recipient | reference | DocumentManifest-recipient | Intended to get notified about this set of documents | DocumentManifest.recipient |
| related-id | token | DocumentManifest-related-id | Identifiers of things that are related | DocumentManifest.related.identifier |
| related-ref | reference | DocumentManifest-related-ref | Related Resource | DocumentManifest.related.ref |
| source N | uri | DocumentManifest-source | The source system/application/software | DocumentManifest.source |
| status N | token | DocumentManifest-status | current | superseded | entered-in-error | DocumentManifest.status |
| subject | reference | DocumentManifest-subject | The subject of the set of documents | DocumentManifest.subject |
| type N | token | clinical-type | Kind of document set | DocumentManifest.type |
| DocumentReference TU | ||||
| authenticator | reference | DocumentReference-authenticator | Who/what authenticated the document | DocumentReference.authenticator |
| author | reference | DocumentReference-author | Who and/or what authored the document | DocumentReference.author |
| based-on | reference | DocumentReference-based-on | Procedure that caused this media to be created | DocumentReference.context.basedOn |
| category | token | DocumentReference-category | Categorization of document | DocumentReference.category |
| contenttype N | token | DocumentReference-contenttype | Mime type of the content, with charset etc. | DocumentReference.content.attachment.contentType |
| creation N | date | DocumentReference-creation | Date attachment was first created | DocumentReference.content.attachment.creation |
| custodian | reference | DocumentReference-custodian | Organization which maintains the document | DocumentReference.custodian |
| date N | date | DocumentReference-date | When this document reference was created | DocumentReference.date |
| description N | string | DocumentReference-description | Human-readable description | DocumentReference.description |
| doc-status N | token | DocumentReference-doc-status | preliminary | final | amended | entered-in-error | DocumentReference.docStatus |
| encounter | reference | clinical-encounter | Context of the document content | DocumentReference.context.encounter |
| event | token | DocumentReference-event | Main clinical acts documented | DocumentReference.context.event |
| facility | token | DocumentReference-facility | Kind of facility where patient was seen | DocumentReference.context.facilityType |
| format | token | DocumentReference-format | Format/content rules for the document | DocumentReference.content.format |
| identifier | token | clinical-identifier | Master Version Specific Identifier | DocumentReference.masterIdentifier | DocumentReference.identifier |
| language N | token | DocumentReference-language | Human language of the content (BCP-47) | DocumentReference.content.attachment.language |
| location N | uri | DocumentReference-location | Uri where the data can be found | DocumentReference.content.attachment.url |
| patient | reference | clinical-patient | Who/what is the subject of the document | DocumentReference.subject.where(resolve() is Patient) |
| period | date | DocumentReference-period | Time of service that is being documented | DocumentReference.context.period |
| related | reference | DocumentReference-related | Related identifiers or resources | DocumentReference.context.related |
| relatesto | reference | DocumentReference-relatesto | Target of the relationship | DocumentReference.relatesTo.target |
| relation N | 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) | DocumentReference.context.practiceSetting |
| status N | 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 N | token | clinical-type | Kind of document (LOINC if possible) | DocumentReference.type |
| 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 |
| class | token | Encounter-class | Classification of patient encounter | Encounter.class |
| date N | date | clinical-date | A date within the period the Encounter lasted | Encounter.period |
| diagnosis | reference | Encounter-diagnosis | The diagnosis or procedure relevant to the encounter | Encounter.diagnosis.condition |
| 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 | date | Encounter-location-period | Time period during which the patient was present at the location | Encounter.location.period |
| 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 | Encounter.participant.individual |
| participant-type | token | Encounter-participant-type | Role of participant in encounter | Encounter.participant.type |
| patient | reference | clinical-patient | The patient or group present at the encounter | Encounter.subject.where(resolve() is Patient) |
| practitioner | reference | Encounter-practitioner | Persons involved in the encounter other than the patient | Encounter.participant.individual.where(resolve() is Practitioner) |
| reason-code D | token | Encounter-reason-code | Reference to a concept (by class) | Encounter.reason.concept |
| reason-reference D | reference | Encounter-reason-reference | Reference to a resource (by instance) | 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. | Encounter.hospitalization.specialArrangement |
| status N | token | Encounter-status | planned | in-progress | onhold | completed | cancelled | entered-in-error | unknown | 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 N | token | clinical-type | Specific type of encounter | Encounter.type |
| 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 N | 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) | Endpoint.payloadType |
| status N | token | Endpoint-status | The current status of the Endpoint (usually expected to be active) | Endpoint.status |
| EnrollmentRequest TU | ||||
| identifier | token | EnrollmentRequest-identifier | The business identifier of the Enrollment | EnrollmentRequest.identifier |
| patient | reference | EnrollmentRequest-patient | The party to be enrolled | EnrollmentRequest.candidate |
| status N | 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 N | 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) |
| condition | reference | EpisodeOfCare-condition | Conditions/problems/diagnoses this episode of care is for | EpisodeOfCare.diagnosis.condition |
| date N | date | clinical-date | The provided date search value falls within the episode of care's period | EpisodeOfCare.period |
| 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 |
| status N | token | EpisodeOfCare-status | The current status of the Episode of Care as provided (does not check the status history collection) | EpisodeOfCare.status |
| type N | token | clinical-type | Type/class - e.g. specialist referral, disease management | EpisodeOfCare.type |
| EventDefinition TU | ||||
| composed-of | reference | EventDefinition-composed-of | What resource is being referenced | EventDefinition.relatedArtifact.where(type='composed-of').resource |
| context | token | EventDefinition-context | A use context assigned to the event definition | (EventDefinition.useContext.value as CodeableConcept) |
| context-quantity | quantity | EventDefinition-context-quantity | A quantity- or range-valued use context assigned to the event definition | (EventDefinition.useContext.value as Quantity) | (EventDefinition.useContext.value as Range) |
| context-type | token | EventDefinition-context-type | A type of use context assigned to the event definition | EventDefinition.useContext.code |
| context-type-quantity | composite | EventDefinition-context-type-quantity | A use context type and quantity- or range-based value assigned to the event definition | EventDefinition.useContext |
| context-type-value | composite | EventDefinition-context-type-value | A use context type and value assigned to the event definition | EventDefinition.useContext |
| date N | date | EventDefinition-date | The event definition publication date | EventDefinition.date |
| depends-on | reference | EventDefinition-depends-on | What resource is being referenced | EventDefinition.relatedArtifact.where(type='depends-on').resource |
| derived-from | reference | EventDefinition-derived-from | What resource is being referenced | EventDefinition.relatedArtifact.where(type='derived-from').resource |
| description N | string | EventDefinition-description | The description of the event definition | EventDefinition.description |
| effective | date | EventDefinition-effective | The time during which the event definition is intended to be in use | EventDefinition.effectivePeriod |
| identifier | token | EventDefinition-identifier | External identifier for the event definition | EventDefinition.identifier |
| jurisdiction | token | EventDefinition-jurisdiction | Intended jurisdiction for the event definition | EventDefinition.jurisdiction |
| name N | string | EventDefinition-name | Computationally friendly name of the event definition | EventDefinition.name |
| predecessor | reference | EventDefinition-predecessor | What resource is being referenced | EventDefinition.relatedArtifact.where(type='predecessor').resource |
| publisher N | string | EventDefinition-publisher | Name of the publisher of the event definition | EventDefinition.publisher |
| status N | token | EventDefinition-status | The current status of the event definition | EventDefinition.status |
| successor | reference | EventDefinition-successor | What resource is being referenced | EventDefinition.relatedArtifact.where(type='successor').resource |
| title N | string | EventDefinition-title | The human-friendly name of the event definition | EventDefinition.title |
| topic | token | EventDefinition-topic | Topics associated with the module | EventDefinition.topic |
| url N | uri | EventDefinition-url | The uri that identifies the event definition | EventDefinition.url |
| version N | token | EventDefinition-version | The business version of the event definition | EventDefinition.version |
| Evidence TU | ||||
| context | token | Evidence-context | A use context assigned to the evidence | (Evidence.useContext.value as CodeableConcept) |
| context-quantity | quantity | Evidence-context-quantity | A quantity- or range-valued use context assigned to the evidence | (Evidence.useContext.value as Quantity) | (Evidence.useContext.value as Range) |
| context-type | token | Evidence-context-type | A type of use context assigned to the evidence | Evidence.useContext.code |
| context-type-quantity | composite | Evidence-context-type-quantity | A use context type and quantity- or range-based value assigned to the evidence | Evidence.useContext |
| context-type-value | composite | Evidence-context-type-value | A use context type and value assigned to the evidence | Evidence.useContext |
| date N | date | Evidence-date | The evidence publication date | Evidence.date |
| description N | string | Evidence-description | The description of the evidence | Evidence.description |
| identifier | token | Evidence-identifier | External identifier for the evidence | Evidence.identifier |
| status N | token | Evidence-status | The current status of the evidence | Evidence.status |
| title N | string | Evidence-title | The human-friendly name of the evidence | Evidence.title |
| url N | uri | Evidence-url | The uri that identifies the evidence | Evidence.url |
| version N | token | Evidence-version | The business version of the evidence | Evidence.version |
| EvidenceFocus TU | ||||
| context | token | EvidenceFocus-context | A use context assigned to the evidence focus | (EvidenceFocus.useContext.value as CodeableConcept) |
| context-quantity | quantity | EvidenceFocus-context-quantity | A quantity- or range-valued use context assigned to the evidence focus | (EvidenceFocus.useContext.value as Quantity) | (EvidenceFocus.useContext.value as Range) |
| context-type | token | EvidenceFocus-context-type | A type of use context assigned to the evidence focus | EvidenceFocus.useContext.code |
| context-type-quantity | composite | EvidenceFocus-context-type-quantity | A use context type and quantity- or range-based value assigned to the evidence focus | EvidenceFocus.useContext |
| context-type-value | composite | EvidenceFocus-context-type-value | A use context type and value assigned to the evidence focus | EvidenceFocus.useContext |
| date N | date | EvidenceFocus-date | The evidence focus publication date | EvidenceFocus.date |
| identifier | token | EvidenceFocus-identifier | External identifier for the evidence focus | EvidenceFocus.identifier |
| name N | string | EvidenceFocus-name | Computationally friendly name of the evidence focus | EvidenceFocus.name |
| status N | token | EvidenceFocus-status | The current status of the evidence focus | EvidenceFocus.status |
| url N | uri | EvidenceFocus-url | The uri that identifies the evidence focus | EvidenceFocus.url |
| version N | token | EvidenceFocus-version | The business version of the evidence focus | EvidenceFocus.version |
| EvidenceVariable TU | ||||
| composed-of | reference | EvidenceVariable-composed-of | What resource is being referenced | EvidenceVariable.relatedArtifact.where(type='composed-of').resource |
| context | token | EvidenceVariable-context | A use context assigned to the evidence variable | (EvidenceVariable.useContext.value as CodeableConcept) |
| context-quantity | quantity | EvidenceVariable-context-quantity | A quantity- or range-valued use context assigned to the evidence variable | (EvidenceVariable.useContext.value as Quantity) | (EvidenceVariable.useContext.value as Range) |
| context-type | token | EvidenceVariable-context-type | A type of use context assigned to the evidence variable | EvidenceVariable.useContext.code |
| context-type-quantity | composite | EvidenceVariable-context-type-quantity | A use context type and quantity- or range-based value assigned to the evidence variable | EvidenceVariable.useContext |
| context-type-value | composite | EvidenceVariable-context-type-value | A use context type and value assigned to the evidence variable | EvidenceVariable.useContext |
| date N | date | EvidenceVariable-date | The evidence variable publication date | EvidenceVariable.date |
| depends-on | reference | EvidenceVariable-depends-on | What resource is being referenced | EvidenceVariable.relatedArtifact.where(type='depends-on').resource |
| derived-from | reference | EvidenceVariable-derived-from | What resource is being referenced | EvidenceVariable.relatedArtifact.where(type='derived-from').resource |
| description N | string | EvidenceVariable-description | The description of the evidence variable | EvidenceVariable.description |
| effective | date | EvidenceVariable-effective | The time during which the evidence variable is intended to be in use | EvidenceVariable.effectivePeriod |
| identifier | token | EvidenceVariable-identifier | External identifier for the evidence variable | EvidenceVariable.identifier |
| jurisdiction | token | EvidenceVariable-jurisdiction | Intended jurisdiction for the evidence variable | EvidenceVariable.jurisdiction |
| name N | string | EvidenceVariable-name | Computationally friendly name of the evidence variable | EvidenceVariable.name |
| predecessor | reference | EvidenceVariable-predecessor | What resource is being referenced | EvidenceVariable.relatedArtifact.where(type='predecessor').resource |
| publisher N | string | EvidenceVariable-publisher | Name of the publisher of the evidence variable | EvidenceVariable.publisher |
| status N | token | EvidenceVariable-status | The current status of the evidence variable | EvidenceVariable.status |
| successor | reference | EvidenceVariable-successor | What resource is being referenced | EvidenceVariable.relatedArtifact.where(type='successor').resource |
| title N | string | EvidenceVariable-title | The human-friendly name of the evidence variable | EvidenceVariable.title |
| topic | token | EvidenceVariable-topic | Topics associated with the EvidenceVariable | EvidenceVariable.topic |
| url N | uri | EvidenceVariable-url | The uri that identifies the evidence variable | EvidenceVariable.url |
| version N | token | EvidenceVariable-version | The business version of the evidence variable | EvidenceVariable.version |
| ExampleScenario TU | ||||
| context | token | ExampleScenario-context | A use context assigned to the example scenario | (ExampleScenario.useContext.value as CodeableConcept) |
| context-quantity | quantity | ExampleScenario-context-quantity | A quantity- or range-valued use context assigned to the example scenario | (ExampleScenario.useContext.value as Quantity) | (ExampleScenario.useContext.value as Range) |
| context-type | token | ExampleScenario-context-type | A type of use context assigned to the example scenario | ExampleScenario.useContext.code |
| context-type-quantity | composite | ExampleScenario-context-type-quantity | A use context type and quantity- or range-based value assigned to the example scenario | ExampleScenario.useContext |
| context-type-value | composite | ExampleScenario-context-type-value | A use context type and value assigned to the example scenario | ExampleScenario.useContext |
| date N | date | ExampleScenario-date | The example scenario publication date | ExampleScenario.date |
| identifier | token | ExampleScenario-identifier | External identifier for the example scenario | ExampleScenario.identifier |
| jurisdiction | token | ExampleScenario-jurisdiction | Intended jurisdiction for the example scenario | ExampleScenario.jurisdiction |
| name N | string | ExampleScenario-name | Computationally friendly name of the example scenario | ExampleScenario.name |
| publisher N | string | ExampleScenario-publisher | Name of the publisher of the example scenario | ExampleScenario.publisher |
| status N | token | ExampleScenario-status | The current status of the example scenario | ExampleScenario.status |
| url N | uri | ExampleScenario-url | The uri that identifies the example scenario | ExampleScenario.url |
| version N | token | ExampleScenario-version | 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 N | 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 N | string | ExplanationOfBenefit-disposition | The contents of the disposition message | ExplanationOfBenefit.disposition |
| encounter | reference | ExplanationOfBenefit-encounter | 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 | ExplanationOfBenefit-identifier | 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 | ExplanationOfBenefit-patient | 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 N | 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 N | 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 N | reference | FamilyMemberHistory-instantiates-canonical | Instantiates FHIR protocol or definition | FamilyMemberHistory.instantiatesCanonical |
| instantiates-uri N | 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 N | token | FamilyMemberHistory-status | partial | completed | entered-in-error | health-unknown | FamilyMemberHistory.status |
| Flag TU | ||||
| author | reference | Flag-author | Flag creator | Flag.author |
| date N | date | clinical-date | Time period when flag is active | Flag.period |
| encounter | reference | clinical-encounter | Alert relevant during encounter | Flag.encounter |
| identifier | token | Flag-identifier | Business identifier | Flag.identifier |
| patient | reference | clinical-patient | The identity of a subject to list flags for | Flag.subject.where(resolve() is Patient) |
| status N | 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 |
| Goal TU | ||||
| achievement-status | token | Goal-achievement-status | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable | Goal.achievementStatus |
| category | token | Goal-category | E.g. Treatment, dietary, behavioral, etc. | Goal.category |
| identifier | token | clinical-identifier | External Ids for this goal | Goal.identifier |
| lifecycle-status N | 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 | (Goal.start as date) |
| subject | reference | Goal-subject | Who this goal is intended for | Goal.subject |
| target-date | date | Goal-target-date | Reach goal on or before | (Goal.target.due as date) |
| GraphDefinition TU | ||||
| context | token | conformance-context | A use context assigned to the graph definition | (GraphDefinition.useContext.value as CodeableConcept) |
| context-quantity | quantity | conformance-context-quantity | A quantity- or range-valued use context assigned to the graph definition | (GraphDefinition.useContext.value as Quantity) | (GraphDefinition.useContext.value as Range) |
| context-type | token | conformance-context-type | A type of use context assigned to the graph definition | GraphDefinition.useContext.code |
| context-type-quantity | composite | conformance-context-type-quantity | A use context type and quantity- or range-based value assigned to the graph definition | GraphDefinition.useContext |
| context-type-value | composite | conformance-context-type-value | A use context type and value assigned to the graph definition | GraphDefinition.useContext |
| date N | date | conformance-date | The graph definition publication date | GraphDefinition.date |
| description N | string | conformance-description | The description of the graph definition | GraphDefinition.description |
| jurisdiction | token | conformance-jurisdiction | Intended jurisdiction for the graph definition | GraphDefinition.jurisdiction |
| name N | string | conformance-name | Computationally friendly name of the graph definition | GraphDefinition.name |
| publisher N | string | conformance-publisher | Name of the publisher of the graph definition | GraphDefinition.publisher |
| start N | token | GraphDefinition-start | Type of resource at which the graph starts | GraphDefinition.start |
| status N | token | conformance-status | The current status of the graph definition | GraphDefinition.status |
| url N | uri | conformance-url | The uri that identifies the graph definition | GraphDefinition.url |
| version N | token | conformance-version | The business version of the graph definition | GraphDefinition.version |
| Group TU | ||||
| actual N | token | Group-actual | Descriptive or actual | Group.actual |
| characteristic | token | Group-characteristic | Kind of characteristic | Group.characteristic.code |
| 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 N | 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 |
| type N | token | Group-type | The type of resources the group contains | Group.type |
| value | token | Group-value | Value held by characteristic | (Group.characteristic.value as CodeableConcept) | (Group.characteristic.value as boolean) |
| GuidanceResponse TU | ||||
| identifier | token | GuidanceResponse-identifier | The identifier of the guidance response | GuidanceResponse.identifier |
| patient | reference | GuidanceResponse-patient | 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 |
| subject | reference | GuidanceResponse-subject | The subject that the guidance response is about | GuidanceResponse.subject |
| HealthcareService TU | ||||
| active N | 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 |
| coverage-area | reference | HealthcareService-coverage-area | Location(s) service is intended for/available to | HealthcareService.coverageArea |
| 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 N | string | HealthcareService-name | A portion of the Healthcare service name | HealthcareService.name |
| 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 |
| ImagingStudy TU | ||||
| basedon | reference | ImagingStudy-basedon | The order for the image | ImagingStudy.basedOn |
| bodysite | token | ImagingStudy-bodysite | The body site studied | ImagingStudy.series.bodySite |
| dicom-class | token | ImagingStudy-dicom-class | The type of the instance | ImagingStudy.series.instance.sopClass |
| encounter | reference | ImagingStudy-encounter | 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 and Accession number | ImagingStudy.identifier |
| instance N | token | ImagingStudy-instance | SOP Instance UID for an instance | ImagingStudy.series.instance.uid |
| interpreter | reference | ImagingStudy-interpreter | Who interpreted the images | ImagingStudy.interpreter |
| modality | 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 N | token | ImagingStudy-series | DICOM Series Instance UID for a series | ImagingStudy.series.uid |
| started N | date | ImagingStudy-started | When the study was started | ImagingStudy.started |
| status N | token | ImagingStudy-status | The status of the study | ImagingStudy.status |
| subject | reference | ImagingStudy-subject | Who the study is about | ImagingStudy.subject |
| Immunization TU | ||||
| date N | date | clinical-date | Vaccination (non)-Administration Date | (Immunization.occurrence as dateTime) |
| 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 N | string | Immunization-lot-number | Vaccine Lot Number | Immunization.lotNumber |
| manufacturer | reference | Immunization-manufacturer | Vaccine Manufacturer | Immunization.manufacturer |
| patient | reference | clinical-patient | The patient for the vaccination record | Immunization.patient |
| performer | reference | Immunization-performer | The practitioner or organization who played a role in the vaccination | Immunization.performer.actor |
| reaction | reference | Immunization-reaction | Additional information on reaction | Immunization.reaction.detail |
| reaction-date N | date | Immunization-reaction-date | When reaction started | Immunization.reaction.date |
| reason-code D | token | Immunization-reason-code | Reason why the vaccine was administered | Immunization.reason.concept |
| reason-reference D | reference | Immunization-reason-reference | Reference to a resource (by instance) | Immunization.reason.reference |
| series N | string | Immunization-series | The series being followed by the provider | Immunization.protocolApplied.series |
| status N | 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 N | date | ImmunizationEvaluation-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 | ImmunizationEvaluation-identifier | ID of the evaluation | ImmunizationEvaluation.identifier |
| immunization-event | reference | ImmunizationEvaluation-immunization-event | The vaccine administration event being evaluated | ImmunizationEvaluation.immunizationEvent |
| patient | reference | ImmunizationEvaluation-patient | The patient being evaluated | ImmunizationEvaluation.patient |
| status N | 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 N | date | ImmunizationRecommendation-date | Date recommendation(s) created | ImmunizationRecommendation.date |
| identifier | token | ImmunizationRecommendation-identifier | Business identifier | ImmunizationRecommendation.identifier |
| information | reference | ImmunizationRecommendation-information | Patient observations supporting recommendation | ImmunizationRecommendation.recommendation.supportingPatientInformation |
| patient | reference | ImmunizationRecommendation-patient | 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 | conformance-context | A use context assigned to the implementation guide | (ImplementationGuide.useContext.value as CodeableConcept) |
| context-quantity | quantity | conformance-context-quantity | A quantity- or range-valued use context assigned to the implementation guide | (ImplementationGuide.useContext.value as Quantity) | (ImplementationGuide.useContext.value as Range) |
| context-type | token | conformance-context-type | A type of use context assigned to the implementation guide | ImplementationGuide.useContext.code |
| context-type-quantity | composite | conformance-context-type-quantity | A use context type and quantity- or range-based value assigned to the implementation guide | ImplementationGuide.useContext |
| context-type-value | composite | conformance-context-type-value | A use context type and value assigned to the implementation guide | ImplementationGuide.useContext |
| date N | date | conformance-date | The implementation guide publication date | ImplementationGuide.date |
| depends-on N | reference | ImplementationGuide-depends-on | Identity of the IG that this depends on | ImplementationGuide.dependsOn.uri |
| description N | string | conformance-description | The description of the implementation guide | ImplementationGuide.description |
| experimental N | token | ImplementationGuide-experimental | For testing purposes, not real usage | ImplementationGuide.experimental |
| global N | reference | ImplementationGuide-global | Profile that all resources must conform to | ImplementationGuide.global.profile |
| jurisdiction | token | conformance-jurisdiction | Intended jurisdiction for the implementation guide | ImplementationGuide.jurisdiction |
| name N | string | conformance-name | Computationally friendly name of the implementation guide | ImplementationGuide.name |
| publisher N | string | conformance-publisher | Name of the publisher of the implementation guide | ImplementationGuide.publisher |
| resource | reference | ImplementationGuide-resource | Location of the resource | ImplementationGuide.definition.resource.reference |
| status N | token | conformance-status | The current status of the implementation guide | ImplementationGuide.status |
| title N | string | conformance-title | The human-friendly name of the implementation guide | ImplementationGuide.title |
| url N | uri | conformance-url | The uri that identifies the implementation guide | ImplementationGuide.url |
| version N | token | conformance-version | The business version of the implementation guide | ImplementationGuide.version |
| Ingredient TU | ||||
| identifier | token | Ingredient-identifier | An identifier or code by which the ingredient can be referenced | Ingredient.identifier |
| specified-substance | token | Ingredient-specified-substance | Substance as a 'specified substance', implying extra substance related characteristics | (Ingredient.specifiedSubstance.code as CodeableConcept) |
| substance | token | Ingredient-substance | A code that represents the ingredient substance | (Ingredient.substance.code as CodeableConcept) |
| 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 N | string | InsurancePlan-address-city | A city specified in an address | InsurancePlan.contact.address.city |
| address-country N | string | InsurancePlan-address-country | A country specified in an address | InsurancePlan.contact.address.country |
| address-postalcode N | string | InsurancePlan-address-postalcode | A postal code specified in an address | InsurancePlan.contact.address.postalCode |
| address-state N | string | InsurancePlan-address-state | A state specified in an address | InsurancePlan.contact.address.state |
| address-use N | 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 | name | alias |
| owned-by | reference | InsurancePlan-owned-by | An organization of which this organization forms a part | InsurancePlan.ownedBy |
| phonetic N | string | InsurancePlan-phonetic | A portion of the organization's name using some kind of phonetic matching algorithm | InsurancePlan.name |
| status N | token | InsurancePlan-status | Is the Organization record active | InsurancePlan.status |
| type | token | InsurancePlan-type | A code for the type of organization | InsurancePlan.type |
| Invoice TU | ||||
| account | reference | Invoice-account | Account that is being balanced | Invoice.account |
| date N | date | Invoice-date | Invoice date / posting date | Invoice.date |
| identifier | token | Invoice-identifier | 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 | Invoice-patient | Recipient(s) of goods and services | Invoice.subject.where(resolve() is Patient) |
| recipient | reference | Invoice-recipient | Recipient of this invoice | Invoice.recipient |
| status N | 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 | Invoice-type | Type of Invoice | Invoice.type |
| Library TU | ||||
| composed-of | reference | Library-composed-of | What resource is being referenced | Library.relatedArtifact.where(type='composed-of').resource |
| content-type N | token | Library-content-type | The type of content in the library (e.g. text/cql) | Library.content.contentType |
| context | token | Library-context | A use context assigned to the library | (Library.useContext.value as CodeableConcept) |
| context-quantity | quantity | Library-context-quantity | A quantity- or range-valued use context assigned to the library | (Library.useContext.value as Quantity) | (Library.useContext.value as Range) |
| context-type | token | Library-context-type | A type of use context assigned to the library | Library.useContext.code |
| context-type-quantity | composite | Library-context-type-quantity | A use context type and quantity- or range-based value assigned to the library | Library.useContext |
| context-type-value | composite | Library-context-type-value | A use context type and value assigned to the library | Library.useContext |
| date N | date | Library-date | The library publication date | Library.date |
| depends-on | reference | Library-depends-on | What resource is being referenced | Library.relatedArtifact.where(type='depends-on').resource |
| derived-from | reference | Library-derived-from | What resource is being referenced | Library.relatedArtifact.where(type='derived-from').resource |
| description N | string | Library-description | The description of the library | Library.description |
| effective | date | Library-effective | The time during which the library is intended to be in use | Library.effectivePeriod |
| identifier | token | Library-identifier | External identifier for the library | Library.identifier |
| jurisdiction | token | Library-jurisdiction | Intended jurisdiction for the library | Library.jurisdiction |
| name N | string | Library-name | Computationally friendly name of the library | Library.name |
| predecessor | reference | Library-predecessor | What resource is being referenced | Library.relatedArtifact.where(type='predecessor').resource |
| publisher N | string | Library-publisher | Name of the publisher of the library | Library.publisher |
| status N | token | Library-status | The current status of the library | Library.status |
| successor | reference | Library-successor | What resource is being referenced | Library.relatedArtifact.where(type='successor').resource |
| title N | string | Library-title | The human-friendly name of the library | Library.title |
| topic | token | Library-topic | 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 N | uri | Library-url | The uri that identifies the library | Library.url |
| version N | token | Library-version | 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 N | 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 N | 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 N | token | List-status | current | retired | entered-in-error | List.status |
| subject | reference | List-subject | If all resources have the same subject | List.subject |
| title N | 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 N | string | Location-address-city | A city specified in an address | Location.address.city |
| address-country N | string | Location-address-country | A country specified in an address | Location.address.country |
| address-postalcode N | string | Location-address-postalcode | A postal code specified in an address | Location.address.postalCode |
| address-state N | string | Location-address-state | A state specified in an address | Location.address.state |
| address-use N | token | Location-address-use | A use code specified in an address | Location.address.use |
| 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). 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 irrelevant) Servers may search using various techniques that might have differing accuracies, depending on implementation efficiency. Requires the near-distance parameter to be provided also | 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 N | 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 |
| Measure TU | ||||
| composed-of | reference | Measure-composed-of | What resource is being referenced | Measure.relatedArtifact.where(type='composed-of').resource |
| context | token | Measure-context | A use context assigned to the measure | (Measure.useContext.value as CodeableConcept) |
| context-quantity | quantity | Measure-context-quantity | A quantity- or range-valued use context assigned to the measure | (Measure.useContext.value as Quantity) | (Measure.useContext.value as Range) |
| context-type | token | Measure-context-type | A type of use context assigned to the measure | Measure.useContext.code |
| context-type-quantity | composite | Measure-context-type-quantity | A use context type and quantity- or range-based value assigned to the measure | Measure.useContext |
| context-type-value | composite | Measure-context-type-value | A use context type and value assigned to the measure | Measure.useContext |
| date N | date | Measure-date | The measure publication date | Measure.date |
| depends-on | reference | Measure-depends-on | What resource is being referenced | Measure.relatedArtifact.where(type='depends-on').resource | Measure.library |
| derived-from | reference | Measure-derived-from | What resource is being referenced | Measure.relatedArtifact.where(type='derived-from').resource |
| description N | string | Measure-description | The description of the measure | Measure.description |
| effective | date | Measure-effective | The time during which the measure is intended to be in use | Measure.effectivePeriod |
| identifier | token | Measure-identifier | External identifier for the measure | Measure.identifier |
| jurisdiction | token | Measure-jurisdiction | Intended jurisdiction for the measure | Measure.jurisdiction |
| name N | string | Measure-name | Computationally friendly name of the measure | Measure.name |
| predecessor | reference | Measure-predecessor | What resource is being referenced | Measure.relatedArtifact.where(type='predecessor').resource |
| publisher N | string | Measure-publisher | Name of the publisher of the measure | Measure.publisher |
| status N | token | Measure-status | The current status of the measure | Measure.status |
| successor | reference | Measure-successor | What resource is being referenced | Measure.relatedArtifact.where(type='successor').resource |
| title N | string | Measure-title | The human-friendly name of the measure | Measure.title |
| topic | token | Measure-topic | Topics associated with the measure | Measure.topic |
| url N | uri | Measure-url | The uri that identifies the measure | Measure.url |
| version N | token | Measure-version | The business version of the measure | Measure.version |
| MeasureReport TU | ||||
| date N | date | MeasureReport-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 | MeasureReport-identifier | External identifier of the measure report to be returned | MeasureReport.identifier |
| measure N | reference | MeasureReport-measure | The measure to return measure report results for | MeasureReport.measure |
| patient | reference | MeasureReport-patient | 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 N | 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 |
| Medication TU | ||||
| code | token | clinical-code | Returns medications for a specific code | Medication.code |
| expiration-date N | 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 | Medication-identifier | Returns medications with this external identifier | Medication.identifier |
| ingredient D | reference | Medication-ingredient | Returns medications for this ingredient reference | Medication.ingredient.item.reference |
| ingredient-code D | token | Medication-ingredient-code | Returns medications for this ingredient code | Medication.ingredient.item.concept |
| lot-number N | token | Medication-lot-number | Returns medications in a batch with this lot number | Medication.batch.lotNumber |
| manufacturer | reference | Medication-manufacturer | Returns medications made or sold for this manufacturer | Medication.manufacturer |
| status N | token | Medication-status | Returns medications for this status | Medication.status |
| MedicationAdministration TU | ||||
| code | token | clinical-code | Return administrations of this medication code | MedicationAdministration.medication.concept |
| date | date | medications-date | Date administration happened (or did not happen) | MedicationAdministration.occurence |
| device | reference | MedicationAdministration-device | Return administrations with this administration device identity | MedicationAdministration.device |
| encounter | reference | medications-encounter | Return administrations that share this encounter | MedicationAdministration.encounter |
| identifier | token | clinical-identifier | Return administrations with this external identifier | MedicationAdministration.identifier |
| medication D | reference | medications-medication | Return administrations of this medication reference | MedicationAdministration.medication.reference |
| 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 | MedicationAdministration.performer.actor |
| reason-given D | reference | MedicationAdministration-reason-given | Reference to a resource (by instance) | MedicationAdministration.reason.reference |
| reason-given-code D | token | MedicationAdministration-reason-given-code | Reasons for administering the medication | MedicationAdministration.reason.concept |
| 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 N | 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 | MedicationDispense.medication.concept |
| destination | reference | MedicationDispense-destination | Returns dispenses that should be sent to a specific destination | MedicationDispense.destination |
| encounter | reference | MedicationDispense-encounter | Returns dispenses with a specific encounter | MedicationDispense.encounter |
| identifier | token | clinical-identifier | Returns dispenses with this external identifier | MedicationDispense.identifier |
| medication D | reference | medications-medication | Returns dispenses of this medicine resource | MedicationDispense.medication.reference |
| 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 |
| responsibleparty | reference | MedicationDispense-responsibleparty | Returns dispenses with the specified responsible party | MedicationDispense.substitution.responsibleParty |
| status N | 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 | MedicationDispense-type | Returns dispenses of a specific type | MedicationDispense.type |
| whenhandedover N | date | MedicationDispense-whenhandedover | Returns dispenses handed over on this date | MedicationDispense.whenHandedOver |
| whenprepared N | 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 + | MedicationKnowledge.doseForm |
| identifier | token | MedicationKnowledge-identifier | Business identifier for this medication | MedicationKnowledge.identifier |
| ingredient D | reference | MedicationKnowledge-ingredient | Reference to a resource (by instance) | MedicationKnowledge.ingredient.item.reference |
| ingredient-code D | token | MedicationKnowledge-ingredient-code | Reference to a concept (by class) | MedicationKnowledge.ingredient.item.concept |
| manufacturer | reference | MedicationKnowledge-manufacturer | Manufacturer of the item | MedicationKnowledge.manufacturer |
| monitoring-program-name N | 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 |
| product-type | token | MedicationKnowledge-product-type | Category of the medication or product | MedicationKnowledge.productType |
| source-cost N | token | MedicationKnowledge-source-cost | The source or owner for the price information | MedicationKnowledge.cost.source |
| status N | token | MedicationKnowledge-status | active | inactive | entered-in-error | MedicationKnowledge.status |
| MedicationRequest TU | ||||
| authoredon N | 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 | MedicationRequest.medication.concept |
| date | date | medications-date | Returns medication request to be administered on a specific date | MedicationRequest.dosageInstruction.timing.event |
| encounter | reference | medications-encounter | Return prescriptions with this encounter identifier | MedicationRequest.encounter |
| 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 | MedicationRequest.dispenseRequest.dispenser |
| 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 N | token | MedicationRequest-intent | Returns prescriptions with different intents | MedicationRequest.intent |
| medication D | reference | medications-medication | Return prescriptions for this medication reference | MedicationRequest.medication.reference |
| patient | reference | clinical-patient | Returns prescriptions for a specific patient | MedicationRequest.subject.where(resolve() is Patient) |
| priority N | token | MedicationRequest-priority | Returns prescriptions with different priorities | MedicationRequest.priority |
| requester | reference | MedicationRequest-requester | Returns prescriptions prescribed by this prescriber | MedicationRequest.requester |
| status N | token | medications-status | Status of the prescription | MedicationRequest.status |
| subject | reference | MedicationRequest-subject | The identity of a patient to list orders for | MedicationRequest.subject |
| MedicationUsage TU | ||||
| adherence N | token | MedicationUsage-adherence | Returns statements based on adherence or compliance | MedicationUsage.takenAsOrdered |
| category | token | MedicationUsage-category | Returns statements of this category of MedicationUsage | MedicationUsage.category |
| code | token | clinical-code | Return statements of this medication code | MedicationUsage.medication.concept |
| effective | date | MedicationUsage-effective | Date when patient was taking (or not taking) the medication | MedicationUsage.effective |
| encounter | reference | MedicationUsage-encounter | Returns statements for a specific encounter | MedicationUsage.encounter |
| identifier | token | clinical-identifier | Return statements with this external identifier | MedicationUsage.identifier |
| medication D | reference | medications-medication | Return statements of this medication reference | MedicationUsage.medication.reference |
| part-of | reference | MedicationUsage-part-of | Returns statements that are part of another event. | MedicationUsage.partOf |
| patient | reference | clinical-patient | Returns statements for a specific patient. | MedicationUsage.subject.where(resolve() is Patient) |
| source | reference | MedicationUsage-source | Who or where the information in the statement came from | MedicationUsage.informationSource |
| status N | token | medications-status | Return statements that match the given status | MedicationUsage.status |
| subject | reference | MedicationUsage-subject | The identity of a patient, animal or group to list statements for | MedicationUsage.subject |
| MedicinalProductDefinition TU | ||||
| characteristic | token | MedicinalProductDefinition-characteristic | Allows the key product features to be recorded, such as "suger free", "modified release", "parallel import" | MedicinalProductDefinition.characteristic |
| 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 |
| master-file | reference | MedicinalProductDefinition-master-file | A master file for to the medicinal product (e.g. Pharmacovigilance System Master File) | MedicinalProductDefinition.masterFile |
| name N | string | MedicinalProductDefinition-name | The full product name | MedicinalProductDefinition.name.productName |
| name-language | token | MedicinalProductDefinition-name-language | Language code for this name | MedicinalProductDefinition.name.countryLanguage.language |
| product-classification | token | MedicinalProductDefinition-product-classification | Allows the product to be classified by various systems | MedicinalProductDefinition.productClassification |
| status | token | MedicinalProductDefinition-status | The status within the lifecycle of this product. A high level status, this is not intended to duplicate details carried elswhere 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 N | token | MessageDefinition-category | The behavior associated with the message | MessageDefinition.category |
| context | token | conformance-context | A use context assigned to the message definition | (MessageDefinition.useContext.value as CodeableConcept) |
| context-quantity | quantity | conformance-context-quantity | A quantity- or range-valued use context assigned to the message definition | (MessageDefinition.useContext.value as Quantity) | (MessageDefinition.useContext.value as Range) |
| context-type | token | conformance-context-type | A type of use context assigned to the message definition | MessageDefinition.useContext.code |
| context-type-quantity | composite | conformance-context-type-quantity | A use context type and quantity- or range-based value assigned to the message definition | MessageDefinition.useContext |
| context-type-value | composite | conformance-context-type-value | A use context type and value assigned to the message definition | MessageDefinition.useContext |
| date N | date | conformance-date | The message definition publication date | MessageDefinition.date |
| description N | string | conformance-description | The description of the message definition | MessageDefinition.description |
| event | token | MessageDefinition-event | The event that triggers the message or link to the event definition. | MessageDefinition.event |
| focus N | token | MessageDefinition-focus | A resource that is a permitted focus of the message | MessageDefinition.focus.code |
| identifier | token | conformance-identifier | External identifier for the message definition | MessageDefinition.identifier |
| jurisdiction | token | conformance-jurisdiction | Intended jurisdiction for the message definition | MessageDefinition.jurisdiction |
| name N | string | conformance-name | Computationally friendly name of the message definition | MessageDefinition.name |
| parent N | reference | MessageDefinition-parent | A resource that is the parent of the definition | MessageDefinition.parent |
| publisher N | string | conformance-publisher | Name of the publisher of the message definition | MessageDefinition.publisher |
| status N | token | conformance-status | The current status of the message definition | MessageDefinition.status |
| title N | string | conformance-title | The human-friendly name of the message definition | MessageDefinition.title |
| url N | uri | conformance-url | The uri that identifies the message definition | MessageDefinition.url |
| version N | token | conformance-version | The business version of the message definition | MessageDefinition.version |
| MessageHeader TU | ||||
| author | reference | MessageHeader-author | The source of the decision | MessageHeader.author |
| code N | token | MessageHeader-code | ok | transient-error | fatal-error | MessageHeader.response.code |
| destination N | string | MessageHeader-destination | Name of system | MessageHeader.destination.name |
| destination-uri N | uri | MessageHeader-destination-uri | Actual destination address or id | MessageHeader.destination.endpoint |
| enterer | reference | MessageHeader-enterer | The source of the data entry | MessageHeader.enterer |
| event | token | MessageHeader-event | Code for the event this message represents or link to event definition | MessageHeader.event |
| 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 N | 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 N | string | MessageHeader-source | Name of system | MessageHeader.source.name |
| source-uri N | uri | MessageHeader-source-uri | Actual message source address or id | MessageHeader.source.endpoint |
| target | reference | MessageHeader-target | Particular delivery destination within the destination | MessageHeader.destination.target |
| MolecularSequence TU | ||||
| chromosome | token | MolecularSequence-chromosome | Chromosome number of the reference sequence | MolecularSequence.referenceSeq.chromosome |
| chromosome-variant-coordinate | composite | MolecularSequence-chromosome-variant-coordinate | Search parameter by chromosome and variant coordinate. This will refer to part of a locus or part of a gene where search region will be represented in 1-based system. Since the coordinateSystem can either be 0-based or 1-based, this search query will include the result of both coordinateSystem that contains the equivalent segment of the gene or whole genome sequence. For example, a search for sequence can be represented as | MolecularSequence.variant |
| chromosome-window-coordinate | composite | MolecularSequence-chromosome-window-coordinate | Search parameter by chromosome and window. This will refer to part of a locus or part of a gene where search region will be represented in 1-based system. Since the coordinateSystem can either be 0-based or 1-based, this search query will include the result of both coordinateSystem that contains the equivalent segment of the gene or whole genome sequence. For example, a search for sequence can be represented as | MolecularSequence.referenceSeq |
| identifier | token | MolecularSequence-identifier | The unique identity for a particular sequence | MolecularSequence.identifier |
| patient | reference | MolecularSequence-patient | The subject that the observation is about | MolecularSequence.patient |
| referenceseqid | token | MolecularSequence-referenceseqid | Reference Sequence of the sequence | MolecularSequence.referenceSeq.referenceSeqId |
| referenceseqid-variant-coordinate | composite | MolecularSequence-referenceseqid-variant-coordinate | Search parameter by reference sequence and variant coordinate. This will refer to part of a locus or part of a gene where search region will be represented in 1-based system. Since the coordinateSystem can either be 0-based or 1-based, this search query will include the result of both coordinateSystem that contains the equivalent segment of the gene or whole genome sequence. For example, a search for sequence can be represented as | MolecularSequence.variant |
| referenceseqid-window-coordinate | composite | MolecularSequence-referenceseqid-window-coordinate | Search parameter by reference sequence and window. This will refer to part of a locus or part of a gene where search region will be represented in 1-based system. Since the coordinateSystem can either be 0-based or 1-based, this search query will include the result of both coordinateSystem that contains the equivalent segment of the gene or whole genome sequence. For example, a search for sequence can be represented as | MolecularSequence.referenceSeq |
| type N | token | MolecularSequence-type | Amino Acid Sequence/ DNA Sequence / RNA Sequence | MolecularSequence.type |
| variant-end N | number | MolecularSequence-variant-end | End position (0-based exclusive, which menas the acid at this position will not be included, 1-based inclusive, which means the acid at this position will be included) of the variant. | MolecularSequence.variant.end |
| variant-start N | number | MolecularSequence-variant-start | Start position (0-based inclusive, 1-based inclusive, that means the nucleic acid or amino acid at this position will be included) of the variant. | MolecularSequence.variant.start |
| window-end N | number | MolecularSequence-window-end | End position (0-based exclusive, which menas the acid at this position will not be included, 1-based inclusive, which means the acid at this position will be included) of the reference sequence. | MolecularSequence.referenceSeq.windowEnd |
| window-start N | number | MolecularSequence-window-start | Start position (0-based inclusive, 1-based inclusive, that means the nucleic acid or amino acid at this position will be included) of the reference sequence. | MolecularSequence.referenceSeq.windowStart |
| NamingSystem TU | ||||
| contact N | string | NamingSystem-contact | Name of an individual to contact | NamingSystem.contact.name |
| context | token | conformance-context | A use context assigned to the naming system | (NamingSystem.useContext.value as CodeableConcept) |
| context-quantity | quantity | conformance-context-quantity | A quantity- or range-valued use context assigned to the naming system | (NamingSystem.useContext.value as Quantity) | (NamingSystem.useContext.value as Range) |
| context-type | token | conformance-context-type | A type of use context assigned to the naming system | NamingSystem.useContext.code |
| context-type-quantity | composite | conformance-context-type-quantity | A use context type and quantity- or range-based value assigned to the naming system | NamingSystem.useContext |
| context-type-value | composite | conformance-context-type-value | A use context type and value assigned to the naming system | NamingSystem.useContext |
| date N | date | conformance-date | The naming system publication date | NamingSystem.date |
| description N | string | conformance-description | The description of the naming system | NamingSystem.description |
| id-type N | token | NamingSystem-id-type | oid | uuid | uri | other | NamingSystem.uniqueId.type |
| jurisdiction | token | conformance-jurisdiction | Intended jurisdiction for the naming system | NamingSystem.jurisdiction |
| kind N | token | NamingSystem-kind | codesystem | identifier | root | NamingSystem.kind |
| name N | string | conformance-name | Computationally friendly name of the naming system | NamingSystem.name |
| period | date | NamingSystem-period | When is identifier valid? | NamingSystem.uniqueId.period |
| publisher N | string | conformance-publisher | Name of the publisher of the naming system | NamingSystem.publisher |
| responsible N | string | NamingSystem-responsible | Who maintains system namespace? | NamingSystem.responsible |
| status N | token | conformance-status | The current status of the naming system | NamingSystem.status |
| telecom | token | NamingSystem-telecom | Contact details for individual or organization | NamingSystem.contact.telecom |
| type | token | NamingSystem-type | e.g. driver, provider, patient, bank etc. | NamingSystem.type |
| url N | uri | conformance-url | The uri that identifies the naming system | NamingSystem.url |
| value N | string | NamingSystem-value | The unique identifier | NamingSystem.uniqueId.value |
| version N | token | conformance-version | The business version of the naming system | NamingSystem.version |
| NutritionIntake TU | ||||
| code | token | NutritionIntake-code | Returns statements of this code of NutritionIntake | NutritionIntake.code |
| date | date | NutritionIntake-date | Date when patient was taking (or not taking) the medication | NutritionIntake.occurrence |
| encounter | reference | NutritionIntake-encounter | Returns statements for a specific encounter | NutritionIntake.encounter |
| identifier | token | NutritionIntake-identifier | Return statements with this external identifier | NutritionIntake.identifier |
| nutrition D | token | NutritionIntake-nutrition | Return statements of this medication reference | NutritionIntake.consumedItem.nutritionProduct |
| part-of | reference | NutritionIntake-part-of | Returns statements that are part of another event. | NutritionIntake.partOf |
| patient | reference | NutritionIntake-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 N | 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 | NutritionOrder.enteralFormula.additiveType |
| datetime N | 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 | NutritionOrder.enteralFormula.baseFormulaType |
| identifier | token | clinical-identifier | Return nutrition orders with this external identifier | NutritionOrder.identifier |
| instantiates-canonical N | reference | NutritionOrder-instantiates-canonical | Instantiates FHIR protocol or definition | NutritionOrder.instantiatesCanonical |
| instantiates-uri N | uri | NutritionOrder-instantiates-uri | Instantiates external protocol or definition | NutritionOrder.instantiatesUri |
| 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 person who requires the diet, formula or nutritional supplement | NutritionOrder.patient |
| provider | reference | NutritionOrder-provider | The identity of the provider who placed the nutrition order | NutritionOrder.orderer |
| status N | token | NutritionOrder-status | Status of the nutrition order. | NutritionOrder.status |
| supplement | token | NutritionOrder-supplement | Type of supplement product requested | NutritionOrder.supplement.type |
| NutritionProduct TU | ||||
| identifier | token | NutritionProduct-identifier | The identifier for the physical instance, typically a serial number | NutritionProduct.instance.identifier |
| status N | token | NutritionProduct-status | active | inactive | entered-in-error | NutritionProduct.status |
| Observation N | ||||
| based-on TU | reference | Observation-based-on | Reference to the service request. | Observation.basedOn |
| category TU | 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 TU | composite | Observation-code-value-concept | Code and coded value parameter pair | Observation |
| code-value-date TU | composite | Observation-code-value-date | Code and date/time value parameter pair | Observation |
| code-value-quantity TU | composite | Observation-code-value-quantity | Code and quantity value parameter pair | Observation |
| code-value-string TU | composite | Observation-code-value-string | Code and string value parameter pair | Observation |
| combo-code TU | token | Observation-combo-code | The code of the observation type or component type | Observation.code | Observation.component.code |
| combo-code-value-concept TU | composite | Observation-combo-code-value-concept | Code and coded value parameter pair, including in components | Observation | Observation.component |
| combo-code-value-quantity TU | composite | Observation-combo-code-value-quantity | Code and quantity value parameter pair, including in components | Observation | Observation.component |
| combo-data-absent-reason TU | 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 TU | token | Observation-combo-value-concept | The value or component value of the observation, if the value is a CodeableConcept | (Observation.value as CodeableConcept) | (Observation.component.value as CodeableConcept) |
| combo-value-quantity TU | 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) | (Observation.value as Quantity) | (Observation.value as SampledData) | (Observation.component.value as Quantity) | (Observation.component.value as SampledData) |
| component-code TU | token | Observation-component-code | The component code of the observation type | Observation.component.code |
| component-code-value-concept TU | composite | Observation-component-code-value-concept | Component code and component coded value parameter pair | Observation.component |
| component-code-value-quantity TU | composite | Observation-component-code-value-quantity | Component code and component quantity value parameter pair | Observation.component |
| component-data-absent-reason TU | token | Observation-component-data-absent-reason | The reason why the expected value in the element Observation.component.value[x] is missing. | Observation.component.dataAbsentReason |
| component-value-concept TU | token | Observation-component-value-concept | The value of the component observation, if the value is a CodeableConcept | (Observation.component.value as CodeableConcept) |
| component-value-quantity TU | 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) | (Observation.component.value as Quantity) | (Observation.component.value as SampledData) |
| data-absent-reason TU | token | Observation-data-absent-reason | The reason why the expected value in the element Observation.value[x] is missing. | Observation.dataAbsentReason |
| date | date | clinical-date | Obtained date/time. If the obtained element is a period, a date that falls in the period | Observation.effective |
| derived-from TU | reference | Observation-derived-from | Related measurements the observation is made from | Observation.derivedFrom |
| device TU | 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 TU | 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 TU | token | Observation-method | The method used for the observation | Observation.method |
| part-of TU | 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 TU | reference | Observation-performer | Who performed the observation | Observation.performer |
| specimen TU | reference | Observation-specimen | Specimen used for this observation | Observation.specimen |
| status | token | Observation-status | The status of the observation | Observation.status |
| subject TU | reference | Observation-subject | The subject that the observation is about | Observation.subject |
| value-concept TU | token | Observation-value-concept | The value of the observation, if the value is a CodeableConcept | (Observation.value as CodeableConcept) |
| value-date TU | date | Observation-value-date | The value of the observation, if the value is a date or period of time | (Observation.value as dateTime) | (Observation.value as Period) |
| value-quantity TU | 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) | (Observation.value as Quantity) | (Observation.value as SampledData) |
| value-string TU | string | Observation-value-string | The value of the observation, if the value is a string, and also searches in CodeableConcept.text | (Observation.value as string) | (Observation.value as CodeableConcept).text |
| ObservationDefinition TU | ||||
| category | token | ObservationDefinition-category | Category (class) of observation | ObservationDefinition.category |
| code | token | ObservationDefinition-code | Observation code | ObservationDefinition.code |
| experimental N | token | ObservationDefinition-experimental | Not for genuine usage (true) | ObservationDefinition.experimental |
| identifier | token | ObservationDefinition-identifier | The unique identifier associated with the specimen definition | ObservationDefinition.identifier |
| method | token | ObservationDefinition-method | Method of observation | ObservationDefinition.method |
| status N | token | ObservationDefinition-status | Publication status of the ObservationDefinition: draft, active, retired, unknown | ObservationDefinition.status |
| title N | string | ObservationDefinition-title | Human-friendly name of the ObservationDefinition | ObservationDefinition.title |
| url N | uri | ObservationDefinition-url | The uri that identifies the observation definition | ObservationDefinition.url |
| 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 | conformance-context | A use context assigned to the operation definition | (OperationDefinition.useContext.value as CodeableConcept) |
| context-quantity TU | quantity | conformance-context-quantity | A quantity- or range-valued use context assigned to the operation definition | (OperationDefinition.useContext.value as Quantity) | (OperationDefinition.useContext.value as Range) |
| context-type TU | token | conformance-context-type | A type of use context assigned to the operation definition | OperationDefinition.useContext.code |
| context-type-quantity TU | composite | conformance-context-type-quantity | A use context type and quantity- or range-based value assigned to the operation definition | OperationDefinition.useContext |
| context-type-value TU | composite | conformance-context-type-value | A use context type and value assigned to the operation definition | OperationDefinition.useContext |
| date | date | conformance-date | The operation definition publication date | OperationDefinition.date |
| description | string | conformance-description | The description of the operation definition | OperationDefinition.description |
| 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 | conformance-jurisdiction | Intended jurisdiction for the operation definition | OperationDefinition.jurisdiction |
| kind | token | OperationDefinition-kind | operation | query | OperationDefinition.kind |
| name | string | conformance-name | Computationally friendly name of the operation definition | OperationDefinition.name |
| output-profile | reference | OperationDefinition-output-profile | Validation information for out parameters | OperationDefinition.outputProfile |
| publisher | string | conformance-publisher | Name of the publisher of the operation definition | OperationDefinition.publisher |
| status | token | conformance-status | The current status of the operation definition | OperationDefinition.status |
| system | token | OperationDefinition-system | Invoke at the system level? | OperationDefinition.system |
| title | string | conformance-title | The human-friendly name of the operation definition | OperationDefinition.title |
| type | token | OperationDefinition-type | Invoke at the type level? | OperationDefinition.type |
| url | uri | conformance-url | The uri that identifies the operation definition | OperationDefinition.url |
| version | token | conformance-version | The business version of the operation definition | OperationDefinition.version |
| Organization TU | ||||
| active N | 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 | Organization.address |
| address-city N | string | Organization-address-city | A city specified in an address | Organization.address.city |
| address-country N | string | Organization-address-country | A country specified in an address | Organization.address.country |
| address-postalcode N | string | Organization-address-postalcode | A postal code specified in an address | Organization.address.postalCode |
| address-state N | string | Organization-address-state | A state specified in an address | Organization.address.state |
| address-use N | token | Organization-address-use | A use code specified in an address | Organization.address.use |
| 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 |
| 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 N | 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 N | 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 | OrganizationAffiliation.telecom.where(system='email') | |
| 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 | OrganizationAffiliation.telecom.where(system='phone') |
| 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 | OrganizationAffiliation.telecom |
| PackagedProductDefinition TU | ||||
| device | reference | PackagedProductDefinition-device | A device associated within 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 | |
| name N | token | PackagedProductDefinition-name | A name for this product pack. Typically what it would be listed as in a drug formulary | PackagedProductDefinition.name |
| status | token | PackagedProductDefinition-status | The status within the lifecycle of this product. A high level status, this is not intended to duplicate details carried elswhere such as legal status, or authorization or marketing status | PackagedProductDefinition.status |
| subject | reference | PackagedProductDefinition-subject | The product that this is a pack for | PackagedProductDefinition.subject |
| Patient N | ||||
| active | token | Patient-active | Whether the patient record is active | Patient.active |
| address TU | 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 TU | date | Patient-death-date | The date of death has been provided and satisfies this search value | (Patient.deceased as dateTime) |
| deceased TU | token | Patient-deceased | This patient has been marked as deceased, or as a death date entered | Patient.deceased.exists() and Patient.deceased != false |
| email TU | 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 TU | 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 TU | token | Patient-identifier | A patient identifier | Patient.identifier |
| language TU | token | Patient-language | Language code (irrespective of use value) | Patient.communication.language |
| link TU | reference | Patient-link | All patients linked to the given patient | Patient.link.other |
| name TU | string | Patient-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 | Patient.name |
| organization TU | reference | Patient-organization | The organization that is the custodian of the patient record | Patient.managingOrganization |
| phone TU | token | individual-phone | A value in a phone contact | Patient.telecom.where(system='phone') |
| phonetic TU | string | individual-phonetic | A portion of either family or given name using some kind of phonetic matching algorithm | Patient.name |
| telecom TU | token | individual-telecom | The value in any kind of telecom details of the patient | Patient.telecom |
| PaymentNotice TU | ||||
| created N | date | PaymentNotice-created | Creation date fro the notice | 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 |
| provider | reference | PaymentNotice-provider | The reference to the provider | PaymentNotice.provider |
| request | reference | PaymentNotice-request | The Claim | PaymentNotice.request |
| response | reference | PaymentNotice-response | The ClaimResponse | PaymentNotice.response |
| status N | token | PaymentNotice-status | The status of the payment notice | PaymentNotice.status |
| PaymentReconciliation TU | ||||
| created N | date | PaymentReconciliation-created | The creation date | PaymentReconciliation.created |
| disposition N | string | PaymentReconciliation-disposition | The contents of the disposition message | PaymentReconciliation.disposition |
| identifier | token | PaymentReconciliation-identifier | The business identifier of the ExplanationOfBenefit | PaymentReconciliation.identifier |
| outcome N | 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 N | token | PaymentReconciliation-status | The status of the payment reconciliation | PaymentReconciliation.status |
| Permission TU | ||||
| status N | token | Permission-status | active | entered-in-error | draft | rejected | Permission.status |
| Person TU | ||||
| 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 | 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 |
| token | individual-email | A value in an email contact | Person.telecom.where(system='email') | |
| gender N | token | individual-gender | The gender of the person | Person.gender |
| identifier | token | Person-identifier | 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 | Person-patient | The Person links to this Patient | Person.link.target.where(resolve() is Patient) |
| phone | token | individual-phone | A value in a phone contact | Person.telecom.where(system='phone') |
| phonetic | 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 | token | individual-telecom | The value in any kind of contact | Person.telecom |
| PlanDefinition TU | ||||
| composed-of | reference | PlanDefinition-composed-of | What resource is being referenced | PlanDefinition.relatedArtifact.where(type='composed-of').resource |
| context | token | PlanDefinition-context | A use context assigned to the plan definition | (PlanDefinition.useContext.value as CodeableConcept) |
| context-quantity | quantity | PlanDefinition-context-quantity | A quantity- or range-valued use context assigned to the plan definition | (PlanDefinition.useContext.value as Quantity) | (PlanDefinition.useContext.value as Range) |
| context-type | token | PlanDefinition-context-type | A type of use context assigned to the plan definition | PlanDefinition.useContext.code |
| context-type-quantity | composite | PlanDefinition-context-type-quantity | A use context type and quantity- or range-based value assigned to the plan definition | PlanDefinition.useContext |
| context-type-value | composite | PlanDefinition-context-type-value | A use context type and value assigned to the plan definition | PlanDefinition.useContext |
| date N | date | PlanDefinition-date | The plan definition publication date | PlanDefinition.date |
| definition | reference | PlanDefinition-definition | Activity or plan definitions used by plan definition | PlanDefinition.action.definition |
| depends-on | reference | PlanDefinition-depends-on | What resource is being referenced | PlanDefinition.relatedArtifact.where(type='depends-on').resource | PlanDefinition.library |
| derived-from | reference | PlanDefinition-derived-from | What resource is being referenced | PlanDefinition.relatedArtifact.where(type='derived-from').resource |
| description N | string | PlanDefinition-description | The description of the plan definition | PlanDefinition.description |
| effective | date | PlanDefinition-effective | The time during which the plan definition is intended to be in use | PlanDefinition.effectivePeriod |
| identifier | token | PlanDefinition-identifier | External identifier for the plan definition | PlanDefinition.identifier |
| jurisdiction | token | PlanDefinition-jurisdiction | Intended jurisdiction for the plan definition | PlanDefinition.jurisdiction |
| name N | string | PlanDefinition-name | Computationally friendly name of the plan definition | PlanDefinition.name |
| predecessor | reference | PlanDefinition-predecessor | What resource is being referenced | PlanDefinition.relatedArtifact.where(type='predecessor').resource |
| publisher N | string | PlanDefinition-publisher | Name of the publisher of the plan definition | PlanDefinition.publisher |
| status N | token | PlanDefinition-status | The current status of the plan definition | PlanDefinition.status |
| successor | reference | PlanDefinition-successor | What resource is being referenced | PlanDefinition.relatedArtifact.where(type='successor').resource |
| title N | string | PlanDefinition-title | The human-friendly name of the plan definition | PlanDefinition.title |
| topic | token | PlanDefinition-topic | 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 N | uri | PlanDefinition-url | The uri that identifies the plan definition | PlanDefinition.url |
| version N | token | PlanDefinition-version | The business version of the plan definition | PlanDefinition.version |
| Practitioner TU | ||||
| active N | token | Practitioner-active | Whether the practitioner record is active | Practitioner.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 | 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 | One of the languages that the practitioner can communicate with | Practitioner.communication |
| 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 |
| 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 | token | individual-phone | A value in a phone contact | Practitioner.telecom.where(system='phone') |
| phonetic | string | individual-phonetic | A portion of either family or given name using some kind of phonetic matching algorithm | Practitioner.name |
| telecom | token | individual-telecom | The value in any kind of contact | Practitioner.telecom |
| PractitionerRole TU | ||||
| active N | token | PractitionerRole-active | Whether this practitioner role record is in active use | PractitionerRole.active |
| date | date | PractitionerRole-date | The period during which the practitioner is authorized to perform in these role(s) | PractitionerRole.period |
| token | individual-email | A value in an email contact | PractitionerRole.telecom.where(system='email') | |
| 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 | token | individual-phone | A value in a phone contact | PractitionerRole.telecom.where(system='phone') |
| 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 | token | individual-telecom | The value in any kind of contact | PractitionerRole.telecom |
| 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 N | date | clinical-date | When the procedure occurred or is occurring | Procedure.occurrence |
| 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 N | reference | Procedure-instantiates-canonical | Instantiates FHIR protocol or definition | Procedure.instantiatesCanonical |
| instantiates-uri N | 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 | Who performed the procedure | Procedure.performer.actor |
| reason-code D | token | Procedure-reason-code | Reference to a concept (by class) | Procedure.reason.concept |
| reason-reference D | reference | Procedure-reason-reference | Reference to a resource (by instance) | Procedure.reason.reference |
| status N | 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 |
| entity | reference | Provenance-entity | Identity of entity | Provenance.entity.what |
| location | reference | Provenance-location | Where the activity occurred, if relevant | Provenance.location |
| patient | reference | Provenance-patient | Target Reference(s) (usually version specific) | Provenance.target.where(resolve() is Patient) |
| recorded N | 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 | (Provenance.occurred as dateTime) |
| Questionnaire TU | ||||
| code | token | Questionnaire-code | A code that corresponds to one of its items in the questionnaire | Questionnaire.item.code |
| context | token | Questionnaire-context | A use context assigned to the questionnaire | (Questionnaire.useContext.value as CodeableConcept) |
| context-quantity | quantity | Questionnaire-context-quantity | A quantity- or range-valued use context assigned to the questionnaire | (Questionnaire.useContext.value as Quantity) | (Questionnaire.useContext.value as Range) |
| context-type | token | Questionnaire-context-type | A type of use context assigned to the questionnaire | Questionnaire.useContext.code |
| context-type-quantity | composite | Questionnaire-context-type-quantity | A use context type and quantity- or range-based value assigned to the questionnaire | Questionnaire.useContext |
| context-type-value | composite | Questionnaire-context-type-value | A use context type and value assigned to the questionnaire | Questionnaire.useContext |
| date N | date | Questionnaire-date | The questionnaire publication date | Questionnaire.date |
| definition N | uri | Questionnaire-definition | ElementDefinition - details for the item | Questionnaire.item.definition |
| description N | string | Questionnaire-description | The description of the questionnaire | Questionnaire.description |
| effective | date | Questionnaire-effective | The time during which the questionnaire is intended to be in use | Questionnaire.effectivePeriod |
| identifier | token | Questionnaire-identifier | External identifier for the questionnaire | Questionnaire.identifier |
| jurisdiction | token | Questionnaire-jurisdiction | Intended jurisdiction for the questionnaire | Questionnaire.jurisdiction |
| name N | string | Questionnaire-name | Computationally friendly name of the questionnaire | Questionnaire.name |
| publisher N | string | Questionnaire-publisher | Name of the publisher of the questionnaire | Questionnaire.publisher |
| status N | token | Questionnaire-status | The current status of the questionnaire | Questionnaire.status |
| subject-type N | token | Questionnaire-subject-type | Resource that can be subject of QuestionnaireResponse | Questionnaire.subjectType |
| title N | string | Questionnaire-title | The human-friendly name of the questionnaire | Questionnaire.title |
| url N | uri | Questionnaire-url | The uri that identifies the questionnaire | Questionnaire.url |
| version N | token | Questionnaire-version | The business version of the questionnaire | Questionnaire.version |
| QuestionnaireResponse TU | ||||
| author | reference | QuestionnaireResponse-author | The author of the questionnaire response | QuestionnaireResponse.author |
| authored N | 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 | QuestionnaireResponse-encounter | Encounter associated with the questionnaire response | QuestionnaireResponse.encounter |
| identifier | token | QuestionnaireResponse-identifier | The unique identifier for the questionnaire response | QuestionnaireResponse.identifier |
| part-of | reference | QuestionnaireResponse-part-of | Procedure or observation this questionnaire response was performed as a part of | QuestionnaireResponse.partOf |
| patient | reference | QuestionnaireResponse-patient | The patient that is the subject of the questionnaire response | QuestionnaireResponse.subject.where(resolve() is Patient) |
| questionnaire N | 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 N | 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 | Marketing Authorization Holder | RegulatedAuthorization.holder |
| identifier | token | RegulatedAuthorization-identifier | Business identifier for the authorization, typically assigned by the authorizing body | RegulatedAuthorization.identifier |
| region | token | RegulatedAuthorization-region | The region (country, jurisdiction etc.) in which the marketing 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 product or service that is being authorized | RegulatedAuthorization.subject |
| RelatedPerson TU | ||||
| active N | token | RelatedPerson-active | Indicates if the related person record is active | RelatedPerson.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 | 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 |
| token | individual-email | A value in an email contact | RelatedPerson.telecom.where(system='email') | |
| gender N | token | individual-gender | Gender of the related person | RelatedPerson.gender |
| identifier | token | RelatedPerson-identifier | 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 | RelatedPerson-patient | The patient this related person is related to | RelatedPerson.patient |
| phone | token | individual-phone | A value in a phone contact | RelatedPerson.telecom.where(system='phone') |
| phonetic | 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 | token | individual-telecom | The value in any kind of contact | RelatedPerson.telecom |
| RequestGroup TU | ||||
| author | reference | RequestGroup-author | The author of the request group | RequestGroup.author |
| authored N | date | RequestGroup-authored | The date the request group was authored | RequestGroup.authoredOn |
| code | token | RequestGroup-code | The code of the request group | RequestGroup.code |
| encounter | reference | RequestGroup-encounter | The encounter the request group applies to | RequestGroup.encounter |
| group-identifier | token | RequestGroup-group-identifier | The group identifier for the request group | RequestGroup.groupIdentifier |
| identifier | token | RequestGroup-identifier | External identifiers for the request group | RequestGroup.identifier |
| instantiates-canonical N | reference | RequestGroup-instantiates-canonical | The FHIR-based definition from which the request group is realized | RequestGroup.instantiatesCanonical |
| instantiates-uri N | uri | RequestGroup-instantiates-uri | The external definition from which the request group is realized | RequestGroup.instantiatesUri |
| intent N | token | RequestGroup-intent | The intent of the request group | RequestGroup.intent |
| participant | reference | RequestGroup-participant | The participant in the requests in the group | RequestGroup.action.participant |
| patient | reference | RequestGroup-patient | The identity of a patient to search for request groups | RequestGroup.subject.where(resolve() is Patient) |
| priority N | token | RequestGroup-priority | The priority of the request group | RequestGroup.priority |
| status N | token | RequestGroup-status | The status of the request group | RequestGroup.status |
| subject | reference | RequestGroup-subject | The subject that the request group is about | RequestGroup.subject |
| ResearchStudy TU | ||||
| category | token | ResearchStudy-category | Classifications for the study | ResearchStudy.category |
| date | date | ResearchStudy-date | When the study began and ended | ResearchStudy.period |
| focus | token | ResearchStudy-focus | Drugs, devices, etc. under study | ResearchStudy.focus |
| identifier | token | ResearchStudy-identifier | Business Identifier for study | ResearchStudy.identifier |
| keyword | token | ResearchStudy-keyword | Used to search for the study | ResearchStudy.keyword |
| location | token | ResearchStudy-location | Geographic region(s) for study | ResearchStudy.location |
| partof | reference | ResearchStudy-partof | Part of larger study | ResearchStudy.partOf |
| principalinvestigator | reference | ResearchStudy-principalinvestigator | Researcher who oversees multiple aspects of the study | ResearchStudy.principalInvestigator |
| protocol | reference | ResearchStudy-protocol | Steps followed in executing study | ResearchStudy.protocol |
| site | reference | ResearchStudy-site | Facility where study activities are conducted | ResearchStudy.site |
| sponsor | reference | ResearchStudy-sponsor | Organization that initiates and is legally responsible for the study | ResearchStudy.sponsor |
| status N | token | ResearchStudy-status | active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn | ResearchStudy.status |
| title N | string | ResearchStudy-title | Name for this study | ResearchStudy.title |
| ResearchSubject TU | ||||
| date | date | ResearchSubject-date | Start and end of participation | ResearchSubject.period |
| identifier | token | ResearchSubject-identifier | Business Identifier for research subject in a study | ResearchSubject.identifier |
| individual | reference | ResearchSubject-individual | Who is part of study | ResearchSubject.individual |
| patient | reference | ResearchSubject-patient | Who is part of study | ResearchSubject.individual |
| state | token | ResearchSubject-state | candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn | ResearchSubject.progress.state |
| status N | token | ResearchSubject-status | candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn | ResearchSubject.status |
| study | reference | ResearchSubject-study | Study subject is part of | ResearchSubject.study |
| RiskAssessment TU | ||||
| condition | reference | RiskAssessment-condition | Condition assessed | RiskAssessment.condition |
| date N | date | clinical-date | When was assessment made? | (RiskAssessment.occurrence as dateTime) |
| 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 | RiskAssessment.prediction.probability |
| 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 N | 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 |
| service-category | token | Schedule-service-category | High-level category | Schedule.serviceCategory |
| service-type | token | Schedule-service-type | The type of appointments that can be booked into associated slot(s) | Schedule.serviceType |
| specialty | token | Schedule-specialty | Type of specialty needed | Schedule.specialty |
| SearchParameter TU | ||||
| base N | token | SearchParameter-base | The resource type(s) this search parameter applies to | SearchParameter.base |
| code N | token | SearchParameter-code | Code used in URL | SearchParameter.code |
| component N | reference | SearchParameter-component | Defines how the part works | SearchParameter.component.definition |
| context | token | conformance-context | A use context assigned to the search parameter | (SearchParameter.useContext.value as CodeableConcept) |
| context-quantity | quantity | conformance-context-quantity | A quantity- or range-valued use context assigned to the search parameter | (SearchParameter.useContext.value as Quantity) | (SearchParameter.useContext.value as Range) |
| context-type | token | conformance-context-type | A type of use context assigned to the search parameter | SearchParameter.useContext.code |
| context-type-quantity | composite | conformance-context-type-quantity | A use context type and quantity- or range-based value assigned to the search parameter | SearchParameter.useContext |
| context-type-value | composite | conformance-context-type-value | A use context type and value assigned to the search parameter | SearchParameter.useContext |
| date N | date | conformance-date | The search parameter publication date | SearchParameter.date |
| derived-from N | reference | SearchParameter-derived-from | Original definition for the search parameter | SearchParameter.derivedFrom |
| description N | string | conformance-description | The description of the search parameter | SearchParameter.description |
| jurisdiction | token | conformance-jurisdiction | Intended jurisdiction for the search parameter | SearchParameter.jurisdiction |
| name N | string | conformance-name | Computationally friendly name of the search parameter | SearchParameter.name |
| publisher N | string | conformance-publisher | Name of the publisher of the search parameter | SearchParameter.publisher |
| status N | token | conformance-status | The current status of the search parameter | SearchParameter.status |
| target N | token | SearchParameter-target | Types of resource (if a resource reference) | SearchParameter.target |
| type N | token | SearchParameter-type | number | date | string | token | reference | composite | quantity | uri | special | SearchParameter.type |
| url N | uri | conformance-url | The uri that identifies the search parameter | SearchParameter.url |
| version N | token | conformance-version | The business version of the search parameter | SearchParameter.version |
| ServiceRequest TU | ||||
| authored N | 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 |
| category | token | ServiceRequest-category | Classification of service | ServiceRequest.category |
| code | token | clinical-code | What is being requested/ordered | ServiceRequest.code |
| 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 N | reference | ServiceRequest-instantiates-canonical | Instantiates FHIR protocol or definition | ServiceRequest.instantiatesCanonical |
| instantiates-uri N | uri | ServiceRequest-instantiates-uri | Instantiates external protocol or definition | ServiceRequest.instantiatesUri |
| intent N | token | ServiceRequest-intent | proposal | plan | directive | order + | ServiceRequest.intent |
| occurrence | date | ServiceRequest-occurrence | When service should occur | ServiceRequest.occurrence |
| 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 N | 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 N | 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 of appointments that can be booked into the slot | Slot.serviceType |
| specialty | token | Slot-specialty | The specialty of a practitioner that would be required to perform the service requested in this appointment | Slot.specialty |
| start N | date | Slot-start | Appointment date/time. | Slot.start |
| status N | 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 | token | Specimen-bodysite | The code for the body site from where the specimen originated | Specimen.collection.bodySite |
| collected | date | Specimen-collected | The date the specimen was collected | Specimen.collection.collected |
| collector | reference | Specimen-collector | Who collected the specimen | Specimen.collection.collector |
| container | token | Specimen-container | The kind of specimen container | Specimen.container.type |
| container-id | token | Specimen-container-id | The unique identifier associated with the specimen container | Specimen.container.identifier |
| identifier | token | Specimen-identifier | The unique identifier associated with the specimen | Specimen.identifier |
| parent | reference | Specimen-parent | The parent of the specimen | Specimen.parent |
| patient | reference | Specimen-patient | The patient the specimen comes from | Specimen.subject.where(resolve() is Patient) |
| status N | token | Specimen-status | available | unavailable | unsatisfactory | entered-in-error | Specimen.status |
| subject | reference | Specimen-subject | The subject of the specimen | Specimen.subject |
| type | token | Specimen-type | 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 N | token | SpecimenDefinition-experimental | Not for genuine usage (true) | SpecimenDefinition.experimental |
| identifier | token | SpecimenDefinition-identifier | The unique identifier associated with the SpecimenDefinition | SpecimenDefinition.identifier |
| is-derived N | token | SpecimenDefinition-is-derived | Primary specimen (false) or derived specimen (true) | SpecimenDefinition.typeTested.isDerived |
| status N | token | SpecimenDefinition-status | Publication status of the SpecimenDefinition: draft, active, retired, unknown | SpecimenDefinition.status |
| title N | string | SpecimenDefinition-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 N | uri | SpecimenDefinition-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 | conformance-context | A use context assigned to the structure definition | (StructureDefinition.useContext.value as CodeableConcept) |
| context-quantity TU | quantity | conformance-context-quantity | A quantity- or range-valued use context assigned to the structure definition | (StructureDefinition.useContext.value as Quantity) | (StructureDefinition.useContext.value as Range) |
| context-type TU | token | conformance-context-type | A type of use context assigned to the structure definition | StructureDefinition.useContext.code |
| context-type-quantity TU | composite | conformance-context-type-quantity | A use context type and quantity- or range-based value assigned to the structure definition | StructureDefinition.useContext |
| context-type-value TU | composite | conformance-context-type-value | A use context type and value assigned to the structure definition | StructureDefinition.useContext |
| date | date | conformance-date | The structure definition publication date | StructureDefinition.date |
| derivation | token | StructureDefinition-derivation | specialization | constraint - How relates to base definition | StructureDefinition.derivation |
| description | string | conformance-description | The description of the structure definition | StructureDefinition.description |
| experimental | token | StructureDefinition-experimental | For testing purposes, not real usage | StructureDefinition.experimental |
| ext-context TU | token | StructureDefinition-ext-context | The system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element|CodeableConcept.text | StructureDefinition.context |
| identifier TU | token | conformance-identifier | External identifier for the structure definition | StructureDefinition.identifier |
| jurisdiction TU | token | conformance-jurisdiction | Intended jurisdiction for the structure definition | StructureDefinition.jurisdiction |
| keyword TU | token | StructureDefinition-keyword | A code for the StructureDefinition | StructureDefinition.keyword |
| kind | token | StructureDefinition-kind | primitive-type | complex-type | resource | logical | StructureDefinition.kind |
| name | string | conformance-name | 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 | string | conformance-publisher | Name of the publisher of the structure definition | StructureDefinition.publisher |
| status | token | conformance-status | The current status of the structure definition | StructureDefinition.status |
| title | string | conformance-title | The human-friendly name of the structure definition | StructureDefinition.title |
| type | uri | StructureDefinition-type | Type defined or constrained by this structure | StructureDefinition.type |
| url | uri | conformance-url | The uri that identifies the structure definition | StructureDefinition.url |
| valueset | reference | StructureDefinition-valueset | A vocabulary binding reference | StructureDefinition.snapshot.element.binding.valueSet |
| version | token | conformance-version | The business version of the structure definition | StructureDefinition.version |
| StructureMap TU | ||||
| context | token | conformance-context | A use context assigned to the structure map | (StructureMap.useContext.value as CodeableConcept) |
| context-quantity | quantity | conformance-context-quantity | A quantity- or range-valued use context assigned to the structure map | (StructureMap.useContext.value as Quantity) | (StructureMap.useContext.value as Range) |
| context-type | token | conformance-context-type | A type of use context assigned to the structure map | StructureMap.useContext.code |
| context-type-quantity | composite | conformance-context-type-quantity | A use context type and quantity- or range-based value assigned to the structure map | StructureMap.useContext |
| context-type-value | composite | conformance-context-type-value | A use context type and value assigned to the structure map | StructureMap.useContext |
| date N | date | conformance-date | The structure map publication date | StructureMap.date |
| description N | string | conformance-description | The description of the structure map | StructureMap.description |
| identifier | token | conformance-identifier | External identifier for the structure map | StructureMap.identifier |
| jurisdiction | token | conformance-jurisdiction | Intended jurisdiction for the structure map | StructureMap.jurisdiction |
| name N | string | conformance-name | Computationally friendly name of the structure map | StructureMap.name |
| publisher N | string | conformance-publisher | Name of the publisher of the structure map | StructureMap.publisher |
| status N | token | conformance-status | The current status of the structure map | StructureMap.status |
| title N | string | conformance-title | The human-friendly name of the structure map | StructureMap.title |
| url N | uri | conformance-url | The uri that identifies the structure map | StructureMap.url |
| version N | token | conformance-version | The business version of the structure map | StructureMap.version |
| Subscription TU | ||||
| contact | token | Subscription-contact | Contact details for the subscription | Subscription.contact |
| payload | token | Subscription-payload | The mime-type of the notification payload | |
| status N | token | Subscription-status | The current state of the subscription | Subscription.status |
| type | token | Subscription-type | The type of channel for the sent notifications | |
| url | uri | Subscription-url | The uri that will receive the notifications | |
| SubscriptionTopic TU | ||||
| date N | date | SubscriptionTopic-date | Date status first applied | SubscriptionTopic.date |
| identifier | token | SubscriptionTopic-identifier | Business Identifier for SubscriptionTopic | SubscriptionTopic.identifier |
| publisher | reference | SubscriptionTopic-publisher | The name of the individual or organization that published the SubscriptionTopic | SubscriptionTopic.publisher |
| resource-type N | token | SubscriptionTopic-resource-type | Candidate types for this subscription topic | SubscriptionTopic.resourceTrigger.resourceType |
| status N | token | SubscriptionTopic-status | draft | active | retired | unknown | SubscriptionTopic.status |
| title N | string | SubscriptionTopic-title | Name for this SubscriptionTopic (Human friendly) | SubscriptionTopic.title |
| trigger-description N | string | SubscriptionTopic-trigger-description | Text representation of the trigger | SubscriptionTopic.resourceTrigger.description |
| url N | uri | SubscriptionTopic-url | Logical canonical URL to reference this SubscriptionTopic (globally unique) | SubscriptionTopic.url |
| version N | token | SubscriptionTopic-version | 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 | Substance.code | (Substance.ingredient.substance as CodeableConcept) |
| container-identifier | token | Substance-container-identifier | Identifier of the package/container | Substance.instance.identifier |
| expiry N | date | Substance-expiry | Expiry date of package or container of substance | Substance.instance.expiry |
| identifier | token | Substance-identifier | Unique identifier for the substance | Substance.identifier |
| quantity | quantity | Substance-quantity | Amount of substance in the package | Substance.instance.quantity |
| status N | token | Substance-status | active | inactive | entered-in-error | Substance.status |
| substance-reference | reference | Substance-substance-reference | A component of the substance | (Substance.ingredient.substance as Reference) |
| SubstanceDefinition TU | ||||
| category | token | SubstanceDefinition-category | High level categorization, e.g. polymer or nucleic acid, or food, chemical, biological | SubstanceDefinition.category |
| 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 N | 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 N | 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 N | date | clinical-date | When the request was made | SupplyRequest.authoredOn |
| identifier | token | clinical-identifier | Business Identifier for SupplyRequest | SupplyRequest.identifier |
| requester | reference | SupplyRequest-requester | Individual making the request | SupplyRequest.requester |
| status N | 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 | ||||
| authored-on N | 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 | Task-code | Search by task code | Task.code |
| encounter | reference | Task-encounter | 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 | Task-identifier | Search for a task instance by its business identifier | Task.identifier |
| intent N | token | Task-intent | Search by task intent | Task.intent |
| modified N | date | Task-modified | Search by last modification date | Task.lastModified |
| 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 | Task-patient | Search by patient | Task.for.where(resolve() is Patient) |
| performer | token | Task-performer | Search by recommended type of performer (e.g., Requester, Performer, Scheduler). | Task.performerType |
| period | date | Task-period | Search by period Task is/was underway | Task.executionPeriod |
| priority N | token | Task-priority | Search by task priority | Task.priority |
| requester | reference | Task-requester | Search by task requester | Task.requester |
| status N | token | Task-status | Search by task status | Task.status |
| subject | reference | Task-subject | Search by subject | Task.for |
| TerminologyCapabilities TU | ||||
| context | token | conformance-context | A use context assigned to the terminology capabilities | (TerminologyCapabilities.useContext.value as CodeableConcept) |
| context-quantity | quantity | conformance-context-quantity | A quantity- or range-valued use context assigned to the terminology capabilities | (TerminologyCapabilities.useContext.value as Quantity) | (TerminologyCapabilities.useContext.value as Range) |
| context-type | token | conformance-context-type | A type of use context assigned to the terminology capabilities | TerminologyCapabilities.useContext.code |
| context-type-quantity | composite | conformance-context-type-quantity | A use context type and quantity- or range-based value assigned to the terminology capabilities | TerminologyCapabilities.useContext |
| context-type-value | composite | conformance-context-type-value | A use context type and value assigned to the terminology capabilities | TerminologyCapabilities.useContext |
| date N | date | conformance-date | The terminology capabilities publication date | TerminologyCapabilities.date |
| description N | string | conformance-description | The description of the terminology capabilities | TerminologyCapabilities.description |
| identifier | token | conformance-identifier | External identifier for the terminology capabilities | TerminologyCapabilities.identifier |
| jurisdiction | token | conformance-jurisdiction | Intended jurisdiction for the terminology capabilities | TerminologyCapabilities.jurisdiction |
| name N | string | conformance-name | Computationally friendly name of the terminology capabilities | TerminologyCapabilities.name |
| publisher N | string | conformance-publisher | Name of the publisher of the terminology capabilities | TerminologyCapabilities.publisher |
| status N | token | conformance-status | The current status of the terminology capabilities | TerminologyCapabilities.status |
| title N | string | conformance-title | The human-friendly name of the terminology capabilities | TerminologyCapabilities.title |
| url N | uri | conformance-url | The uri that identifies the terminology capabilities | TerminologyCapabilities.url |
| version N | token | conformance-version | 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 N | date | TestReport-issued | The test report generation date | TestReport.issued |
| participant N | uri | TestReport-participant | The reference to a participant in the test execution | TestReport.participant.uri |
| result N | token | TestReport-result | The result disposition of the test execution | TestReport.result |
| tester N | 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 | TestScript-context | A use context assigned to the test script | (TestScript.useContext.value as CodeableConcept) |
| context-quantity | quantity | TestScript-context-quantity | A quantity- or range-valued use context assigned to the test script | (TestScript.useContext.value as Quantity) | (TestScript.useContext.value as Range) |
| context-type | token | TestScript-context-type | A type of use context assigned to the test script | TestScript.useContext.code |
| context-type-quantity | composite | TestScript-context-type-quantity | A use context type and quantity- or range-based value assigned to the test script | TestScript.useContext |
| context-type-value | composite | TestScript-context-type-value | A use context type and value assigned to the test script | TestScript.useContext |
| date N | date | TestScript-date | The test script publication date | TestScript.date |
| description N | string | TestScript-description | The description of the test script | TestScript.description |
| identifier | token | TestScript-identifier | External identifier for the test script | TestScript.identifier |
| jurisdiction | token | TestScript-jurisdiction | Intended jurisdiction for the test script | TestScript.jurisdiction |
| name N | string | TestScript-name | Computationally friendly name of the test script | TestScript.name |
| publisher N | string | TestScript-publisher | Name of the publisher of the test script | TestScript.publisher |
| status N | token | TestScript-status | The current status of the test script | TestScript.status |
| testscript-capability N | string | TestScript-testscript-capability | TestScript required and validated capability | TestScript.metadata.capability.description |
| title N | string | TestScript-title | The human-friendly name of the test script | TestScript.title |
| url N | uri | TestScript-url | The uri that identifies the test script | TestScript.url |
| version N | token | TestScript-version | The business version of the test script | TestScript.version |
| 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 | conformance-context | A use context assigned to the value set | (ValueSet.useContext.value as CodeableConcept) |
| context-quantity TU | quantity | conformance-context-quantity | A quantity- or range-valued use context assigned to the value set | (ValueSet.useContext.value as Quantity) | (ValueSet.useContext.value as Range) |
| context-type TU | token | conformance-context-type | A type of use context assigned to the value set | ValueSet.useContext.code |
| context-type-quantity TU | composite | conformance-context-type-quantity | A use context type and quantity- or range-based value assigned to the value set | ValueSet.useContext |
| context-type-value TU | composite | conformance-context-type-value | A use context type and value assigned to the value set | ValueSet.useContext |
| date | date | conformance-date | The value set publication date | ValueSet.date |
| description | string | conformance-description | The description of the value set | ValueSet.description |
| expansion | uri | ValueSet-expansion | Identifies the value set expansion (business identifier) | ValueSet.expansion.identifier |
| identifier TU | token | conformance-identifier | External identifier for the value set | ValueSet.identifier |
| jurisdiction TU | token | conformance-jurisdiction | Intended jurisdiction for the value set | ValueSet.jurisdiction |
| name | string | conformance-name | Computationally friendly name of the value set | ValueSet.name |
| publisher | string | conformance-publisher | 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 | token | conformance-status | The current status of the value set | ValueSet.status |
| title | string | conformance-title | The human-friendly name of the value set | ValueSet.title |
| url | uri | conformance-url | The uri that identifies the value set | ValueSet.url |
| version | token | conformance-version | The business version of the value set | ValueSet.version |
| VerificationResult TU | ||||
| target | reference | VerificationResult-target | A resource that was validated | VerificationResult.target |
| VisionPrescription TU | ||||
| datewritten N | 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 N | token | VisionPrescription-status | The status of the vision prescription | VisionPrescription.status |
FHIR ®© HL7.org 2011+. FHIR CI Build hl7.fhir.core#4.4.0 generated on Sun, May 3, 2020 08:48+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change