This
page
is
part
of
the
FHIR
Specification
(v3.3.0:
(v3.5.0:
R4
Ballot
2).
#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 | Ballot 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 | 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 | reference | Resource-profile |
Profiles this resource claims to conform to |
Resource.meta.profile |
| _query | token | Resource-query |
A custom search profile that describes a specific defined query operation |
|
| _security | 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 | token | Resource-tag |
Tags applied to this resource |
Resource.meta.tag |
| DomainResource N | ||||
| _text | string | DomainResource-text |
Search on the narrative of the resource |
|
| Common Search Parameters | ||||
| address N | string | individual-address |
Multiple Resources:
|
|
| address-city N | string | individual-address-city |
Multiple Resources:
|
|
| address-country N | string | individual-address-country |
Multiple Resources:
|
|
| address-postalcode N | string | individual-address-postalcode |
Multiple Resources:
|
|
| address-state N | string | individual-address-state |
Multiple Resources:
|
|
| address-use N | token | individual-address-use |
Multiple Resources:
|
|
| birthdate N | date | individual-birthdate |
Multiple Resources:
|
|
| code TU | token |
|
Multiple Resources:
|
AllergyIntolerance.code
|
AllergyIntolerance.reaction.substance
|
Condition.code
|
(DeviceRequest.code
as
CodeableConcept)
|
DiagnosticReport.code
|
FamilyMemberHistory.condition.code
|
List.code
|
Medication.code
|
|
|
|
token |
|
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:
|
|
| context-type TU | token | conformance-context-type |
Multiple Resources:
|
|
|
|
|
|
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:
|
|
| date TU | date | clinical-date |
Multiple Resources:
|
|
| description N | string | conformance-description |
Multiple Resources:
|
|
| email N | token | individual-email |
Multiple Resources:
|
|
| encounter TU | reference | clinical-encounter |
Multiple Resources:
|
|
| family N | string | individual-family |
Multiple Resources:
|
|
| gender N | token | individual-gender |
Multiple Resources:
|
|
| given N | string | individual-given |
Multiple Resources:
|
|
| identifier TU | token | clinical-identifier |
Multiple Resources:
|
|
| identifier N | token | conformance-identifier |
Multiple Resources:
|
|
| jurisdiction N | token | conformance-jurisdiction |
Multiple Resources:
|
|
| medication TU | reference | medications-medication |
Multiple Resources:
|
|
| name N | string | conformance-name |
Multiple Resources:
|
|
| patient TU | reference | clinical-patient |
Multiple Resources:
|
|
| phone N | token | individual-phone |
Multiple Resources:
|
|
| phonetic N | string | individual-phonetic |
Multiple Resources:
|
|
| publisher N | string | conformance-publisher |
Multiple Resources:
|
|
| status N | token | conformance-status |
Multiple Resources:
|
|
| status TU | token | medications-status |
Multiple Resources:
|
|
| telecom N | token | individual-telecom |
Multiple Resources:
|
|
| title N | string | conformance-title |
Multiple Resources:
|
|
| type TU | token | clinical-type |
Multiple Resources:
|
AllergyIntolerance.type
|
Composition.type
|
DocumentManifest.type
|
DocumentReference.type
|
Encounter.type
|
|
| url N | uri | conformance-url |
Multiple Resources:
|
|
| version N | token | conformance-version |
Multiple Resources:
|
|
| Account TU | ||||
| identifier | token | Account-identifier |
Account number |
Account.identifier |
| name | string | Account-name |
Human-readable label |
Account.name |
| owner | reference | Account-owner |
Who is responsible? |
|
| patient | reference | Account-patient |
What is account tied to? |
|
| period | date | Account-period |
Transaction window |
Account.servicePeriod |
| status | token | Account-status |
active | inactive | entered-in-error | on-hold | unknown |
Account.status |
| subject | reference | Account-subject |
What is account tied to? |
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 | 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 | 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 | 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 | string | ActivityDefinition-publisher |
Name of the publisher of the activity definition |
ActivityDefinition.publisher |
| status | 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 | 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 | uri | ActivityDefinition-url |
The uri that identifies the activity definition |
ActivityDefinition.url |
| version | token | ActivityDefinition-version |
The business version of the activity definition |
ActivityDefinition.version |
| AdverseEvent TU | ||||
| actuality | token | AdverseEvent-actuality |
actual | potential |
AdverseEvent.actuality |
| category | token | AdverseEvent-category |
|
AdverseEvent.category |
| date | date | AdverseEvent-date |
When the event occurred |
AdverseEvent.date |
| event | token | AdverseEvent-event |
Type of the event itself in relation to the subject |
AdverseEvent.event |
| location | reference | AdverseEvent-location |
Location where adverse event occurred |
AdverseEvent.location |
| 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 of the event |
AdverseEvent.seriousness |
| severity | token | AdverseEvent-severity |
|
AdverseEvent.severity |
| study | reference | AdverseEvent-study |
AdverseEvent.study |
AdverseEvent.study |
| subject | reference | AdverseEvent-subject |
Subject impacted by event |
AdverseEvent.subject |
| substance | reference | AdverseEvent-substance |
Refers to the specific entity that caused the adverse event |
AdverseEvent.suspectEntity.instance |
| AllergyIntolerance TU | ||||
| asserter | reference | AllergyIntolerance-asserter |
Source of the information about the allergy |
AllergyIntolerance.asserter |
| category | token | AllergyIntolerance-category |
food | medication | environment | biologic |
AllergyIntolerance.category |
| clinical-status | token | AllergyIntolerance-clinical-status |
active | inactive | resolved |
AllergyIntolerance.clinicalStatus |
| code | token | clinical-code |
Code that identifies the allergy or intolerance |
AllergyIntolerance.code | AllergyIntolerance.reaction.substance |
| criticality | token | AllergyIntolerance-criticality |
low | high | unable-to-assess |
AllergyIntolerance.criticality |
| date | date | clinical-date |
Date
record
was
|
|
| identifier | token | clinical-identifier |
External ids for this item |
AllergyIntolerance.identifier |
| last-date | date | AllergyIntolerance-last-date |
Date(/time) of last known occurrence of a reaction |
AllergyIntolerance.lastOccurrence |
| manifestation | token | AllergyIntolerance-manifestation |
Clinical symptoms/signs associated with the Event |
AllergyIntolerance.reaction.manifestation |
| onset | date | AllergyIntolerance-onset |
Date(/time) when manifestations showed |
AllergyIntolerance.reaction.onset |
| 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 | token | AllergyIntolerance-severity |
mild | moderate | severe (of event as a whole) |
AllergyIntolerance.reaction.severity |
| type | token | clinical-type |
allergy | intolerance - Underlying mechanism (if known) |
AllergyIntolerance.type |
| verification-status | token | AllergyIntolerance-verification-status |
unconfirmed | 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 |
|
| date | 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 |
|
| part-status | token | Appointment-part-status |
The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests. |
Appointment.participant.status |
| patient | reference | Appointment-patient |
One of the individuals of the appointment is this patient |
|
| practitioner | reference | Appointment-practitioner |
One of the individuals of the appointment is this practitioner |
|
| service-type | token | Appointment-service-type |
The specific service that is to be performed during this appointment |
Appointment.serviceType |
| status | token | Appointment-status |
The overall status of the appointment |
Appointment.status |
| 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 |
|
| part-status | token | AppointmentResponse-part-status |
The participants acceptance status for this appointment |
AppointmentResponse.participantStatus |
| patient | reference | AppointmentResponse-patient |
This Response is for this Patient |
|
| practitioner | reference | AppointmentResponse-practitioner |
This Response is for this Practitioner |
|
| AuditEvent TU | ||||
| action | token | AuditEvent-action |
Type of action performed during the event |
AuditEvent.action |
| address | string | AuditEvent-address |
Identifier for the network access point of the user device |
AuditEvent.agent.network.address |
| agent | reference | AuditEvent-agent |
|
|
| agent-name | string | AuditEvent-agent-name |
|
AuditEvent.agent.name |
| agent-role | token | AuditEvent-agent-role |
Agent role in the event |
AuditEvent.agent.role |
| altid | token | AuditEvent-altid |
Alternative
User
|
AuditEvent.agent.altId |
| date | date | AuditEvent-date |
Time when the event was recorded |
AuditEvent.recorded |
| entity | reference | AuditEvent-entity |
Specific instance of resource |
|
| entity-name | 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 |
|
|
| policy | uri | AuditEvent-policy |
Policy that authorized event |
AuditEvent.agent.policy |
| site | token | AuditEvent-site |
Logical source location within the enterprise |
AuditEvent.source.site |
| source |
|
AuditEvent-source |
The identity of source detecting the event |
|
| 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 | 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 |
|
| 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 | 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
|
Bundle.entry[0].resource |
| identifier | token | Bundle-identifier |
Persistent identifier for the bundle |
Bundle.identifier |
| message | reference | Bundle-message |
The first resource in the bundle, if the bundle type is "message" - this is a message header, and this parameter provides access to search its contents |
Bundle.entry[0].resource |
| timestamp | date | Bundle-timestamp |
When the bundle was assembled |
Bundle.timestamp |
| type | token | Bundle-type |
document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection |
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 | 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 a the name of a software application |
CapabilityStatement.software.name |
| status | token | conformance-status |
The current status of the capability statement |
CapabilityStatement.status |
| supported-profile TU | reference | CapabilityStatement-supported-profile |
Profiles for use cases supported |
CapabilityStatement.rest.resource.supportedProfile |
| title | 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 |
| CarePlan TU | ||||
| activity-code | token | CarePlan-activity-code |
Detail type of activity |
CarePlan.activity.detail.code |
| activity-date | date | CarePlan-activity-date |
Specified
date
occurs
within
period
specified
by
|
CarePlan.activity.detail.scheduled |
| activity-reference | reference | CarePlan-activity-reference |
Activity details defined in specific resource |
CarePlan.activity.reference |
| based-on | reference | CarePlan-based-on |
Fulfills CarePlan |
CarePlan.basedOn |
| care-team | reference | CarePlan-care-team |
Who's involved in plan? |
CarePlan.careTeam |
| category | token | CarePlan-category |
Type of plan |
CarePlan.category |
| condition | reference | CarePlan-condition |
Health issues this plan addresses |
CarePlan.addresses |
| context | reference | CarePlan-context |
Created in context of |
CarePlan.context |
| date | date | clinical-date |
Time period plan covers |
CarePlan.period |
| encounter | reference | CarePlan-encounter |
Created in context of |
|
| goal | reference | CarePlan-goal |
Desired outcome of plan |
CarePlan.goal |
| identifier | token | clinical-identifier |
External Ids for this plan |
CarePlan.identifier |
|
| reference | CarePlan-instantiates-canonical | Instantiates FHIR protocol or definition | CarePlan.instantiatesCanonical |
| instantiates-uri | uri |
|
|
|
| intent | token | CarePlan-intent |
proposal | plan | order | option |
CarePlan.intent |
| part-of | reference | CarePlan-part-of |
Part of referenced CarePlan |
CarePlan.partOf |
| patient | reference | clinical-patient |
Who the care plan is for |
|
| 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 | token | CarePlan-status |
draft | active | suspended | completed | entered-in-error | cancelled | 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 |
| context | reference | CareTeam-context |
Encounter or episode associated with CareTeam |
CareTeam.context |
| date | date | clinical-date |
Time period team covers |
CareTeam.period |
| encounter | reference | CareTeam-encounter |
Encounter or episode associated with CareTeam |
|
| identifier | token | clinical-identifier |
External Ids for this team |
CareTeam.identifier |
| participant | reference | CareTeam-participant |
Who is involved |
CareTeam.participant.member |
| patient | reference | clinical-patient |
Who care team is for |
|
| status | token | CareTeam-status |
proposed | active | suspended | inactive | entered-in-error |
CareTeam.status |
| subject | reference | CareTeam-subject |
Who care team is for |
CareTeam.subject |
| ChargeItem TU | ||||
| account | reference | ChargeItem-account |
Account to place this charge |
ChargeItem.account |
| code | token | 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 | date | ChargeItem-entered-date |
Date the charge item was entered |
ChargeItem.enteredDate |
| enterer | reference | ChargeItem-enterer |
Individual who was entering |
ChargeItem.enterer |
| factor-override | number | ChargeItem-factor-override |
Factor overriding the associated rules |
ChargeItem.factorOverride |
| identifier | token | ChargeItem-identifier |
Business Identifier for item |
ChargeItem.identifier |
| occurrence | date | ChargeItem-occurrence |
When the charged service was applied |
ChargeItem.occurrence |
|
|
reference |
|
Individual
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| performing-organization | reference | ChargeItem-performing-organization |
Organization providing the charged sevice |
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 | date | ChargeItemDefinition-date | The charge item definition publication date | ChargeItemDefinition.date |
| description | 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 | string | ChargeItemDefinition-publisher | Name of the publisher of the charge item definition | ChargeItemDefinition.publisher |
| status | token | ChargeItemDefinition-status | The current status of the charge item definition | ChargeItemDefinition.status |
| title | string | ChargeItemDefinition-title | The human-friendly name of the charge item definition | ChargeItemDefinition.title |
| url | uri | ChargeItemDefinition-url | The uri that identifies the charge item definition | ChargeItemDefinition.url |
| version | token | ChargeItemDefinition-version | The business version of the charge item definition | ChargeItemDefinition.version |
| Claim TU | ||||
| care-team | reference | Claim-care-team |
Member of the CareTeam |
Claim.careTeam.provider |
| created | date | Claim-created |
The creation date for the Claim |
Claim.created |
| 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 responsible for the goods and services |
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 |
| patient | reference | Claim-patient |
Patient receiving the 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 |
| provider | reference | Claim-provider |
Provider responsible for the Claim |
Claim.provider |
| status | token | Claim-status |
The status of the Claim instance. |
Claim.status |
| use | token | Claim-use |
The kind of financial resource |
Claim.use |
| ClaimResponse TU | ||||
| created | date | ClaimResponse-created |
The creation date |
ClaimResponse.created |
| disposition | string | ClaimResponse-disposition |
The contents of the disposition message |
ClaimResponse.disposition |
| identifier | token | ClaimResponse-identifier |
The
identity
of
the
|
ClaimResponse.identifier |
| insurer | reference | ClaimResponse-insurer |
The organization who generated this resource |
ClaimResponse.insurer |
| outcome | token | ClaimResponse-outcome |
The processing outcome |
ClaimResponse.outcome |
| patient | reference | ClaimResponse-patient |
The
subject
of
|
ClaimResponse.patient |
| payment-date | date | ClaimResponse-payment-date |
The
expected
|
ClaimResponse.payment.date |
| request | reference | ClaimResponse-request |
The claim reference |
ClaimResponse.request |
| request-provider | reference | ClaimResponse-request-provider |
The Provider of the claim |
ClaimResponse.requestProvider |
| status | token | ClaimResponse-status |
The
status
of
the
|
ClaimResponse.status |
|
ClinicalImpression
|
||||
| assessor | reference | ClinicalImpression-assessor |
The clinician performing the assessment |
ClinicalImpression.assessor |
| context | reference | ClinicalImpression-context |
Encounter or Episode created from |
ClinicalImpression.context |
| date | date | clinical-date |
When the assessment was documented |
ClinicalImpression.date |
| finding-code | token | ClinicalImpression-finding-code |
What was found |
ClinicalImpression.finding.itemCodeableConcept |
| finding-ref | reference | ClinicalImpression-finding-ref |
What was found |
ClinicalImpression.finding.itemReference |
| identifier | token | ClinicalImpression-identifier |
Business identifier |
ClinicalImpression.identifier |
| investigation | reference | ClinicalImpression-investigation |
Record of a specific investigation |
ClinicalImpression.investigation.item |
| patient | reference | clinical-patient |
Patient or group assessed |
|
| previous | reference | ClinicalImpression-previous |
Reference to last assessment |
ClinicalImpression.previous |
| problem | reference | ClinicalImpression-problem |
Relevant impressions of patient state |
ClinicalImpression.problem |
| status | token | ClinicalImpression-status |
draft | completed | entered-in-error |
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 |
| 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 | token | conformance-identifier |
External identifier for the code system |
CodeSystem.identifier |
| jurisdiction | 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 |
|
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 |
| context | reference | Communication-context |
Encounter or episode leading to message |
Communication.context |
| encounter | reference | Communication-encounter |
Encounter leading to message |
|
| identifier | token | Communication-identifier |
Unique identifier |
Communication.identifier |
|
| reference | Communication-instantiates-canonical | Instantiates FHIR protocol or definition | Communication.instantiatesCanonical |
| instantiates-uri | uri |
|
Instantiates external protocol or definition |
|
| medium | token | Communication-medium |
A channel of communication |
Communication.medium |
| part-of | reference | Communication-part-of |
Part of this action |
Communication.partOf |
| patient | reference | Communication-patient |
Focus of message |
|
| received | date | Communication-received |
When received |
Communication.received |
| recipient | reference | Communication-recipient |
Message recipient |
Communication.recipient |
| sender | reference | Communication-sender |
Message sender |
Communication.sender |
| sent | date | Communication-sent |
When sent |
Communication.sent |
| status | token | Communication-status |
preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error |
Communication.status |
| subject | reference | Communication-subject |
Focus of message |
Communication.subject |
| CommunicationRequest TU | ||||
| authored | date | CommunicationRequest-authored |
When request transitioned to being actionable |
CommunicationRequest.authoredOn |
| based-on | reference | CommunicationRequest-based-on |
Fulfills plan or proposal |
CommunicationRequest.basedOn |
| category | token | CommunicationRequest-category |
Message category |
CommunicationRequest.category |
| context | reference | CommunicationRequest-context |
Encounter or episode leading to message |
CommunicationRequest.context |
| encounter | reference | CommunicationRequest-encounter |
Encounter leading to message |
|
| group-identifier | token | CommunicationRequest-group-identifier |
Composite request this is part of |
CommunicationRequest.groupIdentifier |
| identifier | token | CommunicationRequest-identifier |
Unique identifier |
CommunicationRequest.identifier |
| medium | token | CommunicationRequest-medium |
A channel of communication |
CommunicationRequest.medium |
| occurrence | date | CommunicationRequest-occurrence |
When scheduled |
|
| patient | reference | CommunicationRequest-patient |
Focus of message |
|
| priority | token | CommunicationRequest-priority |
Message urgency |
CommunicationRequest.priority |
| recipient | reference | CommunicationRequest-recipient |
Message recipient |
CommunicationRequest.recipient |
| replaces | reference | CommunicationRequest-replaces |
Request(s) replaced by this request |
CommunicationRequest.replaces |
| requester | reference | CommunicationRequest-requester |
Who/what is requesting service |
CommunicationRequest.requester |
| sender | reference | CommunicationRequest-sender |
Message sender |
CommunicationRequest.sender |
| status | token | CommunicationRequest-status |
draft | active | suspended | cancelled | completed | entered-in-error | unknown |
CommunicationRequest.status |
| subject | reference | CommunicationRequest-subject |
Focus of message |
CommunicationRequest.subject |
| CompartmentDefinition TU | ||||
| code | token | CompartmentDefinition-code |
Patient | Encounter | RelatedPerson | Practitioner | Device |
CompartmentDefinition.code |
| context | token | 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 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| CompartmentDefinition.date |
| description N | string | conformance-description | The description of the compartment definition |
|
| 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 | token | CompartmentDefinition-resource |
Name of resource type |
CompartmentDefinition.resource.code |
| status N | token | conformance-status |
The current status of the compartment definition |
CompartmentDefinition.status |
|
|
|
|
The
|
|
|
|
|
|
The
|
|
| 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 |
|
|
token |
|
Categorization of Composition |
|
| confidentiality | 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 | 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 |
|
| period | date | Composition-period |
The period covered by the documentation |
Composition.event.period |
| related-id | token | Composition-related-id |
Target of the relationship |
|
| related-ref | reference | Composition-related-ref |
Target of the relationship |
|
| section | token | Composition-section |
Classification of section (recommended) |
Composition.section.code |
| status | token | Composition-status |
preliminary | final | amended | entered-in-error |
Composition.status |
| subject | reference | Composition-subject |
Who and/or what the composition is about |
Composition.subject |
| title | string | Composition-title |
Human Readable name/title |
Composition.title |
| type | token | clinical-type |
Kind of composition (LOINC if possible) |
Composition.type |
| 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 | 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 N | token | conformance-identifier |
External identifier for the concept map |
ConceptMap.identifier |
| jurisdiction N | 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 | reference | ConceptMap-other |
Canonical URI for an additional ConceptMap to use for mapping if the source concept is unmapped |
ConceptMap.group.unmapped.url |
| product | 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 |
|
| source-code | token | ConceptMap-source-code |
Identifies element being mapped |
ConceptMap.group.element.code |
| source-system | 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 |
|
| 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 |
|
| target-code | token | ConceptMap-target-code |
Code that identifies the target element |
ConceptMap.group.element.target.code |
| target-system | 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 |
|
| 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) |
|
|
reference | Condition-asserter |
Person who 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 |
| context | reference | Condition-context |
Encounter or episode when condition first asserted |
Condition.context |
| encounter | reference | Condition-encounter |
Encounter when condition first asserted |
|
| 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? |
|
| recorded-date | date | Condition-recorded-date | Date record was first recorded | Condition.recordedDate |
| severity | token | Condition-severity |
The severity of the condition |
Condition.severity |
| stage | token | Condition-stage |
Simple summary (disease specific) |
Condition.stage.summary |
| subject | reference | Condition-subject |
Who has the condition? |
Condition.subject |
| verification-status | token | Condition-verification-status |
unconfirmed | provisional | differential | confirmed | refuted | entered-in-error |
Condition.verificationStatus |
| 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 | date | clinical-date |
When this Consent was created or indexed |
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.patient |
| period | date | Consent-period |
Timeframe for this rule |
Consent.provision.period |
| purpose | token | Consent-purpose |
Context of activities covered by this rule |
Consent.provision.purpose |
| scope | token | Consent-scope |
Which of the four areas this resource covers (extensible) |
Consent.scope |
|
|
token |
|
Security Labels that define affected resources |
Consent.provision.securityLabel |
| source-identifier | token | Consent-source-identifier |
Search by token to an identifier |
Consent.source |
| source-reference | reference | Consent-source-reference |
Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse |
|
| status | token | Consent-status |
draft | proposed | active | rejected | inactive | entered-in-error |
Consent.status |
| 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 | uri | Contract-instantiates | A source definition of the contract | Contract.instantiatesUri |
| issued | date | Contract-issued |
The date/time the contract was issued |
Contract.issued |
| patient | reference | Contract-patient |
The identity of the subject of the contract (if a patient) |
|
| signer | reference | Contract-signer |
Contract Signatory Party |
Contract.signer.party |
| status | token | Contract-status |
The status of the contract |
Contract.status |
| subject | reference | Contract-subject |
The identity of the subject of the contract |
Contract.subject |
| url | uri | Contract-url | The basal contract definition | Contract.url |
| Coverage TU | ||||
| beneficiary | reference | Coverage-beneficiary |
Covered party |
Coverage.beneficiary |
| dependent | 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 | 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 | 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 | token | CoverageEligibilityRequest-status | The status of the EligibilityRequest | CoverageEligibilityRequest.status |
| CoverageEligibilityResponse TU | ||||
| created | date | CoverageEligibilityResponse-created | The creation date | CoverageEligibilityResponse.created |
| disposition | string | CoverageEligibilityResponse-disposition | The contents of the disposition message | CoverageEligibilityResponse.disposition |
| identifier | token | CoverageEligibilityResponse-identifier | The business identifier | CoverageEligibilityResponse.identifier |
| insurer | reference | CoverageEligibilityResponse-insurer | The organization which generated this resource | CoverageEligibilityResponse.insurer |
| outcome | token | CoverageEligibilityResponse-outcome | The processing outcome | CoverageEligibilityResponse.outcome |
| patient | reference | CoverageEligibilityResponse-patient | The reference to the patient | CoverageEligibilityResponse.patient |
| request | reference | CoverageEligibilityResponse-request | The EligibilityRequest reference | CoverageEligibilityResponse.request |
| request-provider | reference | CoverageEligibilityResponse-request-provider | The EligibilityRequest provider | CoverageEligibilityResponse.requestProvider |
| status | token | CoverageEligibilityResponse-status | The EligibilityRequest status | CoverageEligibilityResponse.status |
| DetectedIssue TU | ||||
| author | reference | DetectedIssue-author |
The provider or device that identified the issue |
DetectedIssue.author |
| category | token | DetectedIssue-category |
Issue Category, e.g. drug-drug, duplicate therapy, etc. |
DetectedIssue.category |
| date | date | clinical-date |
When identified |
DetectedIssue.date |
| 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 | ||||
| device-name | string | Device-device-name |
A server defined search that may match any of the string fields in the Device.udi.name or Device.type.coding.display or Device.type.text |
|
| 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 |
| manufacturer | string | Device-manufacturer |
The manufacturer of the device |
Device.manufacturer |
| model | string | Device-model |
The model of the device |
|
| organization | reference | Device-organization |
The organization responsible for the device |
Device.owner |
| patient | reference | Device-patient |
Patient information, if the resource is affixed to a person |
Device.patient |
| status | token | Device-status |
active | inactive | entered-in-error | unknown |
Device.status |
| type | token | Device-type |
The type of the device |
Device.type |
| udi-carrier | string | Device-udi-carrier |
UDI Barcode (RFID or other technology) string either in HRF format or AIDC format converted to base64 string. |
|
| udi-di | string | Device-udi-di |
The udi Device Identifier (DI) |
|
| url | uri | Device-url |
Network address to contact device |
Device.url |
|
|
||||
| identifier | token |
|
The identifier of the component |
|
| parent | reference |
|
The
parent
|
|
| type | token |
|
The device component type |
|
| DeviceMetric TU | ||||
| category | 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 | date | DeviceRequest-authored-on |
When the request transitioned to being actionable |
DeviceRequest.authoredOn |
| based-on | reference | DeviceRequest-based-on |
Plan/proposal/order fulfilled by this request |
DeviceRequest.basedOn |
| code | token | clinical-code |
Code for what is being requested/ordered |
|
| device | reference | DeviceRequest-device |
Reference to resource that is being requested/ordered |
|
| encounter | reference | clinical-encounter |
Encounter or Episode during which request was created |
DeviceRequest.context |
| event-date | date | DeviceRequest-event-date |
When service should occur |
|
| group-identifier | token | DeviceRequest-group-identifier |
Composite request this is part of |
DeviceRequest.groupIdentifier |
| identifier | token | clinical-identifier |
Business identifier for request/order |
DeviceRequest.identifier |
|
| reference | DeviceRequest-instantiates-canonical | Instantiates FHIR protocol or definition | DeviceRequest.instantiatesCanonical |
| instantiates-uri | uri |
|
|
|
| insurance | reference | DeviceRequest-insurance |
Associated insurance coverage |
DeviceRequest.insurance |
| intent | token | DeviceRequest-intent |
proposal | plan | original-order |reflex-order |
DeviceRequest.intent |
| patient | reference | clinical-patient |
Individual the service is ordered for |
|
| performer | reference | DeviceRequest-performer |
Desired performer for service |
DeviceRequest.performer |
|
|
reference |
|
Request takes the place of referenced completed or terminated requests |
DeviceRequest.priorRequest |
| requester | reference | DeviceRequest-requester |
Who/what is requesting service |
DeviceRequest.requester |
| status | token | DeviceRequest-status |
entered-in-error | draft | active |suspended | completed |
DeviceRequest.status |
| subject | reference | DeviceRequest-subject |
Individual the service is ordered for |
DeviceRequest.subject |
| DeviceUseStatement TU | ||||
| device | reference | DeviceUseStatement-device |
Search by device |
DeviceUseStatement.device |
| 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 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| encounter | reference | clinical-encounter |
The Encounter when the order was made |
|
| identifier | token | clinical-identifier |
An identifier for the report |
DiagnosticReport.identifier |
| issued | date | DiagnosticReport-issued |
When the report was issued |
DiagnosticReport.issued |
| media | reference | DiagnosticReport-media |
A reference to the image source. |
DiagnosticReport.media.link |
| patient | reference | clinical-patient |
The subject of the report if a patient |
|
| performer | reference | DiagnosticReport-performer |
Who is responsible for the report |
DiagnosticReport.performer |
| result | reference | DiagnosticReport-result |
Link to an atomic result (observation resource) |
DiagnosticReport.result |
| results-interpreter | reference | DiagnosticReport-results-interpreter |
Who was the source of the report |
DiagnosticReport.resultsInterpreter |
| specimen | reference | DiagnosticReport-specimen |
The specimen details |
DiagnosticReport.specimen |
| status | token | DiagnosticReport-status |
The status of the report |
DiagnosticReport.status |
| subject | reference | DiagnosticReport-subject |
The subject of the report |
DiagnosticReport.subject |
| DocumentManifest TU | ||||
| agent | reference | DocumentManifest-agent |
Who and/or what had an agent participation |
DocumentManifest.agent.who |
| created | date | DocumentManifest-created |
When this document manifest created |
DocumentManifest.created |
| description | 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 |
|
| 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 | uri | DocumentManifest-source |
The source system/application/software |
DocumentManifest.source |
| status | token | DocumentManifest-status |
current | superseded | entered-in-error |
DocumentManifest.status |
| subject | reference | DocumentManifest-subject |
The subject of the set of documents |
DocumentManifest.subject |
| type | token | clinical-type |
Kind of document set |
DocumentManifest.type |
| DocumentReference TU | ||||
| agent | reference | DocumentReference-agent |
Who and/or what authored the document |
DocumentReference.agent.who |
| authenticator | reference | DocumentReference-authenticator |
Who/what authenticated the document |
DocumentReference.authenticator |
|
|
token |
|
Categorization of document |
|
| contenttype | token | DocumentReference-contenttype |
Mime type of the content, with charset etc. |
DocumentReference.content.attachment.contentType |
|
|
reference | DocumentReference-custodian |
Organization which maintains the document |
DocumentReference.custodian |
| date | date | DocumentReference-date |
When this document reference was created |
DocumentReference.date |
| description | string | DocumentReference-description |
Human-readable
description
|
DocumentReference.description |
| 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 | token | DocumentReference-language |
Human language of the content (BCP-47) |
DocumentReference.content.attachment.language |
| location | uri | DocumentReference-location |
Uri where the data can be found |
DocumentReference.content.attachment.url |
| patient | reference | clinical-patient |
Who/what is the subject of the document |
|
| period | date | DocumentReference-period |
Time of service that is being documented |
DocumentReference.context.period |
|
|
reference |
|
Related
|
|
| relatesto | reference | DocumentReference-relatesto |
Target of the relationship |
DocumentReference.relatesTo.target |
| relation | token | DocumentReference-relation |
replaces | transforms | signs | appends |
DocumentReference.relatesTo.code |
| relationship | composite | DocumentReference-relationship |
Combination of relation and relatesTo |
DocumentReference.relatesTo |
|
|
token |
|
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 | token | DocumentReference-status |
current | superseded | entered-in-error |
DocumentReference.status |
| subject | reference | DocumentReference-subject |
Who/what is the subject of the document |
DocumentReference.subject |
| type | token | clinical-type |
Kind of document (LOINC if possible) |
DocumentReference.type |
|
|
||||
| account | reference | Encounter-account |
The set of accounts that may be used for billing for this Encounter |
|
| appointment | reference | Encounter-appointment |
The appointment that scheduled this encounter |
|
| based-on | reference | Encounter-based-on |
The ServiceRequest that initiated this encounter |
|
| class | token | Encounter-class |
Classification of patient encounter |
Encounter.class |
| date | date | clinical-date |
A date within the period the Encounter lasted |
Encounter.period |
| diagnosis | reference | Encounter-diagnosis |
Reason the encounter takes place (resource) |
Encounter.diagnosis.condition |
|
|
reference |
|
Episode(s) of care that this encounter should be recorded against |
|
| 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 |
|
| 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 |
|
| 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 |
|
| practitioner | reference | Encounter-practitioner |
Persons involved in the encounter other than the patient |
|
| reason | token | Encounter-reason |
Reason the encounter takes place (code) |
Encounter.reason |
| service-provider | reference | Encounter-service-provider |
The organization (facility) responsible for this encounter |
|
| special-arrangement | token | Encounter-special-arrangement |
Wheelchair, translator, stretcher, etc. |
Encounter.hospitalization.specialArrangement |
| status | token | Encounter-status |
planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
Encounter.status |
| subject | reference | Encounter-subject |
The patient or group present at the encounter |
Encounter.subject |
| type | 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 | 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 |
|
| 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 | 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 | token | EnrollmentRequest-status |
The status fo the enrollment |
EnrollmentRequest.status |
| subject | reference | EnrollmentRequest-subject |
The party to be enrolled |
EnrollmentRequest.candidate |
| EnrollmentResponse TU | ||||
| identifier | token | EnrollmentResponse-identifier |
The business identifier of the EnrollmentResponse |
EnrollmentResponse.identifier |
| request | reference | EnrollmentResponse-request |
The reference to the claim |
EnrollmentResponse.request |
| status | token | EnrollmentResponse-status |
The status of the enrollment response |
EnrollmentResponse.status |
| EpisodeOfCare TU | ||||
| care-manager | reference | EpisodeOfCare-care-manager |
Care manager/care coordinator for the patient |
|
| condition | reference | EpisodeOfCare-condition |
Conditions/problems/diagnoses this episode of care is for |
|
| date | 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 |
|
|
reference |
|
Incoming Referral Request |
|
| organization | reference | EpisodeOfCare-organization |
The organization that has assumed the specific responsibilities of this EpisodeOfCare |
|
| patient | reference | clinical-patient |
The patient who is the focus of this episode of care |
|
| status | token | EpisodeOfCare-status |
The current status of the Episode of Care as provided (does not check the status history collection) |
EpisodeOfCare.status |
| type | token | clinical-type |
Type/class - e.g. specialist referral, disease management |
EpisodeOfCare.type |
| EventDefinition TU | ||||
| composed-of | reference | 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 | 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 | 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 | 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 | string | EventDefinition-publisher |
Name of the publisher of the event definition |
EventDefinition.publisher |
| status | 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 | 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 | uri | EventDefinition-url |
The uri that identifies the event definition |
EventDefinition.url |
| version | token | EventDefinition-version |
The business version of the event definition |
EventDefinition.version |
|
ExampleScenario
|
||||
|
|
token |
|
|
|
|
|
|
|
|
|
|
|
token |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| date | date |
|
The
|
|
| identifier | token |
|
External
identifier
for
the
|
|
| jurisdiction | token |
|
Intended
jurisdiction
for
the
|
|
| name | string |
|
Computationally
friendly
name
of
the
|
|
| publisher | string |
|
Name
of
the
publisher
of
the
|
|
| status | token |
|
The
current
status
of
the
|
|
| url | uri |
|
The
uri
that
identifies
the
|
|
| version | token |
|
The
business
version
of
the
|
|
| ExplanationOfBenefit TU | ||||
| care-team | reference | ExplanationOfBenefit-care-team |
Member of the CareTeam |
ExplanationOfBenefit.careTeam.provider |
| claim | reference | ExplanationOfBenefit-claim |
The reference to the claim |
ExplanationOfBenefit.claim |
| coverage | reference | ExplanationOfBenefit-coverage |
The plan under which the claim was adjudicated |
ExplanationOfBenefit.insurance.coverage |
| created | date | ExplanationOfBenefit-created |
The creation date for the EOB |
ExplanationOfBenefit.created |
| disposition | 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 |
| 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 |
| provider | reference | ExplanationOfBenefit-provider |
The reference to the provider |
ExplanationOfBenefit.provider |
| status | token | ExplanationOfBenefit-status |
Status of the instance |
ExplanationOfBenefit.status |
| FamilyMemberHistory TU | ||||
| code | token | clinical-code |
A search by a condition code |
FamilyMemberHistory.condition.code |
| date | date | clinical-date |
When history was recorded or last updated |
FamilyMemberHistory.date |
| gender | token | FamilyMemberHistory-gender |
A search by a gender code of a family member |
FamilyMemberHistory.gender |
| identifier | token | clinical-identifier |
A search by a record identifier |
FamilyMemberHistory.identifier |
|
| reference | FamilyMemberHistory-instantiates-canonical | Instantiates FHIR protocol or definition | FamilyMemberHistory.instantiatesCanonical |
| instantiates-uri | uri |
|
Instantiates external protocol or definition |
|
| patient | reference | clinical-patient |
The identity of a subject to list family member history items for |
|
| relationship | token | FamilyMemberHistory-relationship |
A search by a relationship type |
FamilyMemberHistory.relationship |
| status | token | FamilyMemberHistory-status |
partial | completed | entered-in-error | health-unknown |
FamilyMemberHistory.status |
| Flag TU | ||||
| author | reference | Flag-author |
Flag creator |
Flag.author |
| date | 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 |
|
| subject | reference | Flag-subject |
The identity of a subject to list flags for |
Flag.subject |
| Goal TU | ||||
| category | token | Goal-category |
E.g. Treatment, dietary, behavioral, etc. |
Goal.category |
| identifier | token | clinical-identifier |
External Ids for this goal |
Goal.identifier |
| patient | reference | clinical-patient |
Who this goal is intended for |
|
| start-date | date | Goal-start-date |
When goal pursuit begins |
|
| status | token | Goal-status |
proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected |
Goal.status |
| subject | reference | Goal-subject |
Who this goal is intended for |
Goal.subject |
| target-date | date | Goal-target-date |
Reach goal on or before |
|
| 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 N | 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 | 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 | 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 | token | Group-exclude |
Group includes or excludes |
Group.characteristic.exclude |
| identifier | token | Group-identifier |
Unique id |
Group.identifier |
| member | reference | Group-member |
Reference to the group member |
Group.member.entity |
| type | token | Group-type |
The type of resources the group contains |
Group.type |
| value | token | Group-value |
Value held by characteristic |
Group.characteristic.value |
| 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 |
|
| request | token | GuidanceResponse-request |
The identifier of the request associated with the response |
|
| subject | reference | GuidanceResponse-subject |
The subject that the guidance response is about |
GuidanceResponse.subject |
| HealthcareService TU | ||||
| active | token | HealthcareService-active |
The Healthcare Service is currently marked as active |
HealthcareService.active |
| category | token | HealthcareService-category |
Service Category of the Healthcare Service |
HealthcareService.category |
| characteristic | token | HealthcareService-characteristic |
One of the HealthcareService's characteristics |
HealthcareService.characteristic |
| endpoint | reference | HealthcareService-endpoint |
Technical endpoints providing access to services operated for the location |
HealthcareService.endpoint |
| identifier | token | HealthcareService-identifier |
External identifiers for this item |
HealthcareService.identifier |
| location | reference | HealthcareService-location |
The location of the Healthcare Service |
HealthcareService.location |
| name | string | HealthcareService-name |
A portion of the Healthcare service name |
HealthcareService.name |
| organization | reference | HealthcareService-organization |
The organization that provides this Healthcare Service |
HealthcareService.providedBy |
| programname | string | HealthcareService-programname |
One of the Program Names serviced by this HealthcareService |
HealthcareService.programName |
| type | token | HealthcareService-type |
The type of service provided by this healthcare service |
HealthcareService.type |
| ImagingStudy TU | ||||
| accession | token | ImagingStudy-accession |
The accession identifier for the study |
ImagingStudy.identifier |
| basedon | reference | ImagingStudy-basedon |
The order for the image |
ImagingStudy.basedOn |
| bodysite | token | ImagingStudy-bodysite |
The body site studied |
ImagingStudy.series.bodySite |
| context | reference | ImagingStudy-context |
The context of the study |
ImagingStudy.context |
| dicom-class | token | ImagingStudy-dicom-class |
The type of the instance |
ImagingStudy.series.instance.sopClass |
| endpoint | reference | ImagingStudy-endpoint |
The endpoint for the study or series |
ImagingStudy.endpoint | ImagingStudy.series.endpoint |
| identifier | token | clinical-identifier |
Other identifiers for the Study |
ImagingStudy.identifier |
| inst-id | token | ImagingStudy-inst-id |
The instance unique identifier |
ImagingStudy.series.instance.identifier |
| modality | token | ImagingStudy-modality |
The modality of the series |
ImagingStudy.series.modality |
| patient | reference | clinical-patient |
Who the study is about |
|
| performer | reference | ImagingStudy-performer |
The person who performed the study |
ImagingStudy.series.performer.actor |
| reason | token | ImagingStudy-reason |
The reason for the study |
ImagingStudy.reasonCode |
| series | token | ImagingStudy-series |
The identifier of the series of images |
ImagingStudy.series.identifier |
| started | date | ImagingStudy-started |
When the study was started |
ImagingStudy.started |
| status | token | ImagingStudy-status |
The status of the study |
ImagingStudy.status |
| study | token | ImagingStudy-study |
The study identifier for the image |
ImagingStudy.identifier |
| subject | reference | ImagingStudy-subject |
Who the study is about |
ImagingStudy.subject |
| Immunization TU | ||||
| date | date | clinical-date |
Vaccination (non)-Administration Date |
|
| identifier | token | clinical-identifier |
Business identifier |
Immunization.identifier |
| location | reference | Immunization-location |
The service delivery location or facility in which the vaccine was / was to be administered |
Immunization.location |
| lot-number | string | Immunization-lot-number |
Vaccine Lot Number |
Immunization.lotNumber |
| manufacturer | reference | Immunization-manufacturer |
Vaccine Manufacturer |
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 |
| reason-code | token | Immunization-reason-code |
Reason why the vaccine was administered |
Immunization.reasonCode |
| reason-reference | reference | Immunization-reason-reference |
Why immunization occurred |
Immunization.reasonReference |
| series | string | Immunization-series | The series being followed by the provider | Immunization.protocolApplied.series |
| status | token | Immunization-status |
Immunization event status |
Immunization.status |
| status-reason | token | Immunization-status-reason |
Reason why the vaccine was not administered |
Immunization.statusReason |
| target-disease | token | Immunization-target-disease | The target disease the dose is being administered against | Immunization.protocolApplied.targetDisease |
| vaccine-code | token | Immunization-vaccine-code |
Vaccine Product Administered |
Immunization.vaccineCode |
| ImmunizationEvaluation TU | ||||
| date | date | 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 | token | ImmunizationEvaluation-status |
Immunization evaluation status |
ImmunizationEvaluation.status |
| target-disease | token | ImmunizationEvaluation-target-disease |
The vaccine preventable disease being evaluated against |
ImmunizationEvaluation.targetDisease |
| ImmunizationRecommendation TU | ||||
| date | date | ImmunizationRecommendation-date |
Date recommendation(s) created |
ImmunizationRecommendation.date |
| dose-number |
|
ImmunizationRecommendation-dose-number |
Recommended dose number within series |
ImmunizationRecommendation.recommendation.doseNumber |
| dose-sequence |
|
ImmunizationRecommendation-dose-sequence |
Recommended number of doses for immunity |
ImmunizationRecommendation.recommendation.seriesDoses |
| 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 | 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 | token | ImplementationGuide-experimental |
For testing purposes, not real usage |
ImplementationGuide.experimental |
| global | reference | ImplementationGuide-global | Profile that all resources must conform to | ImplementationGuide.global.profile |
| jurisdiction N | 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 |
| InsurancePlan TU | ||||
| address | string | InsurancePlan-address | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text | InsurancePlan.contact.address |
| address-city | string | InsurancePlan-address-city | A city specified in an address | InsurancePlan.contact.address.city |
| address-country | string | InsurancePlan-address-country | A country specified in an address | InsurancePlan.contact.address.country |
| address-postalcode | string | InsurancePlan-address-postalcode | A postal code specified in an address | InsurancePlan.contact.address.postalCode |
| address-state | string | InsurancePlan-address-state | A state specified in an address | InsurancePlan.contact.address.state |
| address-use | token | InsurancePlan-address-use | A use code specified in an address | InsurancePlan.contact.address.use |
| administered-by | reference | InsurancePlan-administered-by | Product administrator | InsurancePlan.administeredBy |
| endpoint | reference | InsurancePlan-endpoint | Technical endpoint | InsurancePlan.endpoint |
| identifier | token | InsurancePlan-identifier | Any identifier for the organization (not the accreditation issuer's identifier) | InsurancePlan.identifier |
| name | string | InsurancePlan-name | A portion of the organization's name or alias | name | alias |
| owned-by | reference | InsurancePlan-owned-by | An organization of which this organization forms a part | InsurancePlan.ownedBy |
| phonetic | string | InsurancePlan-phonetic | A portion of the organization's name using some kind of phonetic matching algorithm | InsurancePlan.name |
| status | token | InsurancePlan-status | Is the Organization record active | InsurancePlan.status |
| type | token | InsurancePlan-type | A code for the type of organization | InsurancePlan.type |
| Invoice TU | ||||
| account | reference | Invoice-account |
Account that is being balanced |
Invoice.account |
| date | 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 involevent in creation of this Invoice |
Invoice.participant.role |
| patient | reference | Invoice-patient |
Recipient(s) of goods and services |
|
| recipient | reference | Invoice-recipient |
Recipient of this invoice |
Invoice.recipient |
| status | token | Invoice-status |
draft | issued | balanced | cancelled | entered-in-error |
Invoice.status |
| subject | reference | Invoice-subject |
Recipient(s) of goods and services |
Invoice.subject |
| totalgross | quantity | Invoice-totalgross |
Gross
|
Invoice.totalGross |
| totalnet | quantity | Invoice-totalnet |
Net total of this Invoice |
Invoice.totalNet |
| type | token | Invoice-type |
Type of Invoice |
Invoice.type |
| ItemInstance TU | ||||
| subject | reference | ItemInstance-subject |
The identifier of the patient who has devices assigned to |
ItemInstance.subject |
| Library TU | ||||
| composed-of | reference | Library-composed-of |
What resource is being referenced |
Library.relatedArtifact.where(type='composed-of').resource |
| 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 | 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 | 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 | 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 | string | Library-publisher |
Name of the publisher of the library |
Library.publisher |
| status | 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 | 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 | uri | Library-url |
The uri that identifies the library |
Library.url |
| version | 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 | date | clinical-date |
When the list was prepared |
List.date |
| empty-reason | token | List-empty-reason |
Why list is empty |
List.emptyReason |
| encounter | reference | clinical-encounter |
Context in which list created |
List.encounter |
| identifier | token | clinical-identifier |
Business identifier |
List.identifier |
| item | reference | List-item |
Actual entry |
List.entry.item |
| notes | string | List-notes |
The annotation - text content (as markdown) |
List.note.text |
| patient | reference | clinical-patient |
If all resources have the same subject |
|
| source | reference | List-source |
Who and/or what defined the list contents (aka Author) |
List.source |
| status | token | List-status |
current | retired | entered-in-error |
List.status |
| subject | reference | List-subject |
If all resources have the same subject |
List.subject |
| title | string | List-title |
Descriptive name for the list |
List.title |
| Location TU | ||||
| address | string | Location-address |
A (part of the) address of the location |
Location.address |
| address-city | string | Location-address-city |
A city specified in an address |
Location.address.city |
| address-country | string | Location-address-country |
A country specified in an address |
Location.address.country |
| address-postalcode | string | Location-address-postalcode |
A postal code specified in an address |
Location.address.postalCode |
| address-state | string | Location-address-state |
A state specified in an address |
Location.address.state |
| address-use | token | Location-address-use |
A use code specified in an address |
Location.address.use |
| 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 |
|
Location-near |
Servers
may
search
using
Requires the near-distance parameter to be provided also |
Location.position |
|
|
token | Location-operational-status |
Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping) |
Location.operationalStatus |
| organization | reference | Location-organization |
Searches for locations that are managed by the provided organization |
Location.managingOrganization |
| partof | reference | Location-partof |
A location of which this location is a part |
Location.partOf |
| status | token | Location-status |
Searches for locations with a specific kind of status |
Location.status |
| type | token | Location-type |
A code for the type of location |
Location.type |
| 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 | 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 | 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 | 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 | string | Measure-publisher |
Name of the publisher of the measure |
Measure.publisher |
| status | 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 | string | Measure-title |
The human-friendly name of the measure |
Measure.title |
| topic | token | Measure-topic |
Topics associated with the measure |
Measure.topic |
| url | uri | Measure-url |
The uri that identifies the measure |
Measure.url |
| version | token | Measure-version |
The business version of the measure |
Measure.version |
| MeasureReport TU | ||||
| date | 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 | 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 |
|
| period | date | MeasureReport-period | The period of the measure report | MeasureReport.period |
| reporter | reference | MeasureReport-reporter | The reporter to return measure report results for | MeasureReport.reporter |
| status | token | MeasureReport-status |
The status of the measure report |
MeasureReport.status |
| subject | reference | MeasureReport-subject |
The identity of a subject to search for individual measure report results for |
MeasureReport.subject |
| Media TU | ||||
| based-on | reference | Media-based-on |
Procedure that caused this media to be created |
Media.basedOn |
| context | reference | Media-context |
Encounter / Episode associated with media |
Media.context |
| created | date | Media-created |
When Media was collected |
Media.created |
| device | reference | Media-device |
Observing Device |
Media.device |
| identifier | token | Media-identifier |
Identifier(s) for the image |
Media.identifier |
| modality | token | Media-modality |
The type of acquisition equipment/process |
Media.modality |
| operator | reference | Media-operator |
The person who generated the image |
Media.operator |
| patient | reference | Media-patient |
Who/What this Media is a record of |
|
| site | token | Media-site |
Observed body part |
Media.bodySite |
| status | token | Media-status |
preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error | unknown |
Media.status |
| subject | reference | Media-subject |
Who/What this Media is a record of |
Media.subject |
| type | token | Media-type |
Classification of media as image, video, or audio |
Media.type |
| view | token | Media-view |
Imaging view, e.g. Lateral or Antero-posterior |
Media.view |
| Medication TU | ||||
| code | token |
|
Codes that identify this medication |
Medication.code |
| expiration-date | date | Medication-expiration-date |
When batch will expire |
Medication.batch.expirationDate |
| form | token | Medication-form |
powder | tablets | capsule + |
Medication.form |
| ingredient | reference | Medication-ingredient |
The
|
|
| ingredient-code | token | Medication-ingredient-code |
The
|
|
| lot-number | token | Medication-lot-number |
Identifier assigned to batch |
Medication.batch.lotNumber |
| manufacturer | reference | Medication-manufacturer |
Manufacturer of the item |
Medication.manufacturer |
| serial-number | token | Medication-serial-number |
Identifier assigned to a drug at the time of manufacture |
Medication.batch.serialNumber |
| status | token | Medication-status |
active | inactive | entered-in-error |
Medication.status |
| MedicationAdministration TU | ||||
| code | token |
|
Return administrations of this medication code |
|
| context | reference | MedicationAdministration-context |
Return administrations that share this encounter or episode of care |
MedicationAdministration.context |
| device | reference | MedicationAdministration-device |
Return administrations with this administration device identity |
MedicationAdministration.device |
| effective-time | date | MedicationAdministration-effective-time |
Date administration happened (or did not happen) |
MedicationAdministration.effective |
| identifier | token |
|
Return administrations with this external identifier |
MedicationAdministration.identifier |
| medication | reference | medications-medication |
Return administrations of this medication resource |
|
| patient | reference |
|
The identity of a patient to list administrations for |
|
| performer | reference | MedicationAdministration-performer |
The identity of the individual who administered the medication |
MedicationAdministration.performer.actor |
| reason-given | token | MedicationAdministration-reason-given |
Reasons for administering the medication |
MedicationAdministration.reasonCode |
| reason-not-given | token | MedicationAdministration-reason-not-given |
Reasons for not administering the medication |
MedicationAdministration.statusReason |
| request | reference | MedicationAdministration-request |
The identity of a request to list administrations from |
MedicationAdministration.request |
| status | token | medications-status |
MedicationAdministration event status (for example one of active/paused/completed/nullified) |
MedicationAdministration.status |
| subject | reference | MedicationAdministration-subject |
The identity of the individual or group to list administrations for |
MedicationAdministration.subject |
| MedicationDispense TU | ||||
| code | token |
|
Returns dispenses of this medicine code |
|
| context | reference | MedicationDispense-context |
Returns dispenses with a specific context (episode or episode of care) |
MedicationDispense.context |
| destination | reference | MedicationDispense-destination |
Returns dispenses that should be sent to a specific destination |
MedicationDispense.destination |
| identifier | token |
|
Returns dispenses with this external identifier |
MedicationDispense.identifier |
| medication | reference | medications-medication |
Returns dispenses of this medicine resource |
|
| patient | reference |
|
The identity of a patient to list dispenses for |
|
| 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 | 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 | date | MedicationDispense-whenhandedover |
Returns dispenses handed over on this date |
MedicationDispense.whenHandedOver |
| whenprepared | date | MedicationDispense-whenprepared |
Returns dispenses prepared on this date |
MedicationDispense.whenPrepared |
| MedicationKnowledge TU | ||||
| classification | token | MedicationKnowledge-classification | Specific category assigned to the medication | MedicationKnowledge.medicineClassification.classification |
| classification-type | token | MedicationKnowledge-classification-type | The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification) | MedicationKnowledge.medicineClassification.type |
| code | token | MedicationKnowledge-code | Code that identifies this medication | MedicationKnowledge.code |
| doseform | token | MedicationKnowledge-doseform | powder | tablets | capsule + | MedicationKnowledge.doseForm |
| ingredient | reference | MedicationKnowledge-ingredient | Medication(s) or substance(s) contained in the medication | (MedicationKnowledge.ingredient.item as Reference) |
| ingredient-code | token | MedicationKnowledge-ingredient-code | Medication(s) or substance(s) contained in the medication | (MedicationKnowledge.ingredient.item as CodeableConcept) |
| manufacturer | reference | MedicationKnowledge-manufacturer | Manufacturer of the item | MedicationKnowledge.manufacturer |
| monitoring-program-name | token | MedicationKnowledge-monitoring-program-name | Name of the reviewing program | MedicationKnowledge.monitoringProgram.name |
| monitoring-program-type | token | MedicationKnowledge-monitoring-program-type | Type of program under which the medication is monitored | MedicationKnowledge.monitoringProgram.type |
| monograph | reference | MedicationKnowledge-monograph | Associated documentation about the medication | MedicationKnowledge.monograph.source |
| monograph-type | token | MedicationKnowledge-monograph-type | The category of medication document | MedicationKnowledge.monograph.type |
| source-cost | token | MedicationKnowledge-source-cost | The source or owner for the price information | MedicationKnowledge.cost.source |
| status | token | MedicationKnowledge-status | active | inactive | entered-in-error | MedicationKnowledge.status |
| MedicationRequest TU | ||||
| authoredon | date | MedicationRequest-authoredon |
Return prescriptions written on this date |
MedicationRequest.authoredOn |
| category | token | MedicationRequest-category |
Returns prescriptions with different categories |
MedicationRequest.category |
| code | token |
|
Return prescriptions of this medication code |
|
| context | reference | MedicationRequest-context |
Return prescriptions with this encounter or episode of care identifier |
MedicationRequest.context |
| date | date | medications-date |
Multiple Resources:
|
MedicationRequest.dosageInstruction.timing.event |
| identifier | token |
|
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.performer |
| intended-performer | reference | MedicationRequest-intended-performer |
Returns the intended performer of the administration of the medication request |
MedicationRequest.performer |
| intended-performertype | token | MedicationRequest-intended-performertype |
Returns requests for a specific type of performer |
MedicationRequest.performerType |
| intent | token | MedicationRequest-intent |
Returns prescriptions with different intents |
MedicationRequest.intent |
| medication | reference | medications-medication |
Return prescriptions for this medication reference |
|
| patient | reference |
|
Returns prescriptions for a specific patient |
|
| priority | token | MedicationRequest-priority |
Returns prescriptions with different priorities |
MedicationRequest.priority |
| requester | reference | MedicationRequest-requester |
Returns prescriptions prescribed by this prescriber |
MedicationRequest.requester |
| status | token | medications-status |
Status of the prescription |
MedicationRequest.status |
| subject | reference | MedicationRequest-subject |
The identity of a patient to list orders for |
MedicationRequest.subject |
| MedicationStatement TU | ||||
| category | token | MedicationStatement-category |
Returns statements of this category of medicationstatement |
MedicationStatement.category |
| code | token |
|
Return statements of this medication code |
|
| context | reference | MedicationStatement-context |
Returns statements for a specific context (episode or episode of Care). |
MedicationStatement.context |
| effective | date | MedicationStatement-effective |
Date when patient was taking (or not taking) the medication |
MedicationStatement.effective |
| identifier | token |
|
Return statements with this external identifier |
MedicationStatement.identifier |
| medication | reference | medications-medication |
Return statements of this medication reference |
|
| part-of | reference | MedicationStatement-part-of |
Returns statements that are part of another event. |
MedicationStatement.partOf |
| patient | reference |
|
Returns statements for a specific patient. |
|
| source | reference | MedicationStatement-source |
Who or where the information in the statement came from |
MedicationStatement.informationSource |
| status | token | medications-status |
Return statements that match the given status |
MedicationStatement.status |
| subject | reference | MedicationStatement-subject |
The identity of a patient, animal or group to list statements for |
MedicationStatement.subject |
| MedicinalProductAuthorization TU | ||||
| subject | reference | MedicinalProductAuthorization-subject | The item that is being authorized | MedicinalProductAuthorization.subject |
| MedicinalProductContraindication TU | ||||
| subject | reference | MedicinalProductContraindication-subject | The medication for which this is an contraindication | MedicinalProductContraindication.subject |
| MedicinalProductIndication TU | ||||
| subject | reference | MedicinalProductIndication-subject | The medication for which this is an indication | MedicinalProductIndication.subject |
| MedicinalProductInteraction TU | ||||
| subject | reference | MedicinalProductInteraction-subject | The medication for which this is an interaction | MedicinalProductInteraction.subject |
| MedicinalProductUndesirableEffect TU | ||||
| subject | reference | MedicinalProductUndesirableEffect-subject | The medication for which this is an undesirable effect | MedicinalProductUndesirableEffect.subject |
| MessageDefinition TU | ||||
| category | 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 | token | MessageDefinition-focus |
A resource that is a permitted focus of the message |
MessageDefinition.focus.code |
| identifier N | token | conformance-identifier |
External identifier for the message definition |
MessageDefinition.identifier |
| jurisdiction N | 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 | token | MessageDefinition-parent | A resource that is the parent of the definition | |
| 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 | token | MessageHeader-code |
ok | transient-error | fatal-error |
MessageHeader.response.code |
| destination | string | MessageHeader-destination |
Name of system |
MessageHeader.destination.name |
| destination-uri | 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 | token | MessageHeader-response-id |
Id of original message |
MessageHeader.response.identifier |
| responsible | reference | MessageHeader-responsible |
Final responsibility for event |
MessageHeader.responsible |
| sender | reference | MessageHeader-sender |
Real world sender of the message |
MessageHeader.sender |
| source | string | MessageHeader-source |
Name of system |
MessageHeader.source.name |
| source-uri | 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 |
| NamingSystem TU | ||||
| contact | 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 | token | NamingSystem-id-type |
oid | uuid | uri | other |
NamingSystem.uniqueId.type |
| jurisdiction N | token | conformance-jurisdiction |
Intended jurisdiction for the naming system |
NamingSystem.jurisdiction |
| kind | 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 | 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 |
| value | string | NamingSystem-value |
The unique identifier |
NamingSystem.uniqueId.value |
| NutritionOrder TU | ||||
| additive | token | NutritionOrder-additive |
Type of module component to add to the feeding |
NutritionOrder.enteralFormula.additiveType |
| context | reference | NutritionOrder-context |
Return nutrition orders with this encounter identifier |
NutritionOrder.context |
| datetime | date | NutritionOrder-datetime |
Return nutrition orders requested on this date |
NutritionOrder.dateTime |
| 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 | reference | NutritionOrder-instantiates-canonical | Instantiates FHIR protocol or definition | NutritionOrder.instantiatesCanonical |
| instantiates-uri | 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 | token | NutritionOrder-status |
Status of the nutrition order. |
NutritionOrder.status |
| supplement | token | NutritionOrder-supplement |
Type of supplement product requested |
NutritionOrder.supplement.type |
| Observation N | ||||
| based-on | reference | Observation-based-on |
Reference to the service request. |
Observation.basedOn |
| category | token | Observation-category |
The classification of the type of observation |
Observation.category |
| code TU | token | clinical-code |
The code of the observation type |
Observation.code |
| code-value-concept | composite | Observation-code-value-concept |
Code and coded value parameter pair |
Observation |
| code-value-date | composite | Observation-code-value-date |
Code and date/time value parameter pair |
Observation |
| code-value-quantity | composite | Observation-code-value-quantity |
Code and quantity value parameter pair |
Observation |
| code-value-string | composite | Observation-code-value-string |
Code and string value parameter pair |
Observation |
| combo-code | token | Observation-combo-code |
The code of the observation type or component type |
Observation.code | Observation.component.code |
| combo-code-value-concept | composite | Observation-combo-code-value-concept |
Code and coded value parameter pair, including in components |
Observation | Observation.component |
| combo-code-value-quantity | composite | Observation-combo-code-value-quantity |
Code and quantity value parameter pair, including in components |
Observation | Observation.component |
| combo-data-absent-reason | token | Observation-combo-data-absent-reason |
The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing. |
Observation.dataAbsentReason | Observation.component.dataAbsentReason |
| combo-value-concept | token | Observation-combo-value-concept |
The value or component value of the observation, if the value is a CodeableConcept |
|
| combo-value-quantity | quantity | Observation-combo-value-quantity |
The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
|
| component-code | token | Observation-component-code |
The component code of the observation type |
Observation.component.code |
| component-code-value-concept | composite | Observation-component-code-value-concept |
Component code and component coded value parameter pair |
Observation.component |
| component-code-value-quantity | composite | Observation-component-code-value-quantity |
Component code and component quantity value parameter pair |
Observation.component |
| component-data-absent-reason | token | Observation-component-data-absent-reason |
The reason why the expected value in the element Observation.component.value[x] is missing. |
Observation.component.dataAbsentReason |
| component-value-concept | token | Observation-component-value-concept |
The value of the component observation, if the value is a CodeableConcept |
|
| component-value-quantity | quantity | Observation-component-value-quantity |
The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
|
| data-absent-reason | token | Observation-data-absent-reason |
The reason why the expected value in the element Observation.value[x] is missing. |
Observation.dataAbsentReason |
| date TU | date | clinical-date |
Obtained date/time. If the obtained element is a period, a date that falls in the period |
Observation.effective |
| derived-from | reference | Observation-derived-from |
Related measurements the observation is made from |
Observation.derivedFrom |
| device | reference | Observation-device |
The Device that generated the observation data. |
Observation.device |
| encounter TU | reference | clinical-encounter |
Encounter related to the observation |
|
| focus TU | reference | Observation-focus |
The focus of an observation when the focus is not the patient of record. |
Observation.focus |
| has-member | reference | Observation-has-member |
Related resource that belongs to the Observation group |
Observation.hasMember |
| identifier TU | token | clinical-identifier |
The unique id for a particular observation |
Observation.identifier |
| method | token | Observation-method |
The method used for the observation |
Observation.method |
| part-of | reference | Observation-part-of |
Part of referenced event |
Observation.partOf |
| patient TU | reference | clinical-patient |
The subject that the observation is about (if patient) |
|
| performer | reference | Observation-performer |
Who performed the observation |
Observation.performer |
| specimen | reference | Observation-specimen |
Specimen used for this observation |
Observation.specimen |
| status | token | Observation-status |
The status of the observation |
Observation.status |
| subject | reference | Observation-subject |
The subject that the observation is about |
Observation.subject |
| value-concept | token | Observation-value-concept |
The value of the observation, if the value is a CodeableConcept |
|
| value-date | date | Observation-value-date |
The value of the observation, if the value is a date or period of time |
|
| value-quantity | quantity | Observation-value-quantity |
The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
|
| value-string | string | Observation-value-string |
The value of the observation, if the value is a string, and also searches in CodeableConcept.text |
|
|
|
||||
|
|
|
|
|
|
|
|
token |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
context-type
TU
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
A
|
|
| 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 | 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 | 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 | string | Organization-address-city |
A city specified in an address |
Organization.address.city |
| address-country | string | Organization-address-country |
A country specified in an address |
Organization.address.country |
| address-postalcode | string | Organization-address-postalcode |
A postal code specified in an address |
Organization.address.postalCode |
| address-state | string | Organization-address-state |
A state specified in an address |
Organization.address.state |
| address-use | 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 | 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 |
|
|
||||
| active | token |
|
Whether
this
|
|
| date | date |
|
The
period
during
which
the
|
|
| token |
|
A value in an email contact |
|
|
| endpoint | reference |
|
Technical
endpoints
providing
access
to
services
operated
for
|
|
| identifier | token |
|
|
|
| location | reference |
|
|
|
| network | reference |
|
|
|
| participating-organization | reference |
|
|
|
| phone | token |
|
A value in a phone contact |
|
| primary-organization | reference |
|
The
|
|
| role | token |
|
|
|
| service | reference |
|
|
|
| specialty | token |
|
|
|
| telecom | token |
|
The value in any kind of contact |
|
| Patient N | ||||
| active | token | Patient-active |
Whether the patient record is active |
Patient.active |
| address | string | individual-address |
A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
Patient.address |
| address-city | string | individual-address-city |
A city specified in an address |
Patient.address.city |
| address-country | string | individual-address-country |
A country specified in an address |
Patient.address.country |
| address-postalcode | string | individual-address-postalcode |
A postalCode specified in an address |
Patient.address.postalCode |
| address-state | string | individual-address-state |
A state specified in an address |
Patient.address.state |
| address-use | token | individual-address-use |
A use code specified in an address |
Patient.address.use |
| birthdate | date | individual-birthdate |
The patient's date of birth |
Patient.birthDate |
| death-date | date | Patient-death-date |
The date of death has been provided and satisfies this search value |
|
| deceased | token | Patient-deceased |
This patient has been marked as deceased, or as a death date entered |
Patient.deceased.exists() and Patient.deceased != false |
| token | individual-email |
A value in an email contact |
Patient.telecom.where(system='email') | |
| family | string | individual-family |
A portion of the family name of the patient |
Patient.name.family |
| gender | token | individual-gender |
Gender of the patient |
Patient.gender |
| general-practitioner | reference | Patient-general-practitioner |
Patient's nominated general practitioner, not the organization that manages the record |
Patient.generalPractitioner |
| given | string | individual-given |
A portion of the given name of the patient |
Patient.name.given |
| identifier | token | Patient-identifier |
A patient identifier |
Patient.identifier |
| language | token | Patient-language |
Language code (irrespective of use value) |
Patient.communication.language |
| link | reference | Patient-link |
All patients linked to the given patient |
Patient.link.other |
| name | 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 | reference | Patient-organization |
The
organization
|
Patient.managingOrganization |
| phone | token | individual-phone |
A value in a phone contact |
Patient.telecom.where(system='phone') |
| phonetic | string | individual-phonetic |
A portion of either family or given name using some kind of phonetic matching algorithm |
Patient.name |
| telecom | token | individual-telecom |
The value in any kind of telecom details of the patient |
Patient.telecom |
| PaymentNotice TU | ||||
| created | date | PaymentNotice-created |
Creation date 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 | token | PaymentNotice-status |
The status of the payment notice |
PaymentNotice.status |
| statusdate | date | PaymentNotice-statusdate |
The date of the payment action |
PaymentNotice.statusDate |
| PaymentReconciliation TU | ||||
| created | date | PaymentReconciliation-created |
The creation date |
PaymentReconciliation.created |
| disposition | string | PaymentReconciliation-disposition |
The contents of the disposition message |
PaymentReconciliation.disposition |
| identifier | token | PaymentReconciliation-identifier |
The
business
identifier
of
the
|
PaymentReconciliation.identifier |
| organization | reference | PaymentReconciliation-organization |
The
organization
|
PaymentReconciliation.organization |
| outcome | token | PaymentReconciliation-outcome |
The processing outcome |
PaymentReconciliation.outcome |
| request | reference | PaymentReconciliation-request |
The reference to the claim |
PaymentReconciliation.request |
| request-provider | reference | PaymentReconciliation-request-provider |
The
reference
to
the
provider
who
|
PaymentReconciliation.requestProvider |
| status | token | PaymentReconciliation-status |
The status of the payment reconciliation |
PaymentReconciliation.status |
| Person TU | ||||
| address N | string | individual-address |
A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
Person.address |
| address-city N | string | individual-address-city |
A city specified in an address |
Person.address.city |
| address-country N | string | individual-address-country |
A country specified in an address |
Person.address.country |
| address-postalcode N | string | individual-address-postalcode |
A postal code specified in an address |
Person.address.postalCode |
| address-state N | string | individual-address-state |
A state specified in an address |
Person.address.state |
| address-use N | token | individual-address-use |
A use code specified in an address |
Person.address.use |
| birthdate N | date | individual-birthdate |
The person's date of birth |
Person.birthDate |
| email N | 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 |
|
| phone N | token | individual-phone |
A value in a phone contact |
Person.telecom.where(system='phone') |
| phonetic N | string | individual-phonetic |
A portion of name using some kind of phonetic matching algorithm |
Person.name |
| practitioner | reference | Person-practitioner |
The Person links to this Practitioner |
|
| relatedperson | reference | Person-relatedperson |
The Person links to this RelatedPerson |
|
| telecom N | 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 | 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 | 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 | 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 | string | PlanDefinition-publisher |
Name of the publisher of the plan definition |
PlanDefinition.publisher |
| status | 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 | 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 | uri | PlanDefinition-url |
The uri that identifies the plan definition |
PlanDefinition.url |
| version | token | PlanDefinition-version |
The business version of the plan definition |
PlanDefinition.version |
| Practitioner TU | ||||
| active | token | Practitioner-active |
Whether the practitioner record is active |
Practitioner.active |
| address N | string | individual-address |
A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
Practitioner.address |
| address-city N | string | individual-address-city |
A city specified in an address |
Practitioner.address.city |
| address-country N | string | individual-address-country |
A country specified in an address |
Practitioner.address.country |
| address-postalcode N | string | individual-address-postalcode |
A postalCode specified in an address |
Practitioner.address.postalCode |
| address-state N | string | individual-address-state |
A state specified in an address |
Practitioner.address.state |
| address-use N | token | individual-address-use |
A use code specified in an address |
Practitioner.address.use |
| communication | token | Practitioner-communication |
One of the languages that the practitioner can communicate with |
Practitioner.communication |
| email N | token | individual-email |
A value in an email contact |
Practitioner.telecom.where(system='email') |
| family N | string | individual-family |
A portion of the family name |
Practitioner.name.family |
| gender N | token | individual-gender |
Gender of the practitioner |
Practitioner.gender |
| given N | string | individual-given |
A portion of the given name |
Practitioner.name.given |
| identifier | token | Practitioner-identifier |
A practitioner's Identifier |
Practitioner.identifier |
| name | string | Practitioner-name |
A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
Practitioner.name |
| phone N | token | individual-phone |
A value in a phone contact |
Practitioner.telecom.where(system='phone') |
| phonetic N | string | individual-phonetic |
A portion of either family or given name using some kind of phonetic matching algorithm |
Practitioner.name |
| telecom N | token | individual-telecom |
The value in any kind of contact |
Practitioner.telecom |
| PractitionerRole TU | ||||
| active | token | PractitionerRole-active |
Whether this practitioner role record is in active use |
PractitionerRole.active |
| date | date | PractitionerRole-date |
The period during which the practitioner is authorized to perform in these role(s) |
PractitionerRole.period |
| email N | token | individual-email |
A value in an email contact |
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 N | 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 N | 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 |
| context | reference | Procedure-context |
Encounter or episode associated with the procedure |
Procedure.context |
| date | date | clinical-date |
When the procedure was performed |
Procedure.performed |
| encounter | reference | clinical-encounter |
Search by encounter |
|
| identifier | token | clinical-identifier |
A unique identifier for a procedure |
Procedure.identifier |
|
| reference | Procedure-instantiates-canonical | Instantiates FHIR protocol or definition | Procedure.instantiatesCanonical |
| instantiates-uri | uri |
|
Instantiates external protocol or definition |
|
| 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 |
|
| performer | reference | Procedure-performer |
The reference to the practitioner |
Procedure.performer.actor |
| reason-code | token | Procedure-reason-code | Coded reason procedure performed | Procedure.reasonCode |
| reason-reference | reference | Procedure-reason-reference | The justification that the procedure was performed | Procedure.reasonReference |
| status | token | Procedure-status |
preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error | unknown |
Procedure.status |
| subject | reference | Procedure-subject |
Search by subject |
Procedure.subject |
| ProcessRequest TU | ||||
| action | token | ProcessRequest-action |
The action requested by this resource |
ProcessRequest.action |
| identifier | token | ProcessRequest-identifier |
The business identifier of the ProcessRequest |
ProcessRequest.identifier |
| provider | reference | ProcessRequest-provider |
The provider who regenerated this request |
ProcessRequest.provider |
| status | token | ProcessRequest-status |
The status of the process request |
ProcessRequest.status |
| ProcessResponse TU | ||||
| identifier | token | ProcessResponse-identifier |
The business identifier of the Explanation of Benefit |
ProcessResponse.identifier |
| organization | reference | ProcessResponse-organization |
The organization who generated this resource |
ProcessResponse.organization |
| request | reference | ProcessResponse-request |
The reference to the claim |
ProcessResponse.request |
| request-provider | reference | ProcessResponse-request-provider |
The Provider who is responsible the request transaction |
ProcessResponse.requestProvider |
| status | token | ProcessResponse-status |
The status of the process response |
ProcessResponse.status |
|
|
||||
| agent | reference | Provenance-agent |
Who participated |
|
| 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 |
|
|
reference |
|
Identity of entity |
|
| location | reference | Provenance-location |
Where the activity occurred, if relevant |
Provenance.location |
| patient | reference | Provenance-patient |
Target Reference(s) (usually version specific) |
|
| recorded | date | Provenance-recorded |
When the activity was recorded / updated |
Provenance.recorded |
| signature-type | token | Provenance-signature-type |
Indication of the reason the entity signed the object(s) |
Provenance.signature.type |
| target | reference | Provenance-target |
Target Reference(s) (usually version specific) |
Provenance.target |
| when | date | Provenance-when |
When the activity occurred |
|
| Questionnaire TU | ||||
| 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 | date | Questionnaire-date |
The questionnaire publication date |
Questionnaire.date |
| definition | uri | Questionnaire-definition |
ElementDefinition - details for the item |
Questionnaire.item.definition |
| description | 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 | string | Questionnaire-name |
Computationally friendly name of the questionnaire |
Questionnaire.name |
| publisher | string | Questionnaire-publisher |
Name of the publisher of the questionnaire |
Questionnaire.publisher |
| status | token | Questionnaire-status |
The current status of the questionnaire |
Questionnaire.status |
| subject-type | token | Questionnaire-subject-type |
Resource that can be subject of QuestionnaireResponse |
Questionnaire.subjectType |
| title | string | Questionnaire-title |
The human-friendly name of the questionnaire |
Questionnaire.title |
| url | uri | Questionnaire-url |
The uri that identifies the questionnaire |
Questionnaire.url |
| version | 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 | 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 |
| context | reference | QuestionnaireResponse-context |
Encounter or episode associated with the questionnaire response |
QuestionnaireResponse.context |
| 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 |
|
| questionnaire | reference | QuestionnaireResponse-questionnaire |
The questionnaire the answers are provided for |
QuestionnaireResponse.questionnaire |
| source | reference | QuestionnaireResponse-source |
The individual providing the information reflected in the questionnaire respose |
QuestionnaireResponse.source |
| status | token | QuestionnaireResponse-status |
The status of the questionnaire response |
QuestionnaireResponse.status |
| subject | reference | QuestionnaireResponse-subject |
The subject of the questionnaire response |
QuestionnaireResponse.subject |
| RelatedPerson TU | ||||
| active | token | RelatedPerson-active |
Indicates if the related person record is active |
RelatedPerson.active |
| address N | string | individual-address |
A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
RelatedPerson.address |
| address-city N | string | individual-address-city |
A city specified in an address |
RelatedPerson.address.city |
| address-country N | string | individual-address-country |
A country specified in an address |
RelatedPerson.address.country |
| address-postalcode N | string | individual-address-postalcode |
A postal code specified in an address |
RelatedPerson.address.postalCode |
| address-state N | string | individual-address-state |
A state specified in an address |
RelatedPerson.address.state |
| address-use N | token | individual-address-use |
A use code specified in an address |
RelatedPerson.address.use |
| birthdate N | date | individual-birthdate |
The Related Person's date of birth |
RelatedPerson.birthDate |
| email N | token | individual-email |
A value in an email contact |
RelatedPerson.telecom.where(system='email') |
| 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 N | token | individual-phone |
A value in a phone contact |
RelatedPerson.telecom.where(system='phone') |
| phonetic N | string | individual-phonetic |
A portion of name using some kind of phonetic matching algorithm |
RelatedPerson.name |
| relationship | token | RelatedPerson-relationship | The relationship between the patient and the relatedperson | RelatedPerson.relationship |
| telecom N | token | individual-telecom |
The value in any kind of contact |
RelatedPerson.telecom |
| RequestGroup TU | ||||
| author | reference | RequestGroup-author |
The author of the request group |
RequestGroup.author |
| authored | date | RequestGroup-authored |
The date the request group was authored |
RequestGroup.authoredOn |
| code | token | RequestGroup-code |
The code of the request group |
RequestGroup.code |
| context | reference | RequestGroup-context |
The context the request group applies to |
RequestGroup.context |
| encounter | reference | RequestGroup-encounter |
The encounter the request group applies to |
|
| 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 | reference | RequestGroup-instantiates-canonical |
The FHIR-based definition from which the request group is realized |
RequestGroup.instantiatesCanonical |
| instantiates-uri | uri | RequestGroup-instantiates-uri |
The external definition from which the request group is realized |
RequestGroup.instantiatesUri |
| intent | 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 |
|
| priority | token | RequestGroup-priority |
The priority of the request group |
RequestGroup.priority |
| status | 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 | 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 | 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 |
| status | 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 | date | clinical-date |
When was assessment made? |
|
| encounter | reference | clinical-encounter |
Where was assessment performed? |
|
| 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? |
|
| 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 | 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 |
| type | token | Schedule-type |
The type of appointments that can be booked into associated slot(s) |
Schedule.serviceType |
| SearchParameter TU | ||||
| base | token | SearchParameter-base |
The resource type(s) this search parameter applies to |
SearchParameter.base |
| code | token | SearchParameter-code |
Code used in URL |
SearchParameter.code |
| component | reference | SearchParameter-component |
Defines how the part works |
SearchParameter.component.definition |
| context | token | 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 | 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 N | 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 | token | SearchParameter-target |
Types of resource (if a resource reference) |
SearchParameter.target |
| type | token | SearchParameter-type |
number | date | string | token | reference | composite | quantity | uri | special |
SearchParameter.type |
| url 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 |
| Sequence TU | ||||
| chromosome | token | Sequence-chromosome |
Chromosome number of the reference sequence |
Sequence.referenceSeq.chromosome |
| coordinate | composite | Sequence-coordinate |
Search
parameter
for
region
of
the
reference
DNA
sequence
string.
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
|
Sequence.variant |
| end | number | Sequence-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. |
Sequence.referenceSeq.windowEnd |
| identifier | token | Sequence-identifier |
The unique identity for a particular sequence |
Sequence.identifier |
| patient | reference | Sequence-patient |
The subject that the observation is about |
Sequence.patient |
| start | number | Sequence-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. |
Sequence.referenceSeq.windowStart |
| type | token | Sequence-type |
Amino Acid Sequence/ DNA Sequence / RNA Sequence |
Sequence.type |
| ServiceRequest TU | ||||
| authored | date | ServiceRequest-authored |
Date request signed |
ServiceRequest.authoredOn |
| based-on | reference | ServiceRequest-based-on |
What request fulfills |
ServiceRequest.basedOn |
| body-site | token | ServiceRequest-body-site |
Where procedure is going to be done |
ServiceRequest.bodySite |
| category | token | ServiceRequest-category |
Classification of service |
ServiceRequest.category |
| code | token | clinical-code |
What is being requested/ordered |
ServiceRequest.code |
| context | reference | ServiceRequest-context |
Encounter or Episode during which request was created |
ServiceRequest.context |
| encounter | reference | clinical-encounter |
An encounter in which this request is made |
|
| identifier | token | clinical-identifier |
Identifiers assigned to this order |
ServiceRequest.identifier |
|
| reference | ServiceRequest-instantiates-canonical | Instantiates FHIR protocol or definition | ServiceRequest.instantiatesCanonical |
| instantiates-uri | uri |
|
|
|
| intent | token | ServiceRequest-intent |
proposal | plan | order + |
ServiceRequest.intent |
| occurrence | date | ServiceRequest-occurrence |
When service should occur |
ServiceRequest.occurrence |
| patient | reference | clinical-patient |
Search by subject - a patient |
|
| performer | reference | ServiceRequest-performer |
Requested performer |
ServiceRequest.performer |
| performer-type | token | ServiceRequest-performer-type |
Performer role |
ServiceRequest.performerType |
| priority | token | ServiceRequest-priority |
routine | urgent | asap | stat |
ServiceRequest.priority |
| replaces | reference | ServiceRequest-replaces |
What request replaces |
ServiceRequest.replaces |
| requester | reference | ServiceRequest-requester |
Who/what is requesting service |
ServiceRequest.requester |
| requisition | token | ServiceRequest-requisition |
Composite Request ID |
ServiceRequest.requisition |
| specimen | reference | ServiceRequest-specimen |
Specimen to be tested |
ServiceRequest.specimen |
| status | token | ServiceRequest-status |
draft | active | suspended | completed | entered-in-error | cancelled |
ServiceRequest.status |
| subject | reference | ServiceRequest-subject |
Search by subject |
ServiceRequest.subject |
| Slot TU | ||||
| 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 |
| slot-type | token | Slot-slot-type |
The type of appointments that can be booked into the slot |
Slot.serviceType |
| start | date | Slot-start |
Appointment date/time. |
Slot.start |
| status | token | Slot-status |
The free/busy status of the appointment |
Slot.status |
| Specimen TU | ||||
| accession | token | Specimen-accession |
The accession number associated with the specimen |
Specimen.accessionIdentifier |
| bodysite | 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 |
|
| status | token | Specimen-status |
available | unavailable | unsatisfactory | entered-in-error |
Specimen.status |
| subject | reference | Specimen-subject |
The subject of the specimen |
Specimen.subject |
| type | token | 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.specimenToLab.containerType |
| identifier | token | SpecimenDefinition-identifier |
The unique identifier associated with the specimen |
SpecimenDefinition.identifier |
| type | token | SpecimenDefinition-type |
The type of collected specimen |
SpecimenDefinition.typeCollected |
| 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 | 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 | token | conformance-identifier |
External identifier for the structure definition |
StructureDefinition.identifier |
| jurisdiction | token | conformance-jurisdiction |
Intended jurisdiction for the structure definition |
StructureDefinition.jurisdiction |
| keyword | token | StructureDefinition-keyword |
A
code
for
the
|
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.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 N | token | conformance-identifier |
External identifier for the structure map |
StructureMap.identifier |
| jurisdiction N | 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 | ||||
| add-tag | token | Subscription-add-tag |
A tag to be added to the resource matching the criteria |
Subscription.tag |
| contact | token | Subscription-contact |
Contact details for the subscription |
Subscription.contact |
| criteria | string | Subscription-criteria |
The search rules used to determine when to send a notification |
Subscription.criteria |
| payload | string | Subscription-payload |
The mime-type of the notification payload |
Subscription.channel.payload |
| status | token | Subscription-status |
The current state of the subscription |
Subscription.status |
| type | token | Subscription-type |
The type of channel for the sent notifications |
Subscription.channel.type |
| url | uri | Subscription-url |
The uri that will receive the notifications |
Subscription.channel.endpoint |
| 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
|
|
| container-identifier | token | Substance-container-identifier |
Identifier of the package/container |
Substance.instance.identifier |
| expiry | 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 | token | Substance-status |
active | inactive | entered-in-error |
Substance.status |
| substance-reference | reference | Substance-substance-reference |
A component of the substance |
|
| SupplyDelivery TU | ||||
| identifier | token | clinical-identifier |
External identifier |
SupplyDelivery.identifier |
| patient | reference | clinical-patient |
Patient for whom the item is supplied |
SupplyDelivery.patient |
| receiver | reference | SupplyDelivery-receiver |
Who collected the Supply |
SupplyDelivery.receiver |
| status | token | SupplyDelivery-status |
in-progress | completed | abandoned | entered-in-error |
SupplyDelivery.status |
| supplier | reference | SupplyDelivery-supplier |
Dispenser |
SupplyDelivery.supplier |
| SupplyRequest TU | ||||
| category | token | SupplyRequest-category |
The kind of supply (central, non-stock, etc.) |
SupplyRequest.category |
| date | date | clinical-date |
When the request was made |
SupplyRequest.authoredOn |
| identifier | token | clinical-identifier |
Unique identifier |
SupplyRequest.identifier |
| requester | reference | SupplyRequest-requester |
Individual making the request |
SupplyRequest.requester |
| status | token | SupplyRequest-status |
draft | active | suspended + |
SupplyRequest.status |
| supplier | reference | SupplyRequest-supplier |
Who is intended to fulfill the request |
SupplyRequest.supplier |
| Task TU | ||||
| authored-on | date | Task-authored-on |
Search by creation date |
Task.authoredOn |
| based-on | reference | Task-based-on |
Search by requests this task is based on |
Task.basedOn |
| business-status | token | Task-business-status |
Search by business status |
Task.businessStatus |
| code | token | Task-code |
Search by task code |
Task.code |
| context | reference | Task-context |
Search by encounter or episode |
Task.context |
| 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 | token | Task-intent |
Search by task intent |
Task.intent |
| modified | 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 |
|
| 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 | token | Task-priority |
Search by task priority |
Task.priority |
| requester | reference | Task-requester |
Search by task requester |
Task.requester |
| status | token | Task-status |
Search by task status |
Task.status |
| subject | reference | Task-subject |
Search by subject |
Task.for |
| TerminologyCapabilities TU | ||||
| context | token | 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 |
| jurisdiction N | 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 | date | TestReport-issued |
The test report generation date |
TestReport.issued |
| participant | uri | TestReport-participant |
The reference to a participant in the test execution |
TestReport.participant.uri |
| result | token | TestReport-result |
The result disposition of the test execution |
TestReport.result |
| tester | string | TestReport-tester |
The name of the testing organization |
TestReport.tester |
| testscript | reference | TestReport-testscript |
The test script executed to produce this report |
TestReport.testScript |
| TestScript TU | ||||
| context | token | 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 | date | TestScript-date |
The test script publication date |
TestScript.date |
| description | 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 | string | TestScript-name |
Computationally friendly name of the test script |
TestScript.name |
| publisher | string | TestScript-publisher |
Name of the publisher of the test script |
TestScript.publisher |
| status | token | TestScript-status |
The current status of the test script |
TestScript.status |
| testscript-capability | string | TestScript-testscript-capability |
TestScript required and validated capability |
TestScript.metadata.capability.description |
| title | string | TestScript-title |
The human-friendly name of the test script |
TestScript.title |
| url | uri | TestScript-url |
The uri that identifies the test script |
TestScript.url |
| version | token | TestScript-version |
The business version of the test script |
TestScript.version |
| UserSession TU | ||||
| focus | reference | UserSession-focus |
The focus of the user session |
UserSession.focus |
| identifier | token | UserSession-identifier |
External identifiers for the user session |
UserSession.identifier |
| patient | reference | UserSession-patient |
The identity of a patient to search for user sessions |
|
| status | token | UserSession-status |
The status of the user session |
UserSession.status.code |
| user | reference | UserSession-user |
The user of the session |
UserSession.user |
| workstation | token | UserSession-workstation |
The workstation of the session |
UserSession.workstation |
| 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 |
|
ValueSet.expansion.identifier |
| identifier | token | conformance-identifier |
External identifier for the value set |
ValueSet.identifier |
| jurisdiction | 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 | 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 authorizes the vision product |
VisionPrescription.prescriber |
| status | token | VisionPrescription-status |
The status of the vision prescription |
VisionPrescription.status |