Exchange
This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
(v3.5.0:
R4
Ballot
#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 |
|
| _lastUpdated | date | Resource-lastUpdated |
When the resource version last changed |
|
| _profile |
|
Resource-profile |
Profiles this resource claims to conform to |
|
| _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 |
|
| _source | uri | Resource-source | Identifies where the resource comes from | Resource.meta.source |
| _tag | token | Resource-tag |
Tags applied to this resource |
|
| 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 | clinical-code |
Multiple Resources:
|
|
| context TU | token | conformance-context |
Multiple Resources:
| (CapabilityStatement.useContext.value as CodeableConcept) | (CodeSystem.useContext.value as CodeableConcept) | (CompartmentDefinition.useContext.value as CodeableConcept) | (ConceptMap.useContext.value as CodeableConcept) | (GraphDefinition.useContext.value as CodeableConcept) | (ImplementationGuide.useContext.value as CodeableConcept) | (MessageDefinition.useContext.value as CodeableConcept) | (NamingSystem.useContext.value as CodeableConcept) | (OperationDefinition.useContext.value as CodeableConcept) | (SearchParameter.useContext.value as CodeableConcept) | (StructureDefinition.useContext.value as CodeableConcept) | (StructureMap.useContext.value as CodeableConcept) | (TerminologyCapabilities.useContext.value as CodeableConcept) | (ValueSet.useContext.value as CodeableConcept) |
| context-quantity TU | quantity | conformance-context-quantity | Multiple Resources:
| (CapabilityStatement.useContext.value as Quantity) | (CapabilityStatement.useContext.value as Range) | (CodeSystem.useContext.value as Quantity) | (CodeSystem.useContext.value as Range) | (CompartmentDefinition.useContext.value as Quantity) | (CompartmentDefinition.useContext.value as Range) | (ConceptMap.useContext.value as Quantity) | (ConceptMap.useContext.value as Range) | (GraphDefinition.useContext.value as Quantity) | (GraphDefinition.useContext.value as Range) | (ImplementationGuide.useContext.value as Quantity) | (ImplementationGuide.useContext.value as Range) | (MessageDefinition.useContext.value as Quantity) | (MessageDefinition.useContext.value as Range) | (NamingSystem.useContext.value as Quantity) | (NamingSystem.useContext.value as Range) | (OperationDefinition.useContext.value as Quantity) | (OperationDefinition.useContext.value as Range) | (SearchParameter.useContext.value as Quantity) | (SearchParameter.useContext.value as Range) | (StructureDefinition.useContext.value as Quantity) | (StructureDefinition.useContext.value as Range) | (StructureMap.useContext.value as Quantity) | (StructureMap.useContext.value as Range) | (TerminologyCapabilities.useContext.value as Quantity) | (TerminologyCapabilities.useContext.value as Range) | (ValueSet.useContext.value as Quantity) | (ValueSet.useContext.value as Range) |
| context-type TU | token | conformance-context-type | Multiple Resources:
|
|
| context-type-quantity TU |
|
conformance-context-type-quantity |
Multiple Resources:
| CapabilityStatement.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | ValueSet.useContext |
| context-type-value TU | composite | conformance-context-type-value | Multiple Resources:
| CapabilityStatement.useContext | CodeSystem.useContext | CompartmentDefinition.useContext | ConceptMap.useContext | GraphDefinition.useContext | ImplementationGuide.useContext | MessageDefinition.useContext | NamingSystem.useContext | OperationDefinition.useContext | SearchParameter.useContext | StructureDefinition.useContext | StructureMap.useContext | TerminologyCapabilities.useContext | ValueSet.useContext |
| date N | date | conformance-date | Multiple Resources:
| CapabilityStatement.date | CodeSystem.date | CompartmentDefinition.date | ConceptMap.date | GraphDefinition.date | ImplementationGuide.date | MessageDefinition.date | NamingSystem.date | OperationDefinition.date | SearchParameter.date | StructureDefinition.date | StructureMap.date | TerminologyCapabilities.date | ValueSet.date |
| date TU | date | clinical-date | Multiple Resources:
|
|
| description N | string | conformance-description | Multiple Resources:
| CapabilityStatement.description | CodeSystem.description | CompartmentDefinition.description | ConceptMap.description | GraphDefinition.description | ImplementationGuide.description | MessageDefinition.description | NamingSystem.description | OperationDefinition.description | SearchParameter.description | StructureDefinition.description | StructureMap.description | TerminologyCapabilities.description | ValueSet.description |
| email 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:
| CapabilityStatement.jurisdiction | CodeSystem.jurisdiction | ConceptMap.jurisdiction | GraphDefinition.jurisdiction | ImplementationGuide.jurisdiction | MessageDefinition.jurisdiction | NamingSystem.jurisdiction | OperationDefinition.jurisdiction | SearchParameter.jurisdiction | StructureDefinition.jurisdiction | StructureMap.jurisdiction | TerminologyCapabilities.jurisdiction | ValueSet.jurisdiction |
| medication TU | reference | medications-medication |
Multiple Resources:
|
|
| name N |
|
conformance-name |
Multiple Resources:
|
CapabilityStatement.name | CodeSystem.name | CompartmentDefinition.name | ConceptMap.name | GraphDefinition.name | ImplementationGuide.name | MessageDefinition.name | NamingSystem.name | OperationDefinition.name | SearchParameter.name | StructureDefinition.name | StructureMap.name | TerminologyCapabilities.name | ValueSet.name |
| patient TU | reference | clinical-patient | Multiple Resources:
|
|
|
|
token | individual-phone |
Multiple Resources:
|
|
| phonetic N | string | individual-phonetic |
Multiple Resources:
|
|
| publisher N |
|
conformance-publisher |
Multiple Resources:
|
|
| status N | token | conformance-status |
Multiple Resources:
| CapabilityStatement.status | CodeSystem.status | CompartmentDefinition.status | ConceptMap.status | GraphDefinition.status | ImplementationGuide.status | MessageDefinition.status | NamingSystem.status | OperationDefinition.status | SearchParameter.status | StructureDefinition.status | StructureMap.status | TerminologyCapabilities.status | ValueSet.status |
| status TU | token | medications-status | Multiple Resources:
|
|
| telecom N | token | individual-telecom |
Multiple Resources:
| Patient.telecom | Person.telecom | Practitioner.telecom | PractitionerRole.telecom | RelatedPerson.telecom |
| title N | string | conformance-title | Multiple Resources:
|
|
| type TU | token | clinical-type |
Multiple Resources:
|
|
| url N | uri | conformance-url | Multiple Resources:
| CapabilityStatement.url | CodeSystem.url | CompartmentDefinition.url | ConceptMap.url | GraphDefinition.url | ImplementationGuide.url | MessageDefinition.url | OperationDefinition.url | SearchParameter.url | StructureDefinition.url | StructureMap.url | TerminologyCapabilities.url | ValueSet.url |
| version N |
|
conformance-version |
|
|
| Account TU | ||||
| identifier | token | Account-identifier |
Account number |
|
| name | string | Account-name |
Human-readable label |
|
| owner | reference | Account-owner |
Who is responsible? |
|
| patient | reference | Account-patient |
What is account tied to? |
|
| period | date | Account-period |
Transaction window |
|
| status | token | Account-status |
active | inactive | entered-in-error | on-hold | unknown |
|
| subject | reference | Account-subject |
What is account tied to? |
|
| type | token | Account-type |
E.g. patient, expense, depreciation |
|
| ActivityDefinition TU | ||||
| composed-of | reference | ActivityDefinition-composed-of |
What resource is being referenced |
|
| 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 |
|
| depends-on | reference | ActivityDefinition-depends-on |
What resource is being referenced |
|
| derived-from | reference | ActivityDefinition-derived-from |
What resource is being referenced |
|
| description | string | ActivityDefinition-description |
The description of the activity definition |
|
| effective | date | ActivityDefinition-effective |
The time during which the activity definition is intended to be in use |
|
| identifier | token | ActivityDefinition-identifier |
External identifier for the activity definition |
|
| jurisdiction | token | ActivityDefinition-jurisdiction |
Intended jurisdiction for the activity definition |
|
| name | string | ActivityDefinition-name |
Computationally friendly name of the activity definition |
|
| predecessor | reference | ActivityDefinition-predecessor |
What resource is being referenced |
|
| publisher | string | ActivityDefinition-publisher |
Name of the publisher of the activity definition |
|
| status | token | ActivityDefinition-status |
The current status of the activity definition |
|
| successor | reference | ActivityDefinition-successor |
What resource is being referenced |
|
| title | string | ActivityDefinition-title |
The human-friendly name of the activity definition |
|
| topic | token | ActivityDefinition-topic |
Topics associated with the module |
|
| url | uri | ActivityDefinition-url |
The uri that identifies the activity definition |
|
| version | token | ActivityDefinition-version |
The business version of the activity definition |
|
| AdverseEvent TU | ||||
| actuality | token | AdverseEvent-actuality |
|
|
| category | token | AdverseEvent-category | product-problem | product-quality | product-use-error | wrong-dose | incorrect-prescribing-information | wrong-technique | wrong-route-of-administration | wrong-rate | wrong-duration | wrong-time | expired-drug | medical-device-use-error | problem-different-manufacturer | unsafe-physical-environment | AdverseEvent.category |
| date | date | AdverseEvent-date |
When the event occurred |
|
| 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 |
|
| recorder | reference | AdverseEvent-recorder |
|
|
| resultingcondition | reference | AdverseEvent-resultingcondition |
|
|
| seriousness | token | AdverseEvent-seriousness |
| AdverseEvent.seriousness |
| severity | token | AdverseEvent-severity |
mild
|
|
|
| study | reference | AdverseEvent-study |
AdverseEvent.study |
|
| subject | reference | AdverseEvent-subject |
Subject
|
|
| substance | reference | AdverseEvent-substance |
Refers to the specific entity that caused the adverse event |
|
| AllergyIntolerance TU | ||||
| asserter | reference | AllergyIntolerance-asserter |
Source of the information about the allergy |
|
| category | token | AllergyIntolerance-category |
food | medication | environment | biologic |
|
| clinical-status | token | AllergyIntolerance-clinical-status |
active | inactive | resolved |
|
| code | token | clinical-code |
Code that identifies the allergy or intolerance |
|
| criticality | token | AllergyIntolerance-criticality |
low | high | unable-to-assess |
|
| date | date | clinical-date |
Date
record
was
|
|
| identifier | token | clinical-identifier |
External ids for this item |
|
| last-date | date | AllergyIntolerance-last-date |
Date(/time) of last known occurrence of a reaction |
|
| manifestation | token | AllergyIntolerance-manifestation |
Clinical symptoms/signs associated with the Event |
|
| onset | date | AllergyIntolerance-onset |
Date(/time) when manifestations showed |
|
| patient | reference | clinical-patient |
Who the sensitivity is for |
|
| recorder | reference | AllergyIntolerance-recorder |
Who recorded the sensitivity |
|
| route | token | AllergyIntolerance-route |
How the subject was exposed to the substance |
|
| severity | token | AllergyIntolerance-severity |
mild | moderate | severe (of event as a whole) |
|
| type | token | clinical-type |
allergy | intolerance - Underlying mechanism (if known) |
|
| verification-status | token | AllergyIntolerance-verification-status |
unconfirmed | confirmed | refuted | entered-in-error |
|
| Appointment TU | ||||
| actor | reference | Appointment-actor |
Any one of the individuals participating in the appointment |
|
| appointment-type | token | Appointment-appointment-type |
The style of appointment or patient that has been booked in the slot (not service type) |
|
| based-on |
|
Appointment-based-on |
|
|
| date |
|
Appointment-date |
|
|
| identifier |
|
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. |
|
| 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 |
|
| status | token | Appointment-status |
The overall status of the appointment |
|
| AppointmentResponse TU | ||||
| actor | reference | AppointmentResponse-actor |
The Person, Location/HealthcareService or Device that this appointment response replies for |
|
| appointment | reference | AppointmentResponse-appointment |
The appointment that the response is attached to |
|
| identifier | token | AppointmentResponse-identifier |
An Identifier in this appointment response |
|
| location | reference | AppointmentResponse-location |
This Response is for this Location |
|
| part-status | token | AppointmentResponse-part-status |
The participants acceptance status for this appointment |
|
| 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 |
|
| address | string | AuditEvent-address |
Identifier for the network access point of the user device |
|
| agent | reference | AuditEvent-agent |
|
|
| agent-name | string | AuditEvent-agent-name |
|
|
| agent-role | token | AuditEvent-agent-role |
Agent role in the event |
|
| altid | token | AuditEvent-altid |
Alternative
User
|
|
| date | date | AuditEvent-date |
Time
when
the
event
|
|
| entity | reference |
|
Specific
instance
of
|
|
| entity-name | string | AuditEvent-entity-name |
Descriptor for entity |
|
| entity-role | token | AuditEvent-entity-role |
What role the entity played |
|
| entity-type | token | AuditEvent-entity-type |
Type of entity involved |
|
| outcome | token | AuditEvent-outcome |
Whether the event succeeded or failed |
|
| patient | reference | AuditEvent-patient |
|
|
| policy | uri | AuditEvent-policy |
Policy that authorized event |
|
| site | token | AuditEvent-site |
Logical source location within the enterprise |
|
| source |
|
AuditEvent-source |
The identity of source detecting the event |
|
| subtype | token | AuditEvent-subtype |
More specific type/id for the event |
|
| type | token |
|
|
|
| Basic TU | ||||
| author | reference | Basic-author |
Who created |
|
| code | token | Basic-code |
Kind of Resource |
|
| created | date | Basic-created |
When created |
|
| identifier | token | Basic-identifier |
Business identifier |
|
| patient | reference | Basic-patient |
Identifies the focus of this resource |
|
| subject | reference | Basic-subject |
Identifies the focus of this resource |
|
|
|
||||
| identifier | token | BodyStructure-identifier |
|
|
| location | token | BodyStructure-location |
|
|
| morphology | token | BodyStructure-morphology |
|
|
| patient | reference | BodyStructure-patient |
|
|
| Bundle N | ||||
| composition | reference | Bundle-composition |
The
first
resource
in
the
bundle,
if
the
bundle
type
is
|
|
| identifier | token | Bundle-identifier |
Persistent identifier for the bundle |
|
| message | reference | Bundle-message |
The
first
resource
in
the
bundle,
if
the
bundle
type
is
|
|
| 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 |
|
| CapabilityStatement N | ||||
| context TU |
|
conformance-context |
|
|
| context-quantity TU |
|
conformance-context-quantity |
|
|
| context-type TU | token | conformance-context-type |
|
|
| 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 |
|
| format | token | CapabilityStatement-format |
formats supported (xml | json | ttl | mime type) |
|
| guide |
|
CapabilityStatement-guide |
Implementation guides supported |
|
| jurisdiction | token | conformance-jurisdiction |
Intended jurisdiction for the capability statement |
|
| mode | token | CapabilityStatement-mode |
Mode - restful (server/client) or messaging (sender/receiver) |
|
| name | string | conformance-name |
Computationally friendly name of the capability statement |
|
| publisher | string | conformance-publisher |
Name of the publisher of the capability statement |
|
| resource | token | CapabilityStatement-resource |
Name of a resource mentioned in a capability statement |
|
| resource-profile | reference | CapabilityStatement-resource-profile |
A profile id invoked in a capability statement |
|
| security-service TU | token | CapabilityStatement-security-service |
OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates |
|
| software | string | CapabilityStatement-software |
Part of a the name of a software application |
|
| status | token | conformance-status |
The current status of the capability statement |
|
| supported-profile TU | reference | CapabilityStatement-supported-profile |
Profiles for use cases supported |
|
| title | string | conformance-title |
The human-friendly name of the capability statement |
|
| url | uri | conformance-url |
The uri that identifies the capability statement |
|
| version | token | conformance-version |
The business version of the capability statement |
|
| CarePlan TU | ||||
| activity-code | token | CarePlan-activity-code |
Detail type of activity |
|
| activity-date | date | CarePlan-activity-date |
Specified
date
occurs
within
period
specified
by
|
|
| activity-reference | reference | CarePlan-activity-reference |
Activity details defined in specific resource |
|
| based-on | reference | CarePlan-based-on |
Fulfills
|
|
| care-team | reference | CarePlan-care-team |
Who's involved in plan? |
|
| category | token | CarePlan-category |
Type of plan |
|
| condition | reference | CarePlan-condition |
Health issues this plan addresses |
|
| context | reference | CarePlan-context |
Created in context of |
|
| date | date | clinical-date |
Time period plan covers |
|
| encounter | reference | CarePlan-encounter |
|
|
| goal | reference | CarePlan-goal |
|
|
| identifier | token | clinical-identifier | External Ids for this plan | CarePlan.identifier |
| instantiates-canonical | reference | CarePlan-instantiates-canonical |
|
|
| instantiates-uri |
|
CarePlan-instantiates-uri |
|
|
| intent | token | CarePlan-intent |
proposal | plan | order | option |
|
| part-of | reference | CarePlan-part-of |
Part of referenced CarePlan |
|
| 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
|
|
| replaces | reference | CarePlan-replaces |
CarePlan replaced by this CarePlan |
|
| status | token | CarePlan-status |
draft | active | suspended | completed | entered-in-error | cancelled | unknown |
|
| subject | reference | CarePlan-subject |
Who the care plan is for |
|
| CareTeam TU | ||||
| category | token | CareTeam-category |
Type of team |
|
| context | reference | CareTeam-context |
Encounter or episode associated with CareTeam |
|
| date | date | clinical-date |
Time period team covers |
|
| encounter | reference | CareTeam-encounter |
Encounter or episode associated with CareTeam |
|
| identifier | token | clinical-identifier |
External Ids for this team |
|
| participant | reference | CareTeam-participant |
Who is involved |
|
| patient | reference | clinical-patient |
Who care team is for |
|
| status | token | CareTeam-status |
proposed | active | suspended | inactive | entered-in-error |
|
| subject | reference | CareTeam-subject |
Who care team is for |
|
| ChargeItem TU | ||||
| account | reference | ChargeItem-account |
Account to place this charge |
|
| code | token | ChargeItem-code |
A code that identifies the charge, like a billing code |
|
| context | reference | ChargeItem-context |
Encounter / Episode associated with event |
|
| entered-date | date | ChargeItem-entered-date |
Date the charge item was entered |
|
| enterer | reference | ChargeItem-enterer |
Individual who was entering |
|
| factor-override | number | ChargeItem-factor-override |
Factor overriding the associated rules |
|
| identifier | token | ChargeItem-identifier |
Business Identifier for item |
|
| occurrence | date | ChargeItem-occurrence |
When the charged service was applied |
|
| patient | reference | ChargeItem-patient |
Individual
|
|
| performer-actor |
|
ChargeItem-performer-actor |
|
|
| performer-function |
|
ChargeItem-performer-function |
|
|
| performing-organization | reference | ChargeItem-performing-organization |
Organization providing the charged sevice |
|
| price-override | quantity | ChargeItem-price-override |
Price overriding the associated rules |
|
| quantity | quantity | ChargeItem-quantity |
Quantity of which the charge item has been serviced |
|
| requesting-organization | reference | ChargeItem-requesting-organization |
Organization requesting the charged service |
|
| service | reference | ChargeItem-service |
Which rendered service is being charged? |
|
| subject | reference | ChargeItem-subject |
Individual service was done for/to |
|
| 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 |
|
| created | date | Claim-created |
The creation date for the Claim |
|
| encounter | reference | Claim-encounter |
Encounters associated with a billed line item |
|
| enterer | reference | Claim-enterer |
The party responsible for the entry of the Claim |
|
| facility | reference | Claim-facility |
Facility responsible for the goods and services |
|
| identifier | token | Claim-identifier |
The primary identifier of the financial resource |
|
| insurer | reference | Claim-insurer |
The target payor/insurer for the Claim |
|
| patient | reference |
|
Patient receiving the services |
|
| payee | reference | Claim-payee |
The party receiving any payment for the Claim |
|
| priority | token | Claim-priority |
Processing priority requested |
|
| provider | reference | Claim-provider |
Provider responsible for the Claim |
|
| status | token | Claim-status | The status of the Claim instance. | Claim.status |
| use | token | Claim-use |
The kind of financial resource |
|
| ClaimResponse TU | ||||
| created | date | ClaimResponse-created |
The creation date |
|
| disposition | string | ClaimResponse-disposition |
The contents of the disposition message |
|
| identifier | token | ClaimResponse-identifier |
The
identity
of
the
|
|
| insurer | reference | ClaimResponse-insurer |
The organization who generated this resource |
|
| outcome | token | ClaimResponse-outcome |
The processing outcome |
|
| patient | reference | ClaimResponse-patient |
The
subject
of
|
|
| payment-date | date | ClaimResponse-payment-date |
The
expected
|
|
| request | reference | ClaimResponse-request |
The claim reference |
|
| request-provider | reference | ClaimResponse-request-provider |
The Provider of the claim |
|
| status |
token
|
|
|
|
| ClinicalImpression TU | ||||
| assessor | reference | ClinicalImpression-assessor |
The clinician performing the assessment |
|
| context | reference | ClinicalImpression-context |
Encounter or Episode created from |
|
| date | date | clinical-date |
When the assessment was documented |
|
| finding-code | token | ClinicalImpression-finding-code |
What was found |
|
| finding-ref | reference | ClinicalImpression-finding-ref |
What was found |
|
| identifier | token | ClinicalImpression-identifier |
Business identifier |
|
| investigation | reference | ClinicalImpression-investigation |
Record of a specific investigation |
|
| patient | reference | clinical-patient |
Patient or group assessed |
|
| previous | reference | ClinicalImpression-previous |
Reference to last assessment |
|
| problem | reference | ClinicalImpression-problem |
Relevant impressions of patient state |
|
| status | token | ClinicalImpression-status |
draft | completed | entered-in-error |
|
| subject | reference | ClinicalImpression-subject |
Patient or group assessed |
|
| 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 |
|
| content-mode | token | CodeSystem-content-mode |
not-present | example | fragment | complete | supplement |
|
| 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 |
|
| description | string | conformance-description |
The description of the code system |
|
| identifier | token | conformance-identifier |
External identifier for the code system |
|
| jurisdiction | token | conformance-jurisdiction |
Intended jurisdiction for the code system |
|
| language | token | CodeSystem-language |
A language in which a designation is provided |
|
| name | string | conformance-name |
Computationally friendly name of the code system |
|
| publisher | string | conformance-publisher |
Name of the publisher of the code system |
|
| status | token | conformance-status |
The current status of the code system |
|
| supplements | reference | CodeSystem-supplements | Find code system supplements for the referenced code system | CodeSystem.supplements |
| system | uri | CodeSystem-system |
The system for any codes defined by this code system (same as 'url') |
|
| title | string | conformance-title |
The human-friendly name of the code system |
|
| url | uri | conformance-url |
The uri that identifies the code system |
|
| version | token | conformance-version |
The business version of the code system |
|
| Communication TU | ||||
| based-on | reference | Communication-based-on |
Request fulfilled by this communication |
|
| category | token | Communication-category |
Message category |
|
| context | reference | Communication-context |
Encounter or episode leading to message |
|
| encounter | reference | Communication-encounter |
|
|
| identifier | token | Communication-identifier | Unique identifier | Communication.identifier |
| instantiates-canonical | reference | Communication-instantiates-canonical |
|
|
| instantiates-uri |
|
Communication-instantiates-uri |
|
|
| medium | token | Communication-medium |
A channel of communication |
|
| part-of | reference | Communication-part-of |
Part of this action |
|
| patient | reference | Communication-patient |
Focus of message |
|
| received | date | Communication-received |
When received |
|
| recipient | reference | Communication-recipient |
Message recipient |
|
| sender | reference | Communication-sender |
Message sender |
|
| sent | date | Communication-sent |
When sent |
|
| status | token | Communication-status |
preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error |
|
| subject | reference | Communication-subject |
Focus of message |
|
| CommunicationRequest TU | ||||
| authored | date | CommunicationRequest-authored |
When request transitioned to being actionable |
|
| based-on | reference | CommunicationRequest-based-on |
Fulfills plan or proposal |
|
| category | token | CommunicationRequest-category |
Message category |
|
| context | reference | CommunicationRequest-context |
Encounter or episode leading to message |
|
| encounter | reference | CommunicationRequest-encounter |
Encounter leading to message |
|
| group-identifier | token | CommunicationRequest-group-identifier |
Composite request this is part of |
|
| identifier | token | CommunicationRequest-identifier |
Unique identifier |
|
| medium | token | CommunicationRequest-medium |
A channel of communication |
|
| occurrence | date | CommunicationRequest-occurrence |
When scheduled |
|
| patient | reference | CommunicationRequest-patient |
Focus of message |
|
| priority | token | CommunicationRequest-priority |
Message urgency |
|
| recipient | reference | CommunicationRequest-recipient |
Message recipient |
|
| replaces | reference | CommunicationRequest-replaces |
Request(s) replaced by this request |
|
| requester | reference | CommunicationRequest-requester |
|
|
| sender | reference | CommunicationRequest-sender |
Message sender |
|
| status | token | CommunicationRequest-status |
draft | active | suspended | cancelled | completed | entered-in-error | unknown |
|
| subject | reference | CommunicationRequest-subject |
Focus of message |
|
| CompartmentDefinition TU | ||||
| code | token | CompartmentDefinition-code |
Patient | Encounter | RelatedPerson | Practitioner | Device |
|
| context |
|
conformance-context |
|
|
| context-quantity |
|
conformance-context-quantity |
|
|
| context-type | token | conformance-context-type |
|
|
| context-type-quantity | composite | conformance-context-type-quantity | A use context type and quantity- or range-based value assigned to the compartment definition | CompartmentDefinition.useContext |
| context-type-value | composite | conformance-context-type-value | A use context type and value assigned to the compartment definition | CompartmentDefinition.useContext |
| date N | date | conformance-date | The compartment definition publication date | CompartmentDefinition.date |
| description N | string | conformance-description | The description of the compartment definition | CompartmentDefinition.description |
| name N | string | conformance-name |
Computationally friendly name of the compartment definition |
|
| publisher N | string | conformance-publisher |
Name of the publisher of the compartment definition |
|
| resource | token | CompartmentDefinition-resource |
Name of resource type |
|
| status N | token | conformance-status |
The current status of the compartment definition |
|
| url N |
|
conformance-url |
The
|
|
| version N |
|
conformance-version |
The
|
|
| Composition TU | ||||
| attester | reference | Composition-attester |
Who attested the composition |
|
| author | reference | Composition-author |
Who and/or what authored the composition |
|
| category | token | Composition-category |
Categorization of Composition |
|
| confidentiality | token | Composition-confidentiality |
As defined by affinity domain |
|
| context | token | Composition-context |
Code(s) that apply to the event being documented |
|
| date | date | clinical-date |
Composition editing time |
|
| encounter | reference | clinical-encounter |
Context of the Composition |
|
| entry | reference | Composition-entry |
A reference to data that supports this section |
|
| identifier | token | clinical-identifier |
|
|
| patient | reference | clinical-patient |
Who and/or what the composition is about |
|
| period | date | Composition-period |
The period covered by the documentation |
|
| 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) |
|
| status | token | Composition-status |
preliminary | final | amended | entered-in-error |
|
| subject | reference | Composition-subject |
Who and/or what the composition is about |
|
| title | string | Composition-title |
Human Readable name/title |
|
| type | token | clinical-type |
Kind of composition (LOINC if possible) |
|
| 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 |
|
| dependson | uri | ConceptMap-dependson |
Reference to property mapping depends on |
|
| description N | string | conformance-description |
The description of the concept map |
|
| identifier N | token | conformance-identifier |
External identifier for the concept map |
|
| jurisdiction N | token | conformance-jurisdiction |
Intended jurisdiction for the concept map |
|
| name N | string | conformance-name |
Computationally friendly name of the concept map |
|
| other |
|
ConceptMap-other |
Canonical
|
|
| product | uri | ConceptMap-product |
Reference to property mapping depends on |
|
| publisher N | string | conformance-publisher |
Name of the publisher of the concept map |
|
| source | reference | ConceptMap-source |
|
|
| source-code | token | ConceptMap-source-code |
Identifies element being mapped |
|
| source-system | uri | ConceptMap-source-system |
|
|
| source-uri | reference | ConceptMap-source-uri |
|
|
| status N | token | conformance-status |
The current status of the concept map |
|
| target | reference | ConceptMap-target |
|
|
| target-code | token | ConceptMap-target-code |
Code that identifies the target element |
|
| target-system | uri | ConceptMap-target-system |
|
|
| target-uri | reference | ConceptMap-target-uri |
|
|
| title N | string | conformance-title |
The human-friendly name of the concept map |
|
| url N | uri | conformance-url |
The uri that identifies the concept map |
|
| version N | token | conformance-version |
The business version of the concept map |
|
| Condition TU | ||||
| abatement-age | quantity | Condition-abatement-age |
Abatement as age or age range |
|
|
|
date | Condition-abatement-date |
Date-related abatements (dateTime and period) |
|
| abatement-string | string | Condition-abatement-string |
Abatement as a string |
|
|
|
reference | Condition-asserter |
Person who asserts this condition |
|
| body-site | token | Condition-body-site |
Anatomical location, if relevant |
|
| category | token | Condition-category |
The category of the condition |
|
| clinical-status | token | Condition-clinical-status |
The clinical status of the condition |
|
| code | token | clinical-code |
Code for the condition |
|
| context | reference | Condition-context |
Encounter or episode when condition first asserted |
|
| encounter | reference | Condition-encounter |
Encounter when condition first asserted |
|
| evidence | token | Condition-evidence |
Manifestation/symptom |
|
| evidence-detail | reference | Condition-evidence-detail |
Supporting information found elsewhere |
|
| identifier | token | clinical-identifier |
A unique identifier of the condition record |
|
| onset-age | quantity | Condition-onset-age |
Onsets as age or age range |
|
| onset-date | date | Condition-onset-date |
Date related onsets (dateTime and Period) |
|
| onset-info | string | Condition-onset-info |
Onsets as a string |
|
| 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 |
|
| stage | token | Condition-stage |
Simple summary (disease specific) |
|
| subject | reference | Condition-subject |
Who has the condition? |
|
| verification-status | token | Condition-verification-status |
unconfirmed
|
provisional
|
differential
|
confirmed
|
refuted
|
entered-in-error
|
|
| Consent TU | ||||
| action | token | Consent-action |
Actions
controlled
by
this
|
|
| actor | reference | Consent-actor |
Resource for the actor (or group, by role) |
|
| category | token | Consent-category |
Classification of the consent statement - for indexing/retrieval |
|
| consentor | reference | Consent-consentor |
Who
is
agreeing
to
the
policy
and
|
|
| data | reference | Consent-data |
The actual data reference |
|
| date | date | clinical-date |
When this Consent was created or indexed |
|
| identifier | token | clinical-identifier |
Identifier for this record (external references) |
|
| organization | reference | Consent-organization |
Custodian of the consent |
|
| patient | reference | clinical-patient |
Who the consent applies to |
|
| period | date | Consent-period |
|
|
| purpose | token | Consent-purpose |
Context
of
activities
| Consent.provision.purpose |
| scope | token | Consent-scope |
Which
of
the
|
|
| security-label | token | Consent-security-label |
Security Labels that define affected resources |
|
| source-identifier | token | Consent-source-identifier | Search by token to an identifier | Consent.source |
| source-reference | reference | Consent-source-reference |
|
|
| status | token | Consent-status |
draft | proposed | active | rejected | inactive | entered-in-error |
|
| Contract TU | ||||
| authority | reference | Contract-authority |
|
|
| domain | reference | Contract-domain |
The
|
|
| identifier |
|
Contract-identifier |
The
|
|
| instantiates |
|
Contract-instantiates |
|
|
| issued | date | Contract-issued |
The date/time the contract was issued |
|
| patient | reference | Contract-patient |
The identity of the subject of the contract (if a patient) |
|
| signer | reference | Contract-signer |
Contract Signatory Party |
|
| status |
|
Contract-status |
The
|
|
| subject | reference | Contract-subject |
The
identity
of
the
|
|
| url |
uri
|
|
|
|
|
|
||||
| beneficiary |
|
Coverage-beneficiary |
|
|
| dependent | string | Coverage-dependent |
|
|
| identifier | token | Coverage-identifier |
The primary identifier of the insured and the coverage |
|
| patient | reference | Coverage-patient |
|
|
| payor |
|
Coverage-payor |
|
|
| policy-holder | reference | Coverage-policy-holder |
Reference to the policyholder |
|
| status |
|
Coverage-status |
|
|
| subscriber |
|
Coverage-subscriber |
|
|
| type |
|
Coverage-type |
|
|
|
|
||||
| created |
|
CoverageEligibilityRequest-created |
|
|
| enterer |
|
CoverageEligibilityRequest-enterer |
The
|
|
| facility |
|
CoverageEligibilityRequest-facility | Facility responsible for the goods and services |
CoverageEligibilityRequest.facility |
| identifier | token | CoverageEligibilityRequest-identifier |
|
|
| patient |
|
CoverageEligibilityRequest-patient |
The
|
|
| provider |
|
CoverageEligibilityRequest-provider |
|
|
| status | token | CoverageEligibilityRequest-status |
|
|
|
|
||||
| created |
|
CoverageEligibilityResponse-created |
|
|
| disposition |
|
CoverageEligibilityResponse-disposition |
|
CoverageEligibilityResponse.disposition |
| identifier | token | CoverageEligibilityResponse-identifier |
|
CoverageEligibilityResponse.identifier |
| insurer |
|
CoverageEligibilityResponse-insurer |
|
|
| outcome | token | CoverageEligibilityResponse-outcome |
The
|
|
| patient |
|
CoverageEligibilityResponse-patient |
The
|
|
| request |
|
CoverageEligibilityResponse-request |
The
|
|
| request-provider |
|
CoverageEligibilityResponse-request-provider |
The
|
|
| status | token | CoverageEligibilityResponse-status |
The
|
|
| DetectedIssue TU | ||||
| author | reference | DetectedIssue-author |
The provider or device that identified the issue |
|
| category | token | DetectedIssue-category |
Issue Category, e.g. drug-drug, duplicate therapy, etc. |
|
| date | date | clinical-date |
When identified |
|
| identifier | token | clinical-identifier |
Unique id for the detected issue |
|
| implicated | reference | DetectedIssue-implicated |
Problem resource |
|
| patient | reference | clinical-patient |
Associated 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 |
|
| location | reference | Device-location |
A location, where the resource is found |
|
| manufacturer | string | Device-manufacturer |
The manufacturer of the device |
|
| model | string | Device-model |
The model of the device |
|
| organization | reference | Device-organization |
The organization responsible for the device |
|
| patient | reference | Device-patient |
Patient information, if the resource is affixed to a person |
|
| status | token | Device-status |
active | inactive | entered-in-error | unknown |
|
| type | token | Device-type |
The type of the device |
|
| 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 |
|
|
|
||||
| identifier | token | DeviceDefinition-identifier |
The identifier of the component |
|
| parent | reference |
|
The
|
|
| type | token | DeviceDefinition-type |
The device component type |
|
| DeviceMetric TU | ||||
| category | token | DeviceMetric-category |
The category of the metric |
|
| identifier | token | DeviceMetric-identifier |
The identifier of the metric |
|
| parent | reference | DeviceMetric-parent |
The parent DeviceMetric resource |
|
| source | reference | DeviceMetric-source |
The device resource |
|
| type | token | DeviceMetric-type |
The component type |
|
| DeviceRequest TU | ||||
| authored-on | date | DeviceRequest-authored-on |
When the request transitioned to being actionable |
|
| based-on | reference | DeviceRequest-based-on |
Plan/proposal/order fulfilled by this request |
|
| code | token | clinical-code |
Code for what is being requested/ordered |
|
| device | reference |
|
Reference to resource that is being requested/ordered |
|
| encounter | reference | clinical-encounter |
Encounter or Episode during which request was created |
|
| event-date | date | DeviceRequest-event-date |
When service should occur |
|
| group-identifier | token | DeviceRequest-group-identifier |
Composite request this is part of |
|
| identifier | token | clinical-identifier |
Business identifier for request/order |
|
| instantiates-canonical | reference | DeviceRequest-instantiates-canonical | Instantiates FHIR protocol or definition | DeviceRequest.instantiatesCanonical |
| instantiates-uri | uri | DeviceRequest-instantiates-uri | Instantiates external protocol or definition | DeviceRequest.instantiatesUri |
| insurance | reference | DeviceRequest-insurance | Associated insurance coverage | DeviceRequest.insurance |
| intent | token | DeviceRequest-intent |
proposal | plan | original-order |reflex-order |
|
| patient | reference | clinical-patient |
Individual the service is ordered for |
|
| performer | reference | DeviceRequest-performer |
Desired performer for service |
|
| prior-request | reference | DeviceRequest-prior-request |
Request takes the place of referenced completed or terminated requests |
|
| requester | reference | DeviceRequest-requester |
Who/what
is
requesting
|
|
| status | token | DeviceRequest-status |
entered-in-error
|
draft
|
active
|suspended
|
|
|
| subject | reference | DeviceRequest-subject |
Individual the service is ordered for |
|
| DeviceUseStatement TU | ||||
| device | reference | DeviceUseStatement-device |
Search by device |
|
| identifier | token | DeviceUseStatement-identifier |
Search by identifier |
|
| patient | reference | clinical-patient |
Search by subject - a patient |
|
| subject | reference | DeviceUseStatement-subject |
Search by subject |
|
| DiagnosticReport TU | ||||
| based-on | reference | DiagnosticReport-based-on |
Reference
to
the
|
|
| category | token | DiagnosticReport-category |
Which diagnostic discipline/department created the report |
|
| code | token | clinical-code |
The
code
for
the
|
|
| conclusion |
|
DiagnosticReport-conclusion |
|
|
| context |
|
DiagnosticReport-context |
|
|
| date |
|
clinical-date |
|
|
| encounter | reference | clinical-encounter |
The Encounter when the order was made |
|
| identifier | token | clinical-identifier |
An identifier for the report |
|
| issued |
|
DiagnosticReport-issued |
|
|
| media |
|
DiagnosticReport-media |
|
|
| patient | reference | clinical-patient |
The subject of the report if a patient |
|
| performer | reference | DiagnosticReport-performer |
Who
|
|
| result | reference | DiagnosticReport-result |
Link to an atomic result (observation resource) |
|
| results-interpreter | reference | DiagnosticReport-results-interpreter | Who was the source of the report | DiagnosticReport.resultsInterpreter |
| specimen | reference | DiagnosticReport-specimen |
The specimen details |
|
| status | token | DiagnosticReport-status |
The status of the report |
|
| subject | reference | DiagnosticReport-subject |
The subject of the report |
|
| DocumentManifest TU | ||||
| agent | reference | DocumentManifest-agent |
Who
and/or
what
|
|
|
|
date | DocumentManifest-created |
When this document manifest created |
|
| description | string | DocumentManifest-description |
Human-readable description (title) |
|
| identifier | token | clinical-identifier |
Unique Identifier for the set of documents |
|
| 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 |
|
| related-id | token | DocumentManifest-related-id |
Identifiers of things that are related |
|
| related-ref | reference | DocumentManifest-related-ref |
Related Resource |
|
| source | uri | DocumentManifest-source |
The source system/application/software |
|
| status | token | DocumentManifest-status |
current | superseded | entered-in-error |
|
| subject | reference | DocumentManifest-subject |
The subject of the set of documents |
|
| type | token | clinical-type |
Kind of document set |
|
| DocumentReference TU | ||||
| agent | reference | DocumentReference-agent |
|
|
| authenticator | reference | DocumentReference-authenticator |
|
|
| category | token | DocumentReference-category |
Categorization of document |
|
| contenttype |
|
DocumentReference-contenttype |
|
|
| custodian | reference | DocumentReference-custodian |
Organization which maintains the document |
|
| date | date | DocumentReference-date | When this document reference was created | DocumentReference.date |
| description | string | DocumentReference-description |
Human-readable
description
|
|
| encounter | reference | clinical-encounter |
Context of the document content |
|
| event | token | DocumentReference-event |
Main clinical acts documented |
|
| facility | token | DocumentReference-facility |
Kind of facility where patient was seen |
|
| format | token | DocumentReference-format |
Format/content rules for the document |
|
| identifier | token | clinical-identifier |
Master Version Specific Identifier |
|
|
|
token | DocumentReference-language |
Human language of the content (BCP-47) |
|
| location | uri | DocumentReference-location |
Uri where the data can be found |
|
| patient | reference | clinical-patient |
Who/what is the subject of the document |
|
| period | date | DocumentReference-period |
Time of service that is being documented |
|
|
|
reference | DocumentReference-related |
Related
|
|
| relatesto | reference | DocumentReference-relatesto |
Target of the relationship |
|
| relation | token | DocumentReference-relation |
replaces | transforms | signs | appends |
|
| relationship | composite | DocumentReference-relationship |
Combination of relation and relatesTo |
|
| security-label | token | DocumentReference-security-label |
Document security-tags |
|
| setting | token | DocumentReference-setting |
Additional details about where the content was created (e.g. clinical specialty) |
|
| status | token | DocumentReference-status |
current | superseded | entered-in-error |
|
| subject | reference | DocumentReference-subject |
Who/what is the subject of the document |
|
| type | token | clinical-type |
Kind of document (LOINC if possible) |
|
|
|
||||
|
|
reference |
|
The
|
|
|
|
reference |
|
The
|
|
|
|
reference |
|
The
|
|
| class | token | Encounter-class |
|
|
| date | date | clinical-date |
A date within the period the Encounter lasted |
|
| diagnosis | reference | Encounter-diagnosis |
Reason the encounter takes place (resource) |
|
| episode-of-care | reference | Encounter-episode-of-care |
Episode(s) of care that this encounter should be recorded against |
|
| identifier | token | clinical-identifier |
Identifier(s) by which this encounter is known |
|
|
|
|
|
Length of encounter in days |
|
| 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 |
|
| 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 |
|
| participant-type | token | Encounter-participant-type |
Role of participant in encounter |
|
| patient | reference | clinical-patient |
The
patient
|
|
| practitioner | reference | Encounter-practitioner |
Persons involved in the encounter other than the patient |
|
| reason | token | Encounter-reason |
Reason the encounter takes place (code) |
|
| service-provider | reference | Encounter-service-provider |
The
|
|
| special-arrangement | token | Encounter-special-arrangement |
Wheelchair, translator, stretcher, etc. |
|
| status | token | Encounter-status |
planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
|
| subject | reference | Encounter-subject |
The
patient
|
|
| type | token | clinical-type |
Specific type of encounter |
|
| Endpoint TU | ||||
| connection-type | token | Endpoint-connection-type |
Protocol/Profile/Standard to be used with this endpoint connection |
|
| identifier | token | Endpoint-identifier |
Identifies this endpoint across multiple systems |
|
| name | string | Endpoint-name |
A name that this endpoint can be identified by |
|
| 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) |
|
| status | token | Endpoint-status |
The current status of the Endpoint (usually expected to be active) |
|
| EnrollmentRequest TU | ||||
| identifier | token | EnrollmentRequest-identifier |
The business identifier of the Enrollment |
|
| patient | reference | EnrollmentRequest-patient |
The
|
|
| status |
|
EnrollmentRequest-status |
The
|
|
| subject | reference | EnrollmentRequest-subject |
The party to be enrolled |
|
| EnrollmentResponse TU | ||||
| identifier | token | EnrollmentResponse-identifier |
The business identifier of the EnrollmentResponse |
|
| request | reference | EnrollmentResponse-request |
The
|
|
| status |
|
EnrollmentResponse-status |
The
|
|
| EpisodeOfCare TU | ||||
| care-manager | reference | EpisodeOfCare-care-manager |
Care
manager/care
|
|
| 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 |
|
| identifier | token | clinical-identifier |
Business Identifier(s) relevant for this EpisodeOfCare |
|
| incoming-referral | reference | EpisodeOfCare-incoming-referral |
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) |
|
| type | token | clinical-type |
Type/class - e.g. specialist referral, disease management |
|
|
|
||||
| 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
|
|
| 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
|
|
| 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
|
|
| jurisdiction | token | EventDefinition-jurisdiction |
Intended
jurisdiction
for
the
|
|
| name | string | EventDefinition-name |
Computationally
friendly
name
of
the
|
|
| 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
|
|
| status | token | EventDefinition-status |
The
current
status
of
the
|
|
| 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
|
|
| version | token | EventDefinition-version |
The
business
version
of
the
|
|
| ExampleScenario TU | ||||
| context | token | ExampleScenario-context | A use context assigned to the example scenario | (ExampleScenario.useContext.value as CodeableConcept) |
| context-quantity | quantity | ExampleScenario-context-quantity | A quantity- or range-valued use context assigned to the example scenario | (ExampleScenario.useContext.value as Quantity) | (ExampleScenario.useContext.value as Range) |
| context-type | token | ExampleScenario-context-type | A type of use context assigned to the example scenario | ExampleScenario.useContext.code |
| context-type-quantity | composite | ExampleScenario-context-type-quantity | A use context type and quantity- or range-based value assigned to the example scenario | ExampleScenario.useContext |
| context-type-value | composite | ExampleScenario-context-type-value | A use context type and value assigned to the example scenario | ExampleScenario.useContext |
| date | date | ExampleScenario-date | The example scenario publication date | ExampleScenario.date |
| identifier | token | ExampleScenario-identifier | External identifier for the example scenario | ExampleScenario.identifier |
| jurisdiction | token | ExampleScenario-jurisdiction | Intended jurisdiction for the example scenario | ExampleScenario.jurisdiction |
| name | string | ExampleScenario-name | Computationally friendly name of the example scenario | ExampleScenario.name |
| publisher | string | ExampleScenario-publisher | Name of the publisher of the example scenario | ExampleScenario.publisher |
| status | token | ExampleScenario-status | The current status of the example scenario | ExampleScenario.status |
| url | uri | ExampleScenario-url | The uri that identifies the example scenario | ExampleScenario.url |
| version | token | ExampleScenario-version | The business version of the example scenario | ExampleScenario.version |
| ExplanationOfBenefit TU | ||||
| care-team | reference | ExplanationOfBenefit-care-team |
Member of the CareTeam |
|
| claim | reference | ExplanationOfBenefit-claim |
The reference to the claim |
|
| coverage | reference | ExplanationOfBenefit-coverage |
The plan under which the claim was adjudicated |
|
| created | date | ExplanationOfBenefit-created |
The creation date for the EOB |
|
| disposition | string | ExplanationOfBenefit-disposition |
The contents of the disposition message |
|
| encounter | reference | ExplanationOfBenefit-encounter |
Encounters associated with a billed line item |
|
| enterer | reference | ExplanationOfBenefit-enterer |
The party responsible for the entry of the Claim |
|
| facility | reference | ExplanationOfBenefit-facility |
Facility responsible for the goods and services |
|
| identifier | token | ExplanationOfBenefit-identifier |
The business identifier of the Explanation of Benefit |
|
| patient | reference | ExplanationOfBenefit-patient |
The
reference
to
the
|
|
| payee | reference | ExplanationOfBenefit-payee |
The
|
|
| provider | reference | ExplanationOfBenefit-provider |
The
|
|
| status |
|
ExplanationOfBenefit-status |
|
|
| FamilyMemberHistory TU | ||||
| code | token | clinical-code |
A search by a condition code |
|
| date | date | clinical-date |
When
history
was
|
|
| gender |
|
FamilyMemberHistory-gender |
|
|
| identifier | token | clinical-identifier |
A
search
by
a
|
|
| instantiates-canonical |
|
FamilyMemberHistory-instantiates-canonical |
|
|
| instantiates-uri | uri | FamilyMemberHistory-instantiates-uri | Instantiates external protocol or definition | FamilyMemberHistory.instantiatesUri |
| patient | reference | clinical-patient |
The identity of a subject to list family member history items for |
|
| relationship | token | FamilyMemberHistory-relationship |
A search by a relationship type |
|
| status | token | FamilyMemberHistory-status |
partial | completed | entered-in-error | health-unknown |
|
| Flag TU | ||||
| author | reference | Flag-author |
Flag creator |
|
| date | date | clinical-date |
Time period when flag is active |
|
| encounter | reference | clinical-encounter |
Alert relevant during encounter |
|
| identifier | token | Flag-identifier |
Business 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 |
|
| Goal TU | ||||
| category | token | Goal-category |
E.g. Treatment, dietary, behavioral, etc. |
|
| identifier | token | clinical-identifier |
External Ids for this goal |
|
| 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 |
|
| subject | reference | Goal-subject |
Who this goal is intended for |
|
| 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 |
|
| description N | string | conformance-description |
The description of the graph definition |
|
| jurisdiction N | token | conformance-jurisdiction |
Intended jurisdiction for the graph definition |
|
| name N | string | conformance-name |
Computationally friendly name of the graph definition |
|
| publisher N | string | conformance-publisher |
Name of the publisher of the graph definition |
|
| start | token | GraphDefinition-start |
Type of resource at which the graph starts |
|
| status N | token | conformance-status |
The current status of the graph definition |
|
| url N | uri | conformance-url |
The uri that identifies the graph definition |
|
| version N | token | conformance-version |
The business version of the graph definition |
|
| Group TU | ||||
| actual | token | Group-actual |
Descriptive or actual |
|
| characteristic | token | Group-characteristic |
Kind of characteristic |
|
| characteristic-value | composite | Group-characteristic-value |
A composite of both characteristic and value |
|
| code | token | Group-code |
The kind of resources contained |
|
| exclude | token | Group-exclude |
Group includes or excludes |
|
| identifier | token | Group-identifier |
Unique id |
|
| member | reference | Group-member |
Reference to the group member |
|
| type | token | Group-type |
The type of resources the group contains |
|
| value | token | Group-value |
Value held by characteristic |
|
| GuidanceResponse TU | ||||
| identifier | token | GuidanceResponse-identifier |
The identifier of the guidance response |
|
| 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 |
|
| HealthcareService TU | ||||
| active | token | HealthcareService-active |
The Healthcare Service is currently marked as active |
|
| category | token | HealthcareService-category |
Service Category of the Healthcare Service |
|
| characteristic | token | HealthcareService-characteristic |
One of the HealthcareService's characteristics |
|
| endpoint | reference | HealthcareService-endpoint |
Technical endpoints providing access to services operated for the location |
|
| identifier | token | HealthcareService-identifier |
External identifiers for this item |
|
| location | reference | HealthcareService-location |
The location of the Healthcare Service |
|
| name | string | HealthcareService-name |
A portion of the Healthcare service name |
|
| organization | reference | HealthcareService-organization |
The organization that provides this Healthcare Service |
|
| programname | string | HealthcareService-programname |
One of the Program Names serviced by this HealthcareService |
|
| type | token | HealthcareService-type |
The type of service provided by this healthcare service |
|
|
|
||||
| accession |
|
ImagingStudy-accession |
|
|
| basedon |
|
ImagingStudy-basedon |
|
|
| bodysite |
|
ImagingStudy-bodysite |
The
|
|
| context |
|
ImagingStudy-context |
|
|
| dicom-class |
|
ImagingStudy-dicom-class |
|
|
| endpoint | reference | ImagingStudy-endpoint |
|
|
| identifier |
|
clinical-identifier |
|
|
| inst-id |
|
ImagingStudy-inst-id |
The instance unique identifier | ImagingStudy.series.instance.identifier |
| modality | token | ImagingStudy-modality |
The
|
|
| patient | reference | clinical-patient |
|
|
| performer |
|
ImagingStudy-performer |
The
|
|
| reason |
|
ImagingStudy-reason |
The
|
|
| series |
|
ImagingStudy-series |
The
|
|
| started |
|
ImagingStudy-started |
|
|
| status | token | ImagingStudy-status |
|
|
| study | token | ImagingStudy-study |
The
|
|
| subject | reference | ImagingStudy-subject |
Who the study is about |
|
| Immunization TU | ||||
| date | date | clinical-date |
|
|
| identifier | token | clinical-identifier |
|
|
| location |
|
Immunization-location |
The
|
|
| lot-number |
|
Immunization-lot-number |
|
|
| manufacturer |
|
Immunization-manufacturer |
|
|
| patient |
|
clinical-patient |
The
|
|
| performer |
reference
|
|
|
|
| reason-code |
|
Immunization-reason-code |
|
|
| reason-reference |
|
Immunization-reason-reference |
|
|
| series |
|
Immunization-series |
The
|
|
| status |
|
Immunization-status |
|
|
| status-reason |
|
Immunization-status-reason |
|
|
| target-disease | token | Immunization-target-disease |
|
|
| vaccine-code |
|
Immunization-vaccine-code |
|
|
| ImmunizationEvaluation TU | ||||
| date | date | ImmunizationEvaluation-date |
|
|
| dose-status |
|
ImmunizationEvaluation-dose-status |
|
|
| identifier |
|
ImmunizationEvaluation-identifier |
|
|
| immunization-event |
|
ImmunizationEvaluation-immunization-event |
|
|
| patient |
|
ImmunizationEvaluation-patient |
|
|
| status | token | ImmunizationEvaluation-status |
Immunization
|
|
| target-disease | token | ImmunizationEvaluation-target-disease |
|
|
| ImmunizationRecommendation TU | ||||
| date | date | ImmunizationRecommendation-date |
Date
|
|
| dose-number |
|
ImmunizationRecommendation-dose-number |
Recommended dose number within series |
|
| dose-sequence |
|
ImmunizationRecommendation-dose-sequence |
|
|
| identifier | token | ImmunizationRecommendation-identifier |
Business identifier |
|
| information | reference | ImmunizationRecommendation-information |
Patient observations supporting recommendation |
|
| patient | reference | ImmunizationRecommendation-patient |
Who this profile is for |
|
| status | token | ImmunizationRecommendation-status |
Vaccine
|
|
| support | reference | ImmunizationRecommendation-support |
Past immunizations supporting recommendation |
|
| target-disease | token | ImmunizationRecommendation-target-disease |
Disease to be immunized against |
|
| vaccine-type | token | ImmunizationRecommendation-vaccine-type |
Vaccine or vaccine group recommendation applies to |
|
| 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 |
|
| depends-on |
|
ImplementationGuide-depends-on |
|
|
| description N | string | conformance-description |
The description of the implementation guide |
|
| experimental | token | ImplementationGuide-experimental |
For testing purposes, not real usage |
|
| 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 |
|
| name N | string | conformance-name |
Computationally friendly name of the implementation guide |
|
| publisher N | string | conformance-publisher |
Name of the publisher of the implementation guide |
|
| resource | reference | ImplementationGuide-resource |
Location of the resource |
|
| status N | token | conformance-status |
The current status of the implementation guide |
|
| 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 |
|
| version N | token | conformance-version |
The business version of the implementation guide |
|
| 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 | Invoice.subject.where(resolve() is Patient) |
| recipient | reference | Invoice-recipient | Recipient of this invoice | Invoice.recipient |
| status | token | Invoice-status | draft | issued | balanced | cancelled | entered-in-error | Invoice.status |
| subject | reference | Invoice-subject | Recipient(s) of goods and services | Invoice.subject |
| totalgross | quantity | Invoice-totalgross | Gross total of this Invoice | Invoice.totalGross |
| totalnet | quantity | Invoice-totalnet | Net total of this Invoice | Invoice.totalNet |
| type | token | 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 |
|
| 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 |
|
| depends-on | reference | Library-depends-on |
What resource is being referenced |
|
| derived-from | reference | Library-derived-from |
What resource is being referenced |
|
| description | string | Library-description |
The description of the library |
|
| effective | date | Library-effective |
The time during which the library is intended to be in use |
|
| identifier | token | Library-identifier |
External identifier for the library |
|
| jurisdiction | token | Library-jurisdiction |
Intended jurisdiction for the library |
|
| name | string | Library-name |
Computationally friendly name of the library |
|
| predecessor | reference | Library-predecessor |
What resource is being referenced |
|
| publisher | string | Library-publisher |
Name of the publisher of the library |
|
| status | token | Library-status |
The current status of the library |
|
| successor | reference | Library-successor |
What resource is being referenced |
|
| title | string | Library-title |
The human-friendly name of the library |
|
| topic | token | Library-topic |
Topics associated with the module |
|
| 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 |
|
| version | token | Library-version |
The business version of the library |
|
| Linkage TU | ||||
| author | reference | Linkage-author |
Author of the Linkage |
|
| item | reference | Linkage-item |
Matches on any item in the Linkage |
|
| source | reference | Linkage-source |
Matches on any item in the Linkage with a type of 'source' |
|
| List TU | ||||
| code | token | clinical-code |
What the purpose of this list is |
|
| date | date | clinical-date |
When the list was prepared |
|
| empty-reason | token | List-empty-reason |
Why list is empty |
|
| encounter | reference | clinical-encounter |
Context in which list created |
|
| identifier | token | clinical-identifier |
Business identifier |
|
| item | reference | List-item |
Actual entry |
|
| notes | string | List-notes |
The annotation - text content (as markdown) |
|
| 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) |
|
| status | token | List-status |
current | retired | entered-in-error |
|
| subject | reference | List-subject |
If all resources have the same subject |
|
| title | string | List-title |
Descriptive name for the list |
|
| Location TU | ||||
| address | string | Location-address |
A (part of the) address of the location |
|
| address-city | string | Location-address-city |
A city specified in an address |
|
| address-country | string | Location-address-country |
A country specified in an address |
|
| address-postalcode | string | Location-address-postalcode |
A postal code specified in an address |
|
| address-state | string | Location-address-state |
A state specified in an address |
|
| address-use | token | Location-address-use |
A use code specified in an address |
|
| endpoint | reference | Location-endpoint |
Technical endpoints providing access to services operated for the location |
|
| identifier | token | Location-identifier |
An identifier for the location |
|
| name | string | Location-name |
A portion of the location's name or alias |
|
| near |
|
Location-near |
Servers
may
search
using
Requires the near-distance parameter to be provided also |
|
|
|
token | Location-operational-status |
Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping) |
|
| organization | reference | Location-organization |
Searches for locations that are managed by the provided organization |
|
| partof | reference | Location-partof |
A location of which this location is a part |
|
| status | token | Location-status |
Searches for locations with a specific kind of status |
|
| type | token | Location-type |
A code for the type of location |
|
| Measure TU | ||||
| composed-of | reference | Measure-composed-of |
What resource is being referenced |
|
| 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 |
|
| depends-on | reference | Measure-depends-on |
What resource is being referenced |
|
| derived-from | reference | Measure-derived-from |
What resource is being referenced |
|
| description | string | Measure-description |
The description of the measure |
|
| effective | date | Measure-effective |
The time during which the measure is intended to be in use |
|
| identifier | token | Measure-identifier |
External identifier for the measure |
|
| jurisdiction | token | Measure-jurisdiction |
Intended jurisdiction for the measure |
|
| name | string | Measure-name |
Computationally friendly name of the measure |
|
| predecessor | reference | Measure-predecessor |
What resource is being referenced |
|
| publisher | string | Measure-publisher |
Name of the publisher of the measure |
|
| status | token | Measure-status |
The current status of the measure |
|
| successor | reference | Measure-successor |
What resource is being referenced |
|
| title | string | Measure-title |
The human-friendly name of the measure |
|
| topic | token | Measure-topic |
Topics
associated
with
the
|
|
| url | uri | Measure-url |
The uri that identifies the measure |
|
| version | token | Measure-version |
The business version of the measure |
|
| 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 |
|
| 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 |
|
| 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 |
|
| context | reference | Media-context |
Encounter / Episode associated with media |
|
| created | date | Media-created |
|
|
| device |
|
Media-device |
|
|
| identifier |
|
Media-identifier |
|
|
| modality | token | Media-modality |
|
|
| operator | reference | Media-operator |
The person who generated the image |
|
| patient | reference | Media-patient |
Who/What this Media is a record of |
|
| site | token | Media-site |
|
|
| status |
|
Media-status |
|
|
| subject |
|
Media-subject |
|
|
| type | token | Media-type |
|
|
| view | token | Media-view |
Imaging view, e.g. Lateral or Antero-posterior |
|
| Medication TU | ||||
| code | token | clinical-code |
Codes that identify this medication |
|
| expiration-date |
|
Medication-expiration-date |
|
|
| form | token | Medication-form |
powder | tablets | capsule + |
|
| ingredient | reference | Medication-ingredient |
The
|
|
| ingredient-code | token |
|
|
|
| lot-number | token | Medication-lot-number |
|
|
| manufacturer | reference | Medication-manufacturer |
|
|
| serial-number | token | Medication-serial-number |
|
|
| status | token | Medication-status |
active | inactive | entered-in-error |
|
| MedicationAdministration TU | ||||
| code | token | clinical-code |
Return administrations of this medication code |
|
| context | reference | MedicationAdministration-context |
Return administrations that share this encounter or episode of care |
|
| device | reference | MedicationAdministration-device |
Return administrations with this administration device identity |
|
| effective-time | date | MedicationAdministration-effective-time |
Date administration happened (or did not happen) |
|
| identifier | token | clinical-identifier |
Return administrations with this external identifier |
|
| medication | reference | medications-medication |
Return administrations of this medication resource |
|
|
|
reference | MedicationAdministration-patient |
The identity of a patient to list administrations for |
|
| performer | reference | MedicationAdministration-performer |
The
|
|
| reason-given |
|
MedicationAdministration-reason-given |
|
|
| reason-not-given | token | MedicationAdministration-reason-not-given |
Reasons for not administering the medication |
|
| request |
|
MedicationAdministration-request |
|
|
| status | token | medications-status |
MedicationAdministration event status (for example one of active/paused/completed/nullified) |
|
| subject | reference | MedicationAdministration-subject |
The
|
|
| MedicationDispense TU | ||||
| code | token | clinical-code |
|
|
| context | reference | MedicationDispense-context |
Returns dispenses with a specific context (episode or episode of care) |
|
| destination | reference | MedicationDispense-destination |
|
|
| identifier | token | clinical-identifier |
|
|
| medication | reference | medications-medication |
|
|
| patient | reference | MedicationDispense-patient |
The identity of a patient to list dispenses for |
|
| performer | reference | MedicationDispense-performer |
|
|
| prescription | reference | medications-prescription |
Multiple Resources:
|
|
| receiver | reference | MedicationDispense-receiver |
The identity of a receiver to list dispenses for |
|
| responsibleparty | reference | MedicationDispense-responsibleparty |
|
|
| status | token | medications-status |
|
|
| subject | reference | MedicationDispense-subject |
The
identity
of
a
patient
for
whom
to
list
dispenses
|
|
| type | token | MedicationDispense-type |
|
|
| whenhandedover | date | MedicationDispense-whenhandedover |
Returns dispenses handed over on this date |
|
| whenprepared | date | MedicationDispense-whenprepared |
Returns dispenses prepared on this date |
|
| 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 |
|
| category | token | MedicationRequest-category |
Returns prescriptions with different categories |
|
| code | token | clinical-code |
Return prescriptions of this medication code |
|
| context | reference | MedicationRequest-context |
Return prescriptions with this encounter or episode of care identifier |
|
| date | date | medications-date |
Multiple Resources:
|
|
| identifier | token | clinical-identifier |
Return prescriptions with this external identifier |
|
| intended-dispenser | reference | MedicationRequest-intended-dispenser |
Returns prescriptions intended to be dispensed by this Organization |
|
| intended-performer | reference | MedicationRequest-intended-performer | Returns the intended performer of the administration of the medication request | MedicationRequest.performer |
| intended-performertype | token | MedicationRequest-intended-performertype | Returns requests for a specific type of performer | MedicationRequest.performerType |
| intent | token | MedicationRequest-intent |
Returns prescriptions with different intents |
|
| medication | reference | medications-medication |
Return
prescriptions
|
|
| patient | reference | MedicationRequest-patient |
Returns prescriptions for a specific patient |
|
| priority | token | MedicationRequest-priority |
Returns prescriptions with different priorities |
|
| requester | reference | MedicationRequest-requester |
Returns prescriptions prescribed by this prescriber |
|
| status | token | medications-status |
Status of the prescription |
|
| subject | reference | MedicationRequest-subject |
The identity of a patient to list orders for |
|
| MedicationStatement TU | ||||
| category | token | MedicationStatement-category |
Returns statements of this category of medicationstatement |
|
| code | token | clinical-code |
Return statements of this medication code |
|
| context | reference | MedicationStatement-context |
Returns statements for a specific context (episode or episode of Care). |
|
| effective | date | MedicationStatement-effective |
Date when patient was taking (or not taking) the medication |
|
| identifier | token | clinical-identifier |
Return statements with this external 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. |
|
| patient | reference | MedicationStatement-patient |
Returns statements for a specific patient. |
|
| source | reference | MedicationStatement-source |
Who or where the information in the statement came from |
|
| status | token | medications-status |
Return statements that match the given status |
|
| subject | reference | MedicationStatement-subject |
The identity of a patient, animal or group to list statements for |
|
| 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 |
|
| 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 |
|
| description N | string | conformance-description |
The description of the message definition |
|
| event | token | MessageDefinition-event |
The event that triggers the message or link to the event definition. |
|
| focus | token | MessageDefinition-focus |
A resource that is a permitted focus of the message |
|
| identifier N | token | conformance-identifier |
External identifier for the message definition |
|
| jurisdiction N | token | conformance-jurisdiction |
Intended jurisdiction for the message definition |
|
| name N | string | conformance-name |
Computationally friendly name of the message definition |
|
| 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 |
|
| status N | token | conformance-status |
The current status of the message definition |
|
| title N | string | conformance-title |
The human-friendly name of the message definition |
|
| url N | uri | conformance-url |
The uri that identifies the message definition |
|
| version N | token | conformance-version |
The business version of the message definition |
|
| MessageHeader TU | ||||
| author | reference | MessageHeader-author |
The source of the decision |
|
| code | token | MessageHeader-code |
ok | transient-error | fatal-error |
|
| destination | string | MessageHeader-destination |
Name of system |
|
| destination-uri | uri | MessageHeader-destination-uri |
Actual destination address or id |
|
| enterer | reference | MessageHeader-enterer |
The source of the data entry |
|
| event | token | MessageHeader-event |
Code for the event this message represents or link to event definition |
|
| focus | reference | MessageHeader-focus |
The actual content of the message |
|
| receiver | reference | MessageHeader-receiver |
Intended
|
|
| response-id | token | MessageHeader-response-id |
Id of original message |
|
| responsible | reference | MessageHeader-responsible |
Final responsibility for event |
|
| sender | reference | MessageHeader-sender |
Real world sender of the message |
|
| source | string | MessageHeader-source |
Name of system |
|
| source-uri | uri | MessageHeader-source-uri |
Actual message source address or id |
|
| target | reference | MessageHeader-target |
Particular delivery destination within the destination |
|
| NamingSystem TU | ||||
| contact | string | NamingSystem-contact |
|
|
| context |
|
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 |
|
conformance-context-type |
|
|
| 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 |
|
| description N | string | conformance-description |
The description of the naming system |
|
| id-type | token | NamingSystem-id-type |
oid | uuid | uri | other |
|
| jurisdiction N | token | conformance-jurisdiction |
Intended jurisdiction for the naming system |
|
| kind | token | NamingSystem-kind |
codesystem | identifier | root |
|
| name N | string | conformance-name |
Computationally friendly name of the naming system |
|
| period | date | NamingSystem-period |
When is identifier valid? |
|
| publisher N | string | conformance-publisher |
Name of the publisher of the naming system |
|
|
|
string | NamingSystem-responsible |
Who maintains system namespace? |
|
| status N | token | conformance-status |
The current status of the naming system |
|
| telecom | token | NamingSystem-telecom |
Contact details for individual or organization |
|
| type | token | NamingSystem-type |
e.g. driver, provider, patient, bank etc. |
|
| value | string | NamingSystem-value |
The unique identifier |
|
| NutritionOrder TU | ||||
| additive | token | NutritionOrder-additive |
Type of module component to add to the feeding |
|
| context |
|
NutritionOrder-context |
Return
nutrition
orders
|
|
| datetime |
|
NutritionOrder-datetime |
Return
nutrition
orders
|
|
| formula | token | NutritionOrder-formula |
Type of enteral or infant formula |
|
| identifier | token | clinical-identifier |
Return nutrition orders with this external 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). |
|
| patient | reference | clinical-patient |
The identity of the person who requires the diet, formula or nutritional supplement |
|
| provider | reference | NutritionOrder-provider |
The
|
|
| status | token | NutritionOrder-status |
Status of the nutrition order. |
|
| supplement | token | NutritionOrder-supplement |
Type of supplement product requested |
|
| Observation N | ||||
| based-on | reference | Observation-based-on |
Reference
to
the
|
|
| category | token | Observation-category |
The classification of the type of observation |
|
| code TU | token | clinical-code |
The code of the observation type |
|
| 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 |
|
| combo-code-value-concept | composite | Observation-combo-code-value-concept |
Code and coded value parameter pair, including in components |
Observation
|
|
| combo-code-value-quantity | composite | Observation-combo-code-value-quantity |
Code and quantity value parameter pair, including in components |
Observation
|
|
| 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. |
|
| 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 |
|
| component-code-value-concept | composite | Observation-component-code-value-concept |
Component code and component coded value parameter pair |
|
| component-code-value-quantity | composite | Observation-component-code-value-quantity |
Component code and component quantity value parameter pair |
|
| 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. |
|
| 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) |
|
|
|
token | Observation-data-absent-reason |
The reason why the expected value in the element Observation.value[x] is missing. |
|
| date TU | date | clinical-date |
Obtained date/time. If the obtained element is a period, a date that falls in the period |
|
| derived-from | reference | Observation-derived-from | Related measurements the observation is made from | Observation.derivedFrom |
| device | reference | Observation-device |
The Device that generated the observation data. |
|
| encounter TU | reference | clinical-encounter |
Encounter related to the observation |
|
| focus TU |
|
Observation-focus |
The
|
|
| has-member |
|
Observation-has-member |
|
|
| identifier TU |
|
clinical-identifier |
The
|
|
| method |
|
Observation-method |
|
|
| part-of |
|
Observation-part-of |
|
|
| patient TU | reference | clinical-patient |
|
|
| performer |
|
Observation-performer |
|
|
| specimen | reference | Observation-specimen |
Specimen used for this observation |
|
| status | token | Observation-status |
The status of the observation |
|
| subject | reference | Observation-subject |
The subject that the observation is about |
|
| 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 |
|
| OperationDefinition N | ||||
| base | reference | OperationDefinition-base |
Marks this as a profile of the base |
|
| code | token | OperationDefinition-code |
Name used to invoke the operation |
|
| context TU | token | conformance-context | A use context assigned to the operation definition | (OperationDefinition.useContext.value as CodeableConcept) |
| context-quantity TU | quantity | conformance-context-quantity | A quantity- or range-valued use context assigned to the operation definition | (OperationDefinition.useContext.value as Quantity) | (OperationDefinition.useContext.value as Range) |
| context-type TU | token | conformance-context-type | A type of use context assigned to the operation definition | OperationDefinition.useContext.code |
| context-type-quantity TU | composite | conformance-context-type-quantity | A use context type and quantity- or range-based value assigned to the operation definition | OperationDefinition.useContext |
| context-type-value TU | composite | conformance-context-type-value | A use context type and value assigned to the operation definition | OperationDefinition.useContext |
| date | date | conformance-date |
The operation definition publication date |
|
| description | string | conformance-description |
The description of the operation definition |
|
| input-profile | reference | OperationDefinition-input-profile | Validation information for in parameters | OperationDefinition.inputProfile |
| instance | token | OperationDefinition-instance |
Invoke on an instance? |
|
| jurisdiction | token | conformance-jurisdiction |
Intended jurisdiction for the operation definition |
|
| kind | token | OperationDefinition-kind |
operation | query |
|
| name | string | conformance-name |
Computationally friendly name of the operation definition |
|
| output-profile | reference | OperationDefinition-output-profile |
|
|
| publisher | string | conformance-publisher |
Name of the publisher of the operation definition |
|
| status | token | conformance-status |
The current status of the operation definition |
|
| system | token | OperationDefinition-system |
Invoke at the system level? |
|
| title | string | conformance-title | The human-friendly name of the operation definition | OperationDefinition.title |
| type | token | OperationDefinition-type |
|
|
| url | uri | conformance-url |
The uri that identifies the operation definition |
|
| version | token | conformance-version |
The business version of the operation definition |
|
| Organization TU | ||||
| active | token | Organization-active |
|
|
| address | string | Organization-address |
A
|
|
| address-city | string | Organization-address-city |
A city specified in an address |
|
| address-country | string | Organization-address-country |
A country specified in an address |
|
| address-postalcode | string | Organization-address-postalcode |
A postal code specified in an address |
|
| address-state | string | Organization-address-state |
A state specified in an address |
|
| address-use | token | Organization-address-use |
A use code specified in an address |
|
| endpoint | reference | Organization-endpoint |
Technical endpoints providing access to services operated for the organization |
|
| identifier | token | Organization-identifier |
Any identifier for the organization (not the accreditation issuer's identifier) |
|
| name | string | Organization-name |
A portion of the organization's name or alias |
|
| partof | reference | Organization-partof |
An organization of which this organization forms a part |
|
| phonetic | string | Organization-phonetic |
A portion of the organization's name using some kind of phonetic matching algorithm |
|
| type | token | Organization-type |
A code for the type of organization |
|
| OrganizationAffiliation TU | ||||
| active | token | OrganizationAffiliation-active | Whether this organization affiliation record is in active use | OrganizationAffiliation.active |
| date | date | OrganizationAffiliation-date | The period during which the participatingOrganization is affiliated with the primary organization | OrganizationAffiliation.period |
| token | OrganizationAffiliation-email | A value in an email contact | OrganizationAffiliation.telecom.where(system='email') | |
| endpoint | reference | OrganizationAffiliation-endpoint | Technical endpoints providing access to services operated for this role | OrganizationAffiliation.endpoint |
| identifier | token | OrganizationAffiliation-identifier | An organization affiliation's Identifier | OrganizationAffiliation.identifier |
| location | reference | OrganizationAffiliation-location | The location(s) at which the role occurs | OrganizationAffiliation.location |
| network | reference | OrganizationAffiliation-network | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) | OrganizationAffiliation.network |
| participating-organization | reference | OrganizationAffiliation-participating-organization | The organization that provides services to the primary organization | OrganizationAffiliation.participatingOrganization |
| phone | token | OrganizationAffiliation-phone | A value in a phone contact | OrganizationAffiliation.telecom.where(system='phone') |
| primary-organization | reference | OrganizationAffiliation-primary-organization | The organization that receives the services from the participating organization | OrganizationAffiliation.organization |
| role | token | OrganizationAffiliation-role | Definition of the role the participatingOrganization plays | OrganizationAffiliation.code |
| service | reference | OrganizationAffiliation-service | Healthcare services provided through the role | OrganizationAffiliation.healthcareService |
| specialty | token | OrganizationAffiliation-specialty | Specific specialty of the participatingOrganization in the context of the role | OrganizationAffiliation.specialty |
| telecom | token | OrganizationAffiliation-telecom | The value in any kind of contact | OrganizationAffiliation.telecom |
| Patient N | ||||
| active | token | Patient-active |
Whether the patient record is 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 |
|
| address-city | string | individual-address-city |
A city specified in an address |
|
| address-country | string | individual-address-country |
A country specified in an address |
|
| address-postalcode | string | individual-address-postalcode |
A postalCode specified in an address |
|
| address-state | string | individual-address-state |
A state specified in an address |
|
| address-use | token | individual-address-use |
A use code specified in an address |
|
|
|
date | individual-birthdate |
The patient's date of birth |
|
| 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 |
|
| token | individual-email |
A value in an email contact |
|
|
| family | string | individual-family |
A portion of the family name of the patient |
|
| gender | token | individual-gender |
Gender of the patient |
|
| general-practitioner | reference | Patient-general-practitioner |
Patient's nominated general practitioner, not the organization that manages the record |
|
| given | string | individual-given |
A portion of the given name of the patient |
|
| identifier | token | Patient-identifier |
A patient identifier |
|
| language | token | Patient-language |
Language code (irrespective of use value) |
|
| link | reference | Patient-link |
All patients linked to the given patient |
|
| 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 |
|
| organization | reference | Patient-organization |
The
organization
|
|
| phone | token | individual-phone |
A value in a phone contact |
|
| phonetic | string | individual-phonetic |
A portion of either family or given name using some kind of phonetic matching algorithm |
|
| telecom | token | individual-telecom |
The value in any kind of telecom details of the patient |
|
| PaymentNotice TU | ||||
| created | date | PaymentNotice-created |
Creation date fro the notice |
|
| identifier | token | PaymentNotice-identifier |
The business identifier of the notice |
|
| payment-status |
|
PaymentNotice-payment-status |
The
|
|
| provider |
|
PaymentNotice-provider |
The
|
|
| request | reference | PaymentNotice-request |
The
|
|
| response | reference | PaymentNotice-response |
The
|
|
| status |
|
PaymentNotice-status |
The
|
|
| statusdate | date | PaymentNotice-statusdate |
The date of the payment action |
|
| PaymentReconciliation TU | ||||
| created | date | PaymentReconciliation-created |
The creation date |
|
| disposition | string | PaymentReconciliation-disposition |
The contents of the disposition message |
|
| identifier | token | PaymentReconciliation-identifier |
The
business
identifier
of
the
|
|
| organization | reference | PaymentReconciliation-organization |
The
organization
|
|
| outcome | token | PaymentReconciliation-outcome |
The processing outcome |
|
| request | reference | PaymentReconciliation-request |
The reference to the claim |
|
| request-provider | reference | PaymentReconciliation-request-provider |
The
|
|
| status |
|
PaymentReconciliation-status |
The
|
|
| 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 |
|
| address-city N | string | individual-address-city |
A city specified in an address |
|
| address-country N | string | individual-address-country |
A country specified in an address |
|
| address-postalcode N | string | individual-address-postalcode |
A postal code specified in an address |
|
| address-state N | string | individual-address-state |
A state specified in an address |
|
| address-use N | token | individual-address-use |
A use code specified in an address |
|
| birthdate N | date | individual-birthdate |
The person's date of birth |
|
| email N | token | individual-email |
A value in an email contact |
|
| gender N | token | individual-gender |
The gender of the person |
|
| identifier | token | Person-identifier |
A person Identifier |
|
| link | reference | Person-link |
Any link has this Patient, Person, RelatedPerson or Practitioner reference |
|
| 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 |
|
| organization | reference | Person-organization |
The organization at which this person record is being managed |
|
| patient | reference | Person-patient |
The Person links to this Patient |
|
| phone N | token | individual-phone |
A value in a phone contact |
|
| phonetic N | string | individual-phonetic |
A portion of name using some kind of phonetic matching algorithm |
|
| 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 |
|
| PlanDefinition TU | ||||
| composed-of | reference | PlanDefinition-composed-of |
What resource is being referenced |
|
| 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 |
|
| 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 |
|
| derived-from | reference | PlanDefinition-derived-from |
What resource is being referenced |
|
| description | string | PlanDefinition-description |
The description of the plan definition |
|
| effective | date | PlanDefinition-effective |
The time during which the plan definition is intended to be in use |
|
| identifier | token | PlanDefinition-identifier |
External identifier for the plan definition |
|
| jurisdiction | token | PlanDefinition-jurisdiction |
Intended jurisdiction for the plan definition |
|
| name | string | PlanDefinition-name |
Computationally friendly name of the plan definition |
|
| predecessor | reference | PlanDefinition-predecessor |
What resource is being referenced |
|
| publisher | string | PlanDefinition-publisher |
Name of the publisher of the plan definition |
|
| status | token | PlanDefinition-status |
The current status of the plan definition |
|
| successor | reference | PlanDefinition-successor |
What resource is being referenced |
|
| title | string | PlanDefinition-title |
The human-friendly name of the plan definition |
|
| topic | token | PlanDefinition-topic |
Topics associated with the module |
|
| 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 |
|
| version | token | PlanDefinition-version |
The business version of the plan definition |
|
| Practitioner TU | ||||
| active | token | Practitioner-active |
Whether the practitioner record is 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 |
|
| address-city N | string | individual-address-city |
A city specified in an address |
|
| address-country N | string | individual-address-country |
A country specified in an address |
|
| address-postalcode N | string | individual-address-postalcode |
A postalCode specified in an address |
|
| address-state N | string | individual-address-state |
A state specified in an address |
|
| address-use N | token | individual-address-use |
A use code specified in an address |
|
| communication | token | Practitioner-communication |
One of the languages that the practitioner can communicate with |
|
| email N | token | individual-email |
A value in an email contact |
|
| family N | string | individual-family |
A portion of the family name |
|
| gender N | token | individual-gender |
Gender of the practitioner |
|
| given N | string | individual-given |
A portion of the given name |
|
| identifier | token | Practitioner-identifier |
A practitioner's 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 |
|
| phone N | token | individual-phone |
A value in a phone contact |
|
| phonetic N | string | individual-phonetic |
A portion of either family or given name using some kind of phonetic matching algorithm |
|
| telecom N | token | individual-telecom |
The value in any kind of contact |
|
| PractitionerRole TU | ||||
| active | token | PractitionerRole-active |
Whether
this
|
|
| date | date | PractitionerRole-date |
The period during which the practitioner is authorized to perform in these role(s) |
|
| email N | token | individual-email |
A value in an email contact |
|
| endpoint | reference | PractitionerRole-endpoint |
Technical endpoints providing access to services operated for the practitioner with this role |
|
| identifier | token | PractitionerRole-identifier |
A practitioner's Identifier |
|
| location | reference | PractitionerRole-location |
One of the locations at which this practitioner provides care |
|
| organization | reference | PractitionerRole-organization |
The identity of the organization the practitioner represents / acts on behalf of |
|
| phone N | token | individual-phone |
A value in a phone contact |
|
| practitioner | reference | PractitionerRole-practitioner |
Practitioner
that
is
able
to
provide
the
defined
services
for
the
|
|
| role | token | PractitionerRole-role |
The practitioner can perform this role at for the organization |
|
| service | reference | PractitionerRole-service |
The list of healthcare services that this worker provides for this role's Organization/Location(s) |
|
| specialty | token | PractitionerRole-specialty |
The practitioner has this specialty at an organization |
|
| telecom N | token | individual-telecom |
The value in any kind of contact |
|
| Procedure TU | ||||
| based-on | reference | Procedure-based-on |
A request for this procedure |
|
| category | token | Procedure-category |
Classification of the procedure |
|
| code | token | clinical-code |
A code to identify a procedure |
|
| context | reference | Procedure-context |
Encounter or episode associated with the procedure |
|
| date | date | clinical-date |
|
|
| encounter | reference |
|
Search by encounter |
|
| identifier | token | clinical-identifier |
A unique identifier for a procedure |
|
|
|
reference |
|
|
|
|
|
|
|
|
|
|
|
reference |
|
Where
the
procedure
|
|
|
|
reference |
|
|
|
| patient | reference |
|
Search by subject - a patient |
|
| performer | reference |
|
|
|
| reason-code | token |
|
|
|
| reason-reference | reference |
|
|
|
|
|
token | Procedure-status |
|
|
| subject | reference | Procedure-subject |
Search by subject |
|
| ProcessRequest TU | ||||
| action | token | ProcessRequest-action |
The action requested by this resource |
|
| identifier | token | ProcessRequest-identifier |
The business identifier of the ProcessRequest |
|
| provider | reference | ProcessRequest-provider |
The
|
|
| status |
|
ProcessRequest-status |
The
|
|
| ProcessResponse TU | ||||
| identifier | token | ProcessResponse-identifier |
The business identifier of the Explanation of Benefit |
|
| organization | reference | ProcessResponse-organization |
The organization who generated this resource |
|
| request | reference | ProcessResponse-request |
The reference to the claim |
|
| request-provider | reference | ProcessResponse-request-provider |
The
|
|
| status |
|
ProcessResponse-status |
The
|
|
| Provenance TU | ||||
| agent | reference | Provenance-agent |
Who participated |
|
| agent-role | token | Provenance-agent-role |
What the agents role was |
|
|
|
token | Provenance-agent-type |
|
|
| entity | reference | Provenance-entity |
Identity of entity |
|
| location | reference | Provenance-location |
Where the activity occurred, if relevant |
|
| patient | reference | Provenance-patient |
Target Reference(s) (usually version specific) |
|
| recorded | date | Provenance-recorded |
When the activity was recorded / updated |
|
| signature-type | token | Provenance-signature-type |
Indication of the reason the entity signed the object(s) |
|
| target |
|
Provenance-target |
|
|
| when |
|
Provenance-when |
|
|
| Questionnaire TU | ||||
| code | token | Questionnaire-code |
A code that corresponds to one of its items in the questionnaire |
|
|
|
|
|
|
|
| context-quantity |
|
Questionnaire-context-quantity |
|
|
| context-type | token | Questionnaire-context-type |
|
|
| context-type-quantity |
|
Questionnaire-context-type-quantity |
|
|
| context-type-value |
|
Questionnaire-context-type-value |
|
|
| date |
|
Questionnaire-date |
|
|
| definition |
|
Questionnaire-definition |
|
|
| description | string | Questionnaire-description |
The
|
|
| effective |
|
Questionnaire-effective |
The
|
|
| identifier | token | Questionnaire-identifier |
|
|
| jurisdiction |
token
|
|
|
|
| name |
|
Questionnaire-name |
|
|
|
|
|
|
|
|
| status | token | Questionnaire-status |
The
|
|
|
|
|
|
|
|
| title |
|
Questionnaire-title |
The
|
|
| url |
|
Questionnaire-url |
The
|
|
| version | token |
|
The
|
|
|
|
||||
| author | reference |
|
|
|
| authored |
|
QuestionnaireResponse-authored |
|
|
| based-on | reference |
|
|
|
| context |
|
QuestionnaireResponse-context |
|
|
| identifier | token |
|
|
|
| part-of | reference |
|
|
|
| patient | reference | QuestionnaireResponse-patient |
The
|
|
| questionnaire | reference |
|
|
|
|
|
|
|
The
|
|
| status | token | QuestionnaireResponse-status |
The
status
of
the
|
|
| subject | reference |
|
The
|
|
| RelatedPerson TU | ||||
| active | token | RelatedPerson-active |
Indicates if the related person record is 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 |
|
| address-city N | string | individual-address-city |
A city specified in an address |
|
| address-country N | string | individual-address-country |
A country specified in an address |
|
| address-postalcode N | string | individual-address-postalcode |
A postal code specified in an address |
|
| address-state N | string | individual-address-state |
A state specified in an address |
|
| address-use N | token | individual-address-use |
A use code specified in an address |
|
| birthdate N | date | individual-birthdate |
The Related Person's date of birth |
|
| email N | token | individual-email |
A value in an email contact |
|
| gender N | token | individual-gender |
Gender of the related person |
|
| identifier | token | RelatedPerson-identifier |
An Identifier of the RelatedPerson |
|
| 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 |
|
| patient | reference | RelatedPerson-patient |
The patient this related person is related to |
|
| phone N | token | individual-phone |
A value in a phone contact |
|
| phonetic N | string | individual-phonetic |
A portion of name using some kind of phonetic matching algorithm |
|
| 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 |
|
| RequestGroup TU | ||||
| author | reference | RequestGroup-author |
The author of the request group |
|
| authored | date | RequestGroup-authored |
The date the request group was authored |
|
| code |
|
RequestGroup-code |
The
|
|
| context | reference | RequestGroup-context |
The
|
|
| encounter | reference | RequestGroup-encounter |
The encounter the request group applies to |
|
| group-identifier | token | RequestGroup-group-identifier |
The group identifier for the request group |
|
| identifier | token | RequestGroup-identifier |
External identifiers for the request group |
|
| 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 |
|
| participant | reference | RequestGroup-participant |
The participant in the requests in the group |
|
| patient | reference | RequestGroup-patient |
The identity of a patient to search for request groups |
|
| priority | token | RequestGroup-priority |
The priority of the request group |
|
| status | token | RequestGroup-status |
The status of the request group |
|
| subject | reference | RequestGroup-subject |
The subject that the request group is about |
|
| ResearchStudy TU | ||||
| category | token | ResearchStudy-category |
Classifications for the study |
|
| date | date | ResearchStudy-date |
When the study began and ended |
|
| focus | token | ResearchStudy-focus |
Drugs,
devices,
|
|
| identifier | token | ResearchStudy-identifier |
Business Identifier for study |
|
| keyword | token | ResearchStudy-keyword |
|
|
| location | token | ResearchStudy-location |
|
|
| partof | reference | ResearchStudy-partof |
Part of larger study |
|
| principalinvestigator | reference | ResearchStudy-principalinvestigator |
|
|
| protocol | reference | ResearchStudy-protocol |
Steps followed in executing study |
|
| site | reference | ResearchStudy-site |
|
|
| sponsor | reference | ResearchStudy-sponsor |
Organization that initiates and is legally responsible for the study |
|
| status | token | ResearchStudy-status |
|
|
| title | string | ResearchStudy-title |
Name for this study |
|
| ResearchSubject TU | ||||
| date | date | ResearchSubject-date |
Start and end of participation |
|
| identifier | token | ResearchSubject-identifier |
Business Identifier for research subject in a study |
|
| individual | reference | ResearchSubject-individual |
Who is part of study |
|
| patient | reference | ResearchSubject-patient |
Who is part of study |
|
| status | token | ResearchSubject-status |
candidate
|
|
|
| study | reference | ResearchSubject-study | Study subject is part of | ResearchSubject.study |
| RiskAssessment TU | ||||
| condition | reference | RiskAssessment-condition |
Condition assessed |
|
| 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 |
|
| method | token | RiskAssessment-method |
Evaluation mechanism |
|
| patient | reference | clinical-patient |
Who/what does assessment apply to? |
|
| performer | reference | RiskAssessment-performer |
Who did assessment? |
|
| probability | number | RiskAssessment-probability |
Likelihood of specified outcome |
|
| risk | token | RiskAssessment-risk |
Likelihood of specified outcome as a qualitative value |
|
| subject | reference | RiskAssessment-subject |
Who/what does assessment apply to? |
|
| Schedule TU | ||||
| active | token | Schedule-active |
Is the schedule in active use |
|
| actor | reference | Schedule-actor |
The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for |
|
| date | date | Schedule-date |
Search for Schedule resources that have a period that contains this date specified |
|
| identifier | token | Schedule-identifier |
A Schedule Identifier |
|
| type | token | Schedule-type |
The type of appointments that can be booked into associated slot(s) |
|
| SearchParameter TU | ||||
| base | token | SearchParameter-base |
The resource type(s) this search parameter applies to |
|
| code | token | SearchParameter-code |
Code used in URL |
|
| component | reference | SearchParameter-component |
Defines how the part works |
|
| 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 |
|
| derived-from |
|
SearchParameter-derived-from |
Original
|
|
| description N | string | conformance-description |
The description of the search parameter |
|
| jurisdiction N | token | conformance-jurisdiction |
Intended jurisdiction for the search parameter |
|
| name N | string | conformance-name |
Computationally friendly name of the search parameter |
|
| publisher N | string | conformance-publisher |
Name of the publisher of the search parameter |
|
| status N | token | conformance-status |
The current status of the search parameter |
|
| target | token | SearchParameter-target |
Types of resource (if a resource reference) |
|
| type | token | SearchParameter-type |
number | date | string | token | reference | composite | quantity | uri | special |
|
| url N | uri | conformance-url |
The uri that identifies the search parameter |
|
| version N | token | conformance-version |
The business version of the search parameter |
|
| Sequence TU | ||||
| chromosome | token | Sequence-chromosome |
Chromosome number of the reference sequence |
|
| 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
|
|
| 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. |
|
| identifier | token | Sequence-identifier |
The unique identity for a particular sequence |
|
| patient | reference | Sequence-patient |
The subject that the observation is about |
|
| 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. |
|
| type | token | Sequence-type |
Amino Acid Sequence/ DNA Sequence / RNA Sequence |
|
|
|
||||
| authored | date | ServiceRequest-authored | Date request signed | ServiceRequest.authoredOn |
| based-on | reference | ServiceRequest-based-on |
What
| ServiceRequest.basedOn |
| body-site | token | ServiceRequest-body-site |
Where
procedure
is
|
|
| category |
|
ServiceRequest-category |
|
|
| code |
|
clinical-code |
What
|
|
| context | reference | ServiceRequest-context |
| ServiceRequest.context |
| encounter | reference | clinical-encounter |
An
encounter
in
which
this
request
is
|
|
| identifier |
|
clinical-identifier |
|
|
| instantiates-canonical |
|
ServiceRequest-instantiates-canonical |
|
|
| instantiates-uri |
|
ServiceRequest-instantiates-uri |
|
|
| intent | token | ServiceRequest-intent |
|
|
| occurrence |
|
ServiceRequest-occurrence |
|
|
| patient | reference | clinical-patient |
|
ServiceRequest.subject.where(resolve()
is
|
| performer | reference | ServiceRequest-performer | Requested performer |
|
| performer-type |
|
ServiceRequest-performer-type |
|
|
| priority | token | ServiceRequest-priority |
|
|
| replaces | reference | ServiceRequest-replaces |
What
|
|
| requester |
|
ServiceRequest-requester |
|
|
| requisition | token | ServiceRequest-requisition |
|
|
| specimen |
|
ServiceRequest-specimen |
|
|
| status | token | ServiceRequest-status |
|
|
| subject | reference | ServiceRequest-subject | Search by subject | ServiceRequest.subject |
| Slot TU | ||||
| identifier | token | Slot-identifier |
A Slot Identifier |
|
| schedule | reference | Slot-schedule |
The Schedule Resource that we are seeking a slot within |
|
| slot-type | token | Slot-slot-type |
The type of appointments that can be booked into the slot |
|
| start | date | Slot-start |
Appointment date/time. |
|
| status | token | Slot-status |
The free/busy status of the appointment |
|
| Specimen TU | ||||
| accession | token | Specimen-accession |
The accession number associated with the specimen |
|
| bodysite | token | Specimen-bodysite |
The code for the body site from where the specimen originated |
|
| collected | date | Specimen-collected |
The date the specimen was collected |
|
| collector | reference | Specimen-collector |
Who collected the specimen |
|
| container | token | Specimen-container |
The kind of specimen container |
|
| container-id | token | Specimen-container-id |
The unique identifier associated with the specimen container |
|
| identifier | token | Specimen-identifier |
The unique identifier associated with the specimen |
|
| parent | reference | Specimen-parent |
The parent of the specimen |
|
| patient | reference | Specimen-patient |
The patient the specimen comes from |
|
| status | token | Specimen-status |
available | unavailable | unsatisfactory | entered-in-error |
|
| subject | reference | Specimen-subject |
The subject of the specimen |
|
| type | token | Specimen-type |
The 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 |
|
| base |
|
StructureDefinition-base |
Definition that this type is constrained/specialized from |
|
| base-path | token | StructureDefinition-base-path |
Path that identifies the base element |
|
| context TU | token | conformance-context |
| (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)
|
|
| context-type TU | token | conformance-context-type | A type of use context assigned to the structure definition |
|
| 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 |
|
| derivation | token | StructureDefinition-derivation |
specialization | constraint - How relates to base definition |
|
| description | string | conformance-description |
The description of the structure definition |
|
| experimental | token | StructureDefinition-experimental |
For testing purposes, not real usage |
|
| ext-context |
|
StructureDefinition-ext-context |
|
|
| identifier | token | conformance-identifier |
External identifier for the structure definition |
|
| jurisdiction | token | conformance-jurisdiction |
Intended jurisdiction for the structure definition |
|
| keyword | token | StructureDefinition-keyword |
A
code
for
the
|
|
| kind | token | StructureDefinition-kind |
primitive-type | complex-type | resource | logical |
|
| name | string | conformance-name |
Computationally friendly name of the structure definition |
|
| path | token | StructureDefinition-path |
A
path
that
is
constrained
in
the
|
|
| publisher | string | conformance-publisher |
Name of the publisher of the structure definition |
|
| status | token | conformance-status |
The current status of the structure definition |
|
| title | string | conformance-title |
The human-friendly name of the structure definition |
|
| type |
|
StructureDefinition-type |
Type defined or constrained by this structure |
|
| url | uri | conformance-url |
The uri that identifies the structure definition |
|
| valueset | reference | StructureDefinition-valueset |
A vocabulary binding reference |
|
| version | token | conformance-version |
The business version of the structure definition |
|
| 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 |
|
| description N | string | conformance-description |
The description of the structure map |
|
| identifier N | token | conformance-identifier |
External identifier for the structure map |
|
| jurisdiction N | token | conformance-jurisdiction |
Intended jurisdiction for the structure map |
|
| name N | string | conformance-name |
Computationally friendly name of the structure map |
|
| publisher N | string | conformance-publisher |
Name of the publisher of the structure map |
|
| status N | token | conformance-status |
The current status of the structure map |
|
| title N | string | conformance-title |
The human-friendly name of the structure map |
|
| url N | uri | conformance-url |
The uri that identifies the structure map |
|
| version N | token | conformance-version |
The business version of the structure map |
|
| Subscription TU | ||||
| add-tag | token | Subscription-add-tag |
A tag to be added to the resource matching the criteria |
|
| contact | token | Subscription-contact |
Contact details for the subscription |
|
| criteria | string | Subscription-criteria |
The search rules used to determine when to send a notification |
|
| payload | string | Subscription-payload |
The mime-type of the notification payload |
|
| status | token | Subscription-status |
The current state of the subscription |
|
| type | token | Subscription-type |
The type of channel for the sent notifications |
|
| url | uri | Subscription-url |
The uri that will receive the notifications |
|
| Substance TU | ||||
| category | token | Substance-category |
The category of the substance |
|
| code | token | Substance-code |
The code of the substance or ingredient |
|
| container-identifier | token | Substance-container-identifier |
Identifier of the package/container |
|
| expiry | date | Substance-expiry |
Expiry date of package or container of substance |
|
| identifier | token | Substance-identifier |
Unique identifier for the substance |
|
| quantity | quantity | Substance-quantity |
Amount of substance in the package |
|
| status | token | Substance-status |
active | inactive | entered-in-error |
|
| substance-reference | reference | Substance-substance-reference |
A component of the substance |
|
| SupplyDelivery TU | ||||
| identifier | token | clinical-identifier |
External identifier |
|
| patient | reference | clinical-patient |
Patient for whom the item is supplied |
|
| receiver | reference | SupplyDelivery-receiver |
Who collected the Supply |
|
| status | token | SupplyDelivery-status |
in-progress | completed | abandoned | entered-in-error |
|
| supplier | reference | SupplyDelivery-supplier |
Dispenser |
|
| SupplyRequest TU | ||||
| category | token | SupplyRequest-category |
The kind of supply (central, non-stock, etc.) |
|
| date | date | clinical-date |
When the request was made |
|
| identifier | token | clinical-identifier |
Unique identifier |
|
| requester | reference | SupplyRequest-requester |
Individual making the request |
|
| status | token | SupplyRequest-status |
draft | active | suspended + |
|
| supplier | reference | SupplyRequest-supplier |
Who is intended to fulfill the request |
|
| Task TU | ||||
| authored-on | date | Task-authored-on |
Search by creation date |
|
| based-on | reference | Task-based-on |
Search by requests this task is based on |
|
| business-status | token | Task-business-status |
Search by business status |
|
| code | token | Task-code |
Search by task code |
|
| context | reference | Task-context |
Search by encounter or episode |
|
| focus | reference | Task-focus |
Search by task focus |
|
| group-identifier | token | Task-group-identifier |
Search by group identifier |
|
| identifier | token | Task-identifier |
Search for a task instance by its business identifier |
|
| intent | token | Task-intent |
Search by task intent |
|
| modified | date | Task-modified |
Search by last modification date |
|
| owner | reference |
|
Search by task owner |
|
| part-of | reference | Task-part-of |
Search by task this task is part of |
|
| patient | reference | Task-patient |
Search by patient |
|
| performer | token | Task-performer |
Search by recommended type of performer (e.g., Requester, Performer, Scheduler). |
|
| period | date | Task-period |
Search by period Task is/was underway |
|
| priority | token | Task-priority |
Search by task priority |
|
| requester | reference | Task-requester |
Search by task requester |
|
| status | token | Task-status |
Search by task status |
|
| subject | reference | Task-subject |
Search by subject |
|
| 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 |
|
| issued | date | TestReport-issued |
The test report generation date |
|
| participant | uri | TestReport-participant |
The reference to a participant in the test execution |
|
| result | token | TestReport-result |
The result disposition of the test execution |
|
| tester | string | TestReport-tester |
The name of the testing organization |
|
| testscript | reference | TestReport-testscript |
The test script executed to produce this report |
|
| 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 |
|
| description | string | TestScript-description |
The description of the test script |
|
| identifier | token | TestScript-identifier |
External identifier for the test script |
|
| jurisdiction | token | TestScript-jurisdiction |
Intended jurisdiction for the test script |
|
| name | string | TestScript-name |
Computationally friendly name of the test script |
|
| publisher | string | TestScript-publisher |
Name of the publisher of the test script |
|
| status | token | TestScript-status |
The current status of the test script |
|
| testscript-capability | string | TestScript-testscript-capability |
TestScript required and validated capability |
|
| title | string | TestScript-title |
The human-friendly name of the test script |
|
| url | uri | TestScript-url |
The uri that identifies the test script |
|
| version | token | TestScript-version |
The business version of the test script |
|
| 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 | UserSession.focus.where(resolve() is Patient) |
| 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 |
|
| description | string | conformance-description |
The description of the value set |
|
| expansion | uri | ValueSet-expansion |
|
|
| identifier | token | conformance-identifier |
External identifier for the value set |
|
| jurisdiction | token | conformance-jurisdiction |
Intended jurisdiction for the value set |
|
| name | string | conformance-name |
Computationally friendly name of the value set |
|
| publisher | string | conformance-publisher |
Name of the publisher of the value set |
|
| reference | uri | ValueSet-reference |
A code system included or excluded in the value set or an imported value set |
|
| status | token | conformance-status |
The current status of the value set |
|
| title | string | conformance-title |
The human-friendly name of the value set |
|
| url | uri | conformance-url |
The uri that identifies the value set |
|
| version | token | conformance-version |
The business version of the value set |
|
| 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 |
|
| encounter | reference | clinical-encounter |
Return prescriptions with this encounter identifier |
|
| identifier | token | clinical-identifier |
Return prescriptions with this external identifier |
|
| patient | reference | clinical-patient |
The identity of a patient to list dispenses for |
|
| prescriber | reference | VisionPrescription-prescriber |
Who authorizes the vision product |
|
| status | token | VisionPrescription-status | The status of the vision prescription | VisionPrescription.status |
®©
HL7.org
2011+.
FHIR
Release
3
(STU;
v3.0.2-11200)
Mixed
Nomative/Trial
Use
Ballot
#2
(v3.5.0-14907)
generated
on
Thurs,
Oct
24,
2019
11:53+1100.
Sun,
Aug
19,
2018
21:54+1000.
QA
Page
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
|
Compare
to
DSTU2
DSTU3
|
Ballot
Comparison
|
|
Propose
a
change