STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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 GroupMaturity Level: N/ABallot Status: STU 3

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.

Parameter Type Description Paths
Resource
_contentstring

Search on the entire content of the resource

_idtoken

Logical id of this artifact

Resource.id
_lastUpdateddate

When the resource version last changed

Resource.meta.lastUpdated
_profileuri

Profiles this resource claims to conform to

Resource.meta.profile
_querytoken

A custom search profile that describes a specific defined query operation

_securitytoken

Security Labels applied to this resource

Resource.meta.security
_tagtoken

Tags applied to this resource

Resource.meta.tag
DomainResource
_textstring

Search on the narrative of the resource

Common Search Parameters
address string

Multiple Resources:

  • RelatedPerson: A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text
  • Practitioner: A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text
  • Person: A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text
  • Patient: A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text
RelatedPerson.address | Practitioner.address | Person.address | Patient.address
address-city string

Multiple Resources:

RelatedPerson.address.city | Practitioner.address.city | Person.address.city | Patient.address.city
address-country string

Multiple Resources:

RelatedPerson.address.country | Practitioner.address.country | Person.address.country | Patient.address.country
address-postalcode string

Multiple Resources:

  • RelatedPerson: A postal code specified in an address
  • Practitioner: A postalCode specified in an address
  • Person: A postal code specified in an address
  • Patient: A postalCode specified in an address
RelatedPerson.address.postalCode | Practitioner.address.postalCode | Person.address.postalCode | Patient.address.postalCode
address-state string

Multiple Resources:

RelatedPerson.address.state | Practitioner.address.state | Person.address.state | Patient.address.state
address-use token

Multiple Resources:

RelatedPerson.address.use | Practitioner.address.use | Person.address.use | Patient.address.use
birthdate date

Multiple Resources:

RelatedPerson.birthDate | Person.birthDate | Patient.birthDate
code token

Multiple Resources:

Medication.code | MedicationRequest.medication.as(CodeableConcept) | MedicationAdministration.medication.as(CodeableConcept) | MedicationStatement.medication.as(CodeableConcept) | MedicationDispense.medication.as(CodeableConcept)
code token

Multiple Resources:

FamilyMemberHistory.condition.code | AllergyIntolerance.code | AllergyIntolerance.reaction.substance | Procedure.code | List.code | DiagnosticRequest.code | DeviceUseRequest.device.as(CodeableConcept) | Observation.code | Observation.component.code | DiagnosticReport.code | Condition.code
date date

Multiple Resources:

ReferralRequest.authored | Consent.dateTime | SupplyRequest.date | RiskAssessment.occurrence.as(DateTime) | CareTeam.period | FamilyMemberHistory.date | Encounter.period | AllergyIntolerance.assertedDate | CarePlan.period | EpisodeOfCare.period | Procedure.performed | List.date | Immunization.date | Flag.period | Observation.effective | DiagnosticReport.effective | Composition.date | DetectedIssue.date | ClinicalImpression.date
email token

Multiple Resources:

PractitionerRole.telecom.where(system='email') | RelatedPerson.telecom.where(system='email') | Practitioner.telecom.where(system='email') or Practitioner.role.telecom.where(system='email') | Person.telecom.where(system='email') | Patient.telecom.where(system='email')
encounter reference

Multiple Resources:

DocumentReference.context.encounter | RiskAssessment.context | Procedure.encounter | List.encounter | DiagnosticRequest.context | VisionPrescription.encounter | ProcedureRequest.encounter | DeviceUseRequest.context | Flag.encounter | Observation.encounter | DiagnosticReport.encounter | NutritionRequest.encounter | Composition.encounter
family string

Multiple Resources:

  • Practitioner: A portion of the family name
  • Patient: A portion of the family name of the patient
Practitioner.name.family | Patient.name.family
gender token

Multiple Resources:

RelatedPerson.gender | Practitioner.gender | Person.gender | Patient.gender
given string

Multiple Resources:

  • Practitioner: A portion of the given name
  • Patient: A portion of the given name of the patient
Practitioner.name.given | Patient.name.given
identifier token

Multiple Resources:

DocumentManifest.masterIdentifier | DocumentManifest.identifier | Goal.identifier | Consent.identifier | DocumentReference.masterIdentifier | DocumentReference.identifier | SupplyRequest.identifier | RiskAssessment.identifier | CareTeam.identifier | ImagingStudy.identifier | FamilyMemberHistory.identifier | Encounter.identifier | AllergyIntolerance.identifier | CarePlan.identifier | EpisodeOfCare.identifier | Procedure.identifier | List.identifier | DiagnosticRequest.identifier | Immunization.identifier | VisionPrescription.identifier | ProcedureRequest.identifier | DeviceUseRequest.identifier | Observation.identifier | DiagnosticReport.identifier | NutritionRequest.identifier | Condition.identifier | Composition.identifier | DetectedIssue.identifier | SupplyDelivery.identifier
identifier token

Multiple Resources:

MedicationRequest.identifier | MedicationAdministration.identifier | MedicationStatement.identifier | MedicationDispense.identifier
medication reference

Multiple Resources:

MedicationRequest.medication.as(Reference) | MedicationAdministration.medication.as(Reference) | MedicationStatement.medication.as(Reference) | MedicationDispense.medication.as(Reference)
patient reference

Multiple Resources:

ReferralRequest.patient | DocumentManifest.subject | Goal.subject | Consent.patient | DocumentReference.subject | ImagingManifest.patient | SupplyRequest.patient | RiskAssessment.subject | CareTeam.subject | ImagingStudy.patient | FamilyMemberHistory.patient | Encounter.patient | DeviceUseStatement.subject | AllergyIntolerance.patient | CarePlan.subject | EpisodeOfCare.patient | Procedure.subject | List.subject | DiagnosticRequest.subject | Immunization.patient | VisionPrescription.patient | ProcedureRequest.subject | DeviceUseRequest.subject | Flag.subject | Observation.subject | DiagnosticReport.subject | NutritionRequest.patient | Condition.subject | Composition.subject | DetectedIssue.patient | SupplyDelivery.patient | ClinicalImpression.subject
patient reference

Multiple Resources:

MedicationRequest.patient | MedicationAdministration.patient | MedicationDispense.patient
phone token

Multiple Resources:

PractitionerRole.telecom.where(system='phone') | RelatedPerson.telecom.where(system='phone') | Practitioner.telecom.where(system='phone') or Practitioner.role.telecom.where(system='phone') | Person.telecom.where(system='phone') | Patient.telecom.where(system='phone')
phonetic string

Multiple Resources:

  • RelatedPerson: A portion of name using some kind of phonetic matching algorithm
  • Practitioner: A portion of either family or given name using some kind of phonetic matching algorithm
  • Person: A portion of name using some kind of phonetic matching algorithm
  • Patient: A portion of either family or given name using some kind of phonetic matching algorithm
RelatedPerson.name | Practitioner.name | Person.name | Patient.name
prescription reference

Multiple Resources:

MedicationAdministration.prescription | MedicationDispense.authorizingPrescription
status token

Multiple Resources:

MedicationRequest.status | MedicationAdministration.status | MedicationStatement.status | MedicationDispense.status
telecom token

Multiple Resources:

PractitionerRole.telecom | RelatedPerson.telecom | Practitioner.telecom | Practitioner.role.telecom | Person.telecom | Patient.telecom
type token

Multiple Resources:

ReferralRequest.type | DocumentManifest.type | DocumentReference.type | Encounter.type | AllergyIntolerance.type | EpisodeOfCare.type | Composition.type
Account
balancequantity

How much is in account?

Account.balance
identifiertoken

Account number

Account.identifier
namestring

Human-readable label

Account.name
ownerreference

Who is responsible?

Account.owner
patientreference

What is account tied to?

Account.subject
perioddate

Transaction window

Account.coveragePeriod
statustoken

active | inactive | entered-in-error

Account.status
subjectreference

What is account tied to?

Account.subject
typetoken

E.g. patient, expense, depreciation

Account.type
ActivityDefinition
datedate

The activity definition publication date

ActivityDefinition.date
descriptionstring

Text search against the description of the activity definition

ActivityDefinition.description
effectivedate

Effective time associated with the activity definition

ActivityDefinition.effectivePeriod
identifiertoken

External identifiers for the activity definition

ActivityDefinition.identifier
jurisdictiontoken

Intended jurisdiction for activity definition

ActivityDefinition.jurisdiction
namestring

Name of the activity definition

ActivityDefinition.name
publisherstring

Name of the publisher of the activity definition

ActivityDefinition.publisher
statustoken

The current status of the activity definition

ActivityDefinition.status
titlestring

Text search against the title of the activity definition

ActivityDefinition.title
topictoken

Topics associated with the module

ActivityDefinition.topic
urluri

The uri that identifies the activity definition

ActivityDefinition.url
versiontoken

The version identifier of the activity definition

ActivityDefinition.version
AllergyIntolerance
asserterreference

Source of the information about the allergy

AllergyIntolerance.asserter
categorytoken

food | medication | biologic | environment

AllergyIntolerance.category
clinical-statustoken

active | inactive | resolved

AllergyIntolerance.clinicalStatus
codetoken

Allergy or intolerance code

AllergyIntolerance.code | AllergyIntolerance.reaction.substance
criticalitytoken

low | high | unable-to-assess

AllergyIntolerance.criticality
datedate

Date record was believed accurate

AllergyIntolerance.assertedDate
identifiertoken

External ids for this item

AllergyIntolerance.identifier
last-datedate

Date(/time) of last known occurrence of a reaction

AllergyIntolerance.lastOccurrence
manifestationtoken

Clinical symptoms/signs associated with the Event

AllergyIntolerance.reaction.manifestation
onsetdate

Date(/time) when manifestations showed

AllergyIntolerance.reaction.onset
patientreference

Who the sensitivity is for

AllergyIntolerance.patient
recorderreference

Who recorded the sensitivity

AllergyIntolerance.recorder
routetoken

How the subject was exposed to the substance

AllergyIntolerance.reaction.exposureRoute
severitytoken

mild | moderate | severe (of event as a whole)

AllergyIntolerance.reaction.severity
typetoken

allergy | intolerance - Underlying mechanism (if known)

AllergyIntolerance.type
verification-statustoken

unconfirmed | confirmed | refuted | entered-in-error

AllergyIntolerance.verificationStatus
Appointment
actorreference

Any one of the individuals participating in the appointment

Appointment.participant.actor
appointment-typetoken

The style of appointment or patient that has been booked in the slot (not service type)

Appointment.appointmentType
datedate

Appointment date/time.

Appointment.start
identifiertoken

An Identifier of the Appointment

Appointment.identifier
locationreference

This location is listed in the participants of the appointment

Appointment.participant.actor
part-statustoken

The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests.

Appointment.participant.status
patientreference

One of the individuals of the appointment is this patient

Appointment.participant.actor
practitionerreference

One of the individuals of the appointment is this practitioner

Appointment.participant.actor
service-typetoken

The specific service that is to be performed during this appointment

Appointment.serviceType
statustoken

The overall status of the appointment

Appointment.status
AppointmentResponse
actorreference

The Person, Location/HealthcareService or Device that this appointment response replies for

AppointmentResponse.actor
appointmentreference

The appointment that the response is attached to

AppointmentResponse.appointment
identifiertoken

An Identifier in this appointment response

AppointmentResponse.identifier
locationreference

This Response is for this Location

AppointmentResponse.actor
part-statustoken

The participants acceptance status for this appointment

AppointmentResponse.participantStatus
patientreference

This Response is for this Patient

AppointmentResponse.actor
practitionerreference

This Response is for this Practitioner

AppointmentResponse.actor
AuditEvent
actiontoken

Type of action performed during the event

AuditEvent.action
addressstring

Identifier for the network access point of the user device

AuditEvent.agent.network.address
agentreference

Direct reference to resource

AuditEvent.agent.reference
agent-namestring

Human-meaningful name for the agent

AuditEvent.agent.name
altidtoken

Alternative User id e.g. authentication

AuditEvent.agent.altId
datedate

Time when the event occurred on source

AuditEvent.recorded
entityreference

Specific instance of resource

AuditEvent.entity.reference
entity-idtoken

Specific instance of object

AuditEvent.entity.identifier
entity-namestring

Descriptor for entity

AuditEvent.entity.name
entity-typetoken

Type of entity involved

AuditEvent.entity.type
outcometoken

Whether the event succeeded or failed

AuditEvent.outcome
patientreference

Direct reference to resource

AuditEvent.agent.reference | AuditEvent.entity.reference
policyuri

Policy that authorized event

AuditEvent.agent.policy
roletoken

What role the entity played

AuditEvent.entity.role
sitetoken

Logical source location within the enterprise

AuditEvent.source.site
sourcetoken

The identity of source detecting the event

AuditEvent.source.identifier
subtypetoken

More specific type/id for the event

AuditEvent.subtype
typetoken

Type/identifier of event

AuditEvent.type
usertoken

Unique identifier for the user

AuditEvent.agent.userId
Basic
authorreference

Who created

Basic.author
codetoken

Kind of Resource

Basic.code
createddate

When created

Basic.created
identifiertoken

Business identifier

Basic.identifier
patientreference

Identifies the focus of this resource

Basic.subject
subjectreference

Identifies the focus of this resource

Basic.subject
Binary
contenttypetoken

MimeType of the binary content

Binary.contentType
BodySite
codetoken

Named anatomical location

BodySite.code
identifiertoken

Identifier for this instance of the anatomical location

BodySite.identifier
patientreference

Patient to whom bodysite belongs

BodySite.patient
Bundle
compositionreference

The first resource in the bundle, if the bundle type is "document" - this is a composition, and this parameter provides access to searches its contents

Bundle.entry[0].resource
identifiertoken

Persistent identifier for the bundle

Bundle.identifier
messagereference

The first resource in the bundle, if the bundle type is "message" - this is a message header, and this parameter provides access to search its contents

Bundle.entry[0].resource
typetoken

document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection

Bundle.type
CapabilityStatement
datedate

The capability statement publication date

CapabilityStatement.date
descriptionstring

Text search against the description of the capability statement

CapabilityStatement.description
eventtoken

Event code in a capability statement

CapabilityStatement.messaging.event.code
fhirversiontoken

The version of FHIR

CapabilityStatement.version
formattoken

formats supported (xml | json | ttl | mime type)

CapabilityStatement.format
guideuri

Implementation Guide supported

CapabilityStatement.implementationGuide
jurisdictiontoken

Intended jurisdiction for capability statement

CapabilityStatement.jurisdiction
modetoken

Mode - restful (server/client) or messaging (sender/receiver)

CapabilityStatement.rest.mode
namestring

Name of the capability statement

CapabilityStatement.name
publisherstring

Name of the publisher of the capability statement

CapabilityStatement.publisher
resourcetoken

Name of a resource mentioned in a capability statement

CapabilityStatement.rest.resource.type
resourceprofilereference

A profile id invoked in a capability statement

CapabilityStatement.rest.resource.profile
securityservicetoken

OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates

CapabilityStatement.rest.security.service
softwarestring

Part of a the name of a software application

CapabilityStatement.software.name
statustoken

The current status of the capability statement

CapabilityStatement.status
supported-profilereference

Profiles for use cases supported

CapabilityStatement.profile
titlestring

Text search against the title of the capability statement

CapabilityStatement.title
urluri

The uri that identifies the capability statement

CapabilityStatement.url
versiontoken

The version identifier of the capability statement

CapabilityStatement.version
CarePlan
activitycodetoken

Detail type of activity

CarePlan.activity.detail.code
activitydatedate

Specified date occurs within period specified by CarePlan.activity.timingSchedule

CarePlan.activity.detail.scheduled
activityreferencereference

Activity details defined in specific resource

CarePlan.activity.reference
careteamreference

Who's involved in plan?

CarePlan.careTeam
categorytoken

Type of plan

CarePlan.category
conditionreference

Health issues this plan addresses

CarePlan.addresses
datedate

Time period plan covers

CarePlan.period
goalreference

Desired outcome of plan

CarePlan.goal
identifiertoken

External Ids for this plan

CarePlan.identifier
patientreference

Who care plan is for

CarePlan.subject
performerreference

Matches if the practitioner is listed as a performer in any of the "simple" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)

CarePlan.activity.detail.performer
relatedcomposite

A combination of the type of relationship and the related plan

CarePlan.relatedPlan
relatedcodetoken

includes | replaces | fulfills

CarePlan.relatedPlan.code
relatedplanreference

Plan relationship exists with

CarePlan.relatedPlan.plan
subjectreference

Who care plan is for

CarePlan.subject
CareTeam
categorytoken

Type of team

CareTeam.category
datedate

Time period team covers

CareTeam.period
identifiertoken

External Ids for this team

CareTeam.identifier
participantreference

Who is involved

CareTeam.participant.member
patientreference

Who care team is for

CareTeam.subject
statustoken

active | suspended | inactive | entered in error

CareTeam.status
subjectreference

Who care team is for

CareTeam.subject
Claim
createddate

The creation date for the Claim

Claim.created
facilityreference

Facility responsible for the goods and services

Claim.facility
identifiertoken

The primary identifier of the financial resource

Claim.identifier
insurerreference

The target payor/insurer for the Claim

Claim.insurer
organizationreference

The reference to the providing organization

Claim.organization
patientreference

Patient receiving the services

Claim.patient
prioritytoken

Processing priority requested

Claim.priority
providerreference

Provider responsible for the Claim

Claim.provider
usetoken

The kind of financial resource

Claim.use
ClaimResponse
createddate

The creation date

ClaimResponse.created
dispositionstring

The contents of the disposition message

ClaimResponse.disposition
identifiertoken

The identity of the claimresponse

ClaimResponse.identifier
insurerreference

The organization who generated this resource

ClaimResponse.insurer
outcometoken

The processing outcome

ClaimResponse.outcome
payment-datedate

The expected paymentDate

ClaimResponse.payment.date
requestreference

The claim reference

ClaimResponse.request
ClinicalImpression
actionreference

Action taken as part of assessment procedure

ClinicalImpression.action
assessorreference

The clinician performing the assessment

ClinicalImpression.assessor
contextreference

Encounter or Episode created from

ClinicalImpression.context
datedate

When the assessment was documented

ClinicalImpression.date
finding-codetoken

What was found

ClinicalImpression.finding.item.as(CodeableConcept)
finding-refreference

What was found

ClinicalImpression.finding.item.as(Reference)
investigationreference

Record of a specific investigation

ClinicalImpression.investigation.item
patientreference

Patient or group assessed

ClinicalImpression.subject
previousreference

Reference to last assessment

ClinicalImpression.previous
problemreference

Relevant impressions of patient state

ClinicalImpression.problem
statustoken

draft | completed | entered-in-error

ClinicalImpression.status
subjectreference

Patient or group assessed

ClinicalImpression.subject
CodeSystem
codetoken

A code defined in the code system

CodeSystem.concept.code
contenttoken

not-present | examplar | fragment | complete

CodeSystem.content
datedate

The code system publication date

CodeSystem.date
descriptionstring

Text search against the description of the code system

CodeSystem.description
identifiertoken

External identifiers for the code system

CodeSystem.identifier
jurisdictiontoken

Intended jurisdiction for code system

CodeSystem.jurisdiction
languagetoken

A language in which a designation is provided

CodeSystem.concept.designation.language
namestring

Name of the code system

CodeSystem.name
publisherstring

Name of the publisher of the code system

CodeSystem.publisher
statustoken

The current status of the code system

CodeSystem.status
systemuri

The system for any codes defined by this code system (same as 'url')

CodeSystem.url
titlestring

Text search against the title of the code system

CodeSystem.title
urluri

The uri that identifies the code system

CodeSystem.url
versiontoken

The version identifier of the code system

CodeSystem.version
Communication
based-onreference

Request fulfilled by this communication

Communication.basedOn
categorytoken

Message category

Communication.category
contextreference

Encounter or episode leading to message

Communication.context
identifiertoken

Unique identifier

Communication.identifier
mediumtoken

A channel of communication

Communication.medium
patientreference

Focus of message

Communication.subject
receiveddate

When received

Communication.received
recipientreference

Message recipient

Communication.recipient
senderreference

Message sender

Communication.sender
sentdate

When sent

Communication.sent
statustoken

in-progress | completed | suspended | rejected | failed

Communication.status
subjectreference

Focus of message

Communication.subject
CommunicationRequest
categorytoken

Message category

CommunicationRequest.category
contextreference

Encounter or episode leading to message

CommunicationRequest.context
identifiertoken

Unique identifier

CommunicationRequest.identifier
mediumtoken

A channel of communication

CommunicationRequest.medium
patientreference

Focus of message

CommunicationRequest.subject
prioritytoken

Message urgency

CommunicationRequest.priority
recipientreference

Message recipient

CommunicationRequest.recipient
requesteddate

When ordered or proposed

CommunicationRequest.requestedOn
requesterreference

An individual who requested a communication

CommunicationRequest.requester
senderreference

Message sender

CommunicationRequest.sender
statustoken

proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed

CommunicationRequest.status
subjectreference

Focus of message

CommunicationRequest.subject
timedate

When scheduled

CommunicationRequest.scheduled.as(DateTime)
CompartmentDefinition
codetoken

Patient | Encounter | RelatedPerson | Practitioner | Device

CompartmentDefinition.code
datedate

The compartment definition publication date

CompartmentDefinition.date
descriptionstring

Text search against the description of the compartment definition

CompartmentDefinition.description
jurisdictiontoken

Intended jurisdiction for compartment definition

CompartmentDefinition.jurisdiction
namestring

Name of the compartment definition

CompartmentDefinition.name
publisherstring

Name of the publisher of the compartment definition

CompartmentDefinition.publisher
resourcetoken

Name of resource type

CompartmentDefinition.resource.code
statustoken

The current status of the compartment definition

CompartmentDefinition.status
titlestring

Text search against the title of the compartment definition

CompartmentDefinition.title
urluri

The uri that identifies the compartment definition

CompartmentDefinition.url
Composition
attesterreference

Who attested the composition

Composition.attester.party
authorreference

Who and/or what authored the composition

Composition.author
classtoken

Categorization of Composition

Composition.class
confidentialitytoken

As defined by affinity domain

Composition.confidentiality
contexttoken

Code(s) that apply to the event being documented

Composition.event.code
datedate

Composition editing time

Composition.date
encounterreference

Context of the Composition

Composition.encounter
entryreference

A reference to data that supports this section

Composition.section.entry
identifiertoken

Logical identifier of composition (version-independent)

Composition.identifier
patientreference

Who and/or what the composition is about

Composition.subject
perioddate

The period covered by the documentation

Composition.event.period
sectiontoken

Classification of section (recommended)

Composition.section.code
statustoken

preliminary | final | amended | entered-in-error

Composition.status
subjectreference

Who and/or what the composition is about

Composition.subject
titlestring

Human Readable name/title

Composition.title
typetoken

Kind of composition (LOINC if possible)

Composition.type
ConceptMap
datedate

The concept map publication date

ConceptMap.date
dependsonuri

Reference to property mapping depends on

ConceptMap.group.element.target.dependsOn.property
descriptionstring

Text search against the description of the concept map

ConceptMap.description
identifiertoken

External identifiers for the concept map

ConceptMap.identifier
jurisdictiontoken

Intended jurisdiction for concept map

ConceptMap.jurisdiction
namestring

Name of the concept map

ConceptMap.name
producturi

Reference to property mapping depends on

ConceptMap.group.element.target.product.property
publisherstring

Name of the publisher of the concept map

ConceptMap.publisher
sourcereference

Identifies the source of the concepts which are being mapped

ConceptMap.source.as(Reference)
source-codetoken

Identifies element being mapped

ConceptMap.group.element.code
source-systemuri

Code System (if value set crosses code systems)

ConceptMap.group.source
source-urireference

Identifies the source of the concepts which are being mapped

ConceptMap.source.as(Uri)
statustoken

The current status of the concept map

ConceptMap.status
targetreference

Provides context to the mappings

ConceptMap.target.as(Reference)
target-codetoken

Code that identifies the target element

ConceptMap.group.element.target.code
target-systemuri

System of the target (if necessary)

ConceptMap.group.target
target-urireference

Provides context to the mappings

ConceptMap.target.as(Uri)
titlestring

Text search against the title of the concept map

ConceptMap.title
urluri

The uri that identifies the concept map

ConceptMap.url
versiontoken

The version identifier of the concept map

ConceptMap.version
Condition
abatement-agequantity

Abatement as age or age range

Condition.abatement.as(Quantity) | Condition.abatement.as(Range)
abatement-booleantoken

Abatement boolean (boolean is true or non-boolean values are present)

Condition.abatement.as(boolean) | Condition.abatement.is(dateTime) | Condition.abatement.is(Age) | Condition.abatement.is(Period) | Condition.abatement.is(Range) | Condition.abatement.is(string)
abatement-datedate

Date-related abatements (dateTime and period)

Condition.abatement.as(dateTime) | Condition.abatement.as(Period)
abatement-stringstring

Abatement as a string

Condition.abatement.as(string)
asserted-datedate

Date record was believed accurate

Condition.assertedDate
asserterreference

Person who asserts this condition

Condition.asserter
body-sitetoken

Anatomical location, if relevant

Condition.bodySite
categorytoken

The category of the condition

Condition.category
clinicalstatustoken

The clinical status of the condition

Condition.clinicalStatus
codetoken

Code for the condition

Condition.code
contextreference

Encounter when condition first asserted

Condition.context
evidencetoken

Manifestation/symptom

Condition.evidence.code
identifiertoken

A unique identifier of the condition record

Condition.identifier
onset-agequantity

Onsets as age or age range

Condition.onset.as(Quantity) | Condition.onset.as(Range)
onset-datedate

Date related onsets (dateTime and Period)

Condition.onset.as(dateTime) | Condition.onset.as(Period)
onset-infostring

Onsets as a string

Condition.onset.as(string)
patientreference

Who has the condition?

Condition.subject
severitytoken

The severity of the condition

Condition.severity
stagetoken

Simple summary (disease specific)

Condition.stage.summary
subjectreference

Who has the condition?

Condition.subject
Consent
actiontoken

Actions controlled by this exception

Consent.except.action
actorreference

Resource for the actor (or group, by role)

Consent.except.actor.reference
categorytoken

Classification of the consent statement - for indexing/retrieval

Consent.category
consentorreference

Who is agreeing to the policy and exceptions

Consent.consentor
datareference

The actual data reference

Consent.except.data.reference
datedate

When this Consent was created or indexed

Consent.dateTime
identifiertoken

Identifier for this record (external references)

Consent.identifier
organizationreference

Organization that manages the consent

Consent.organization
patientreference

Who the consent applies to

Consent.patient
perioddate

Period that this consent applies

Consent.period
purposetoken

Context of activities covered by this exception

Consent.except.purpose
recipientreference

Whose access is controlled by the policy

Consent.recipient
securitytoken

Security Labels that define affected resources

Consent.except.securityLabel
sourcereference

Source from which this consent is taken

Consent.source
statustoken

draft | proposed | active | rejected | inactive | entered-in-error

Consent.status
Contract
agentreference

Agent to the Contact

Contract.agent.actor
authorityreference

The authority of the contract

Contract.authority
domainreference

The domain of the contract

Contract.domain
identifiertoken

The identity of the contract

Contract.identifier
issueddate

The date/time the contract was issued

Contract.issued
patientreference

The identity of the subject of the contract (if a patient)

Contract.subject
signerreference

Contract Signatory Party

Contract.signer.party
subjectreference

The identity of the subject of the contract

Contract.subject
topicreference

The identity of the topic of the contract

Contract.topic
ttopicreference

The identity of the topic of the contract terms

Contract.term.topic
Coverage
beneficiaryreference

Covered party

Coverage.beneficiary
classstring

Class identifier

Coverage.group.class
dependentstring

Dependent number

Coverage.dependent
groupstring

Group identifier

Coverage.group.group
identifiertoken

The primary identifier of the insured and the coverage

Coverage.identifier
payorreference

The identity of the insurer or party paying for services

Coverage.payor
planstring

A plan or policy identifier

Coverage.group.plan
policyholderreference

Reference to the policyholder

Coverage.policyHolder
sequencestring

Sequence number

Coverage.sequence
subclassstring

Sub-class identifier

Coverage.group.subClass
subgroupstring

Sub-group identifier

Coverage.group.subGroup
subplanstring

Sub-plan identifier

Coverage.group.subPlan
subscriberreference

Reference to the subscriber

Coverage.subscriber
typetoken

The kind of coverage (health plan, auto, Workers Compensation)

Coverage.type
DataElement
codetoken

A code for the data element (server may choose to do subsumption)

DataElement.element.code
datedate

The data element publication date

DataElement.date
descriptionstring

Text search in the description of the data element. This corresponds to the definition of the first DataElement.element.

DataElement.element.definition
identifiertoken

External identifiers for the data element

DataElement.identifier
jurisdictiontoken

Intended jurisdiction for data element

DataElement.jurisdiction
namestring

Name of the data element

DataElement.name
objectClasstoken

Matches on the 11179-objectClass extension value

objectClassPropertytoken

Matches on the 11179-objectClassProperty extension value

publisherstring

Name of the publisher of the data element

DataElement.publisher
statustoken

The current status of the data element

DataElement.status
stringencytoken

The stringency of the data element definition

DataElement.stringency
titlestring

Text search against the title of the data element

DataElement.title
urluri

The uri that identifies the data element

DataElement.url
versiontoken

The version identifier of the data element

DataElement.version
DetectedIssue
authorreference

The provider or device that identified the issue

DetectedIssue.author
categorytoken

Issue Category, e.g. drug-drug, duplicate therapy, etc.

DetectedIssue.category
datedate

When identified

DetectedIssue.date
identifiertoken

Unique id for the detected issue

DetectedIssue.identifier
implicatedreference

Problem resource

DetectedIssue.implicated
patientreference

Associated patient

DetectedIssue.patient
Device
identifiertoken

Instance id from manufacturer, owner, and others

Device.identifier
locationreference

A location, where the resource is found

Device.location
manufacturerstring

The manufacturer of the device

Device.manufacturer
modelstring

The model of the device

Device.model
organizationreference

The organization responsible for the device

Device.owner
patientreference

Patient information, if the resource is affixed to a person

Device.patient
typetoken

The type of the device

Device.type
udicarriertoken

Barcode string (udi)

Device.udiCarrier
urluri

Network address to contact device

Device.url
DeviceComponent
parentreference

The parent DeviceComponent resource

DeviceComponent.parent
sourcereference

The device source

DeviceComponent.source
typetoken

The device component type

DeviceComponent.type
DeviceMetric
categorytoken

The category of the metric

DeviceMetric.category
identifiertoken

The identifier of the metric

DeviceMetric.identifier
parentreference

The parent DeviceMetric resource

DeviceMetric.parent
sourcereference

The device resource

DeviceMetric.source
typetoken

The component type

DeviceMetric.type
DeviceUseRequest
author-datedate

When the request transitioned to being actionable

DeviceUseRequest.authored
based-onreference

Plan/proposal/order fulfilled by this request

DeviceUseRequest.basedOn
codetoken

Code for what is being requested/ordered

DeviceUseRequest.device.as(CodeableConcept)
definitionreference

Protocol or definition followed by this request

DeviceUseRequest.definition
devicereference

Reference to resource that is being requested/ordered

DeviceUseRequest.device.as(Reference)
encounterreference

Encounter or Episode during which request was created

DeviceUseRequest.context
event-datedate

When service should occur

DeviceUseRequest.occurrence.as(DateTime) | DeviceUseRequest.occurrence.as(Period)
fillerreference

Desired performer for service

DeviceUseRequest.performer
identifiertoken

Business identifier for request/order

DeviceUseRequest.identifier
patientreference

Individual the service is ordered for

DeviceUseRequest.subject
replacesreference

Request takes the place of referenced completed or terminated requests

DeviceUseRequest.replaces
requesterreference

Who/what is requesting service 

DeviceUseRequest.requester
requisitiontoken

Composite request this is part of

DeviceUseRequest.requisition
stagetoken

proposal | plan | original-order |reflex-order

DeviceUseRequest.stage
statustoken

entered-in-error | draft | active |suspended | completed 

DeviceUseRequest.status
subjectreference

Individual the service is ordered for

DeviceUseRequest.subject
DeviceUseStatement
devicereference

Search by device

DeviceUseStatement.device
patientreference

Search by subject - a patient

DeviceUseStatement.subject
subjectreference

Search by subject

DeviceUseStatement.subject
DiagnosticReport
categorytoken

Which diagnostic discipline/department created the report

DiagnosticReport.category
codetoken

The code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result

DiagnosticReport.code
datedate

The clinically relevant time of the report

DiagnosticReport.effective
diagnosistoken

A coded diagnosis on the report

DiagnosticReport.codedDiagnosis
encounterreference

The Encounter when the order was made

DiagnosticReport.encounter
identifiertoken

An identifier for the report

DiagnosticReport.identifier
imagereference

A reference to the image source.

DiagnosticReport.image.link
issueddate

When the report was issued

DiagnosticReport.issued
patientreference

The subject of the report if a patient

DiagnosticReport.subject
performerreference

Who was the source of the report (organization)

DiagnosticReport.performer
requestreference

Reference to the test or procedure request.

DiagnosticReport.request
resultreference

Link to an atomic result (observation resource)

DiagnosticReport.result
specimenreference

The specimen details

DiagnosticReport.specimen
statustoken

The status of the report

DiagnosticReport.status
subjectreference

The subject of the report

DiagnosticReport.subject
DiagnosticRequest
author-datedate

When the request transitioned to being actionable

DiagnosticRequest.authoredOn
based-onreference

Plan/proposal/order fulfilled by this request

DiagnosticRequest.basedOn
codetoken

What’s being requested/ordered

DiagnosticRequest.code
definitionreference

Protocol or definition followed by this request

DiagnosticRequest.definition
encounterreference

Encounter or Episode during which request was created

DiagnosticRequest.context
event-datedate

When service should occur

DiagnosticRequest.occurrence.as(DateTime) | DiagnosticRequest.occurrence.as(Period)
fillerreference

Desired performer for service

DiagnosticRequest.performer
identifiertoken

Business identifier for request/order

DiagnosticRequest.identifier
intenttoken

proposal | plan | original-order |reflex-order

DiagnosticRequest.intent
patientreference

Individual the service is ordered for

DiagnosticRequest.subject
prioritytoken

routine | urgent | asap | stat

DiagnosticRequest.priority
replacesreference

Request takes the place of referenced completed or terminated requests

DiagnosticRequest.replaces
requesterreference

Who/what is requesting service 

DiagnosticRequest.requester
requisitiontoken

Composite request this is part of

DiagnosticRequest.requisition
statustoken

entered-in-error | draft | active |suspended | completed 

DiagnosticRequest.status
subjectreference

Individual the service is ordered for

DiagnosticRequest.subject
DocumentManifest
authorreference

Who and/or what authored the manifest

DocumentManifest.author
content-refreference

Contents of this set of documents

DocumentManifest.content.p.as(Reference)
createddate

When this document manifest created

DocumentManifest.created
descriptionstring

Human-readable description (title)

DocumentManifest.description
identifiertoken

Unique Identifier for the set of documents

DocumentManifest.masterIdentifier | DocumentManifest.identifier
patientreference

The subject of the set of documents

DocumentManifest.subject
recipientreference

Intended to get notified about this set of documents

DocumentManifest.recipient
related-idtoken

Identifiers of things that are related

DocumentManifest.related.identifier
related-refreference

Related Resource

DocumentManifest.related.ref
sourceuri

The source system/application/software

DocumentManifest.source
statustoken

current | superseded | entered-in-error

DocumentManifest.status
subjectreference

The subject of the set of documents

DocumentManifest.subject
typetoken

Kind of document set

DocumentManifest.type
DocumentReference
authenticatorreference

Who/what authenticated the document

DocumentReference.authenticator
authorreference

Who and/or what authored the document

DocumentReference.author
classtoken

Categorization of document

DocumentReference.class
createddate

Document creation time

DocumentReference.created
custodianreference

Organization which maintains the document

DocumentReference.custodian
descriptionstring

Human-readable description (title)

DocumentReference.description
encounterreference

Context of the document content

DocumentReference.context.encounter
eventtoken

Main Clinical Acts Documented

DocumentReference.context.event
facilitytoken

Kind of facility where patient was seen

DocumentReference.context.facilityType
formattoken

Format/content rules for the document

DocumentReference.content.format
identifiertoken

Master Version Specific Identifier

DocumentReference.masterIdentifier | DocumentReference.identifier
indexeddate

When this document reference created

DocumentReference.indexed
languagetoken

Human language of the content (BCP-47)

DocumentReference.content.attachment.language
locationuri

Uri where the data can be found

DocumentReference.content.attachment.url
patientreference

Who/what is the subject of the document

DocumentReference.subject
perioddate

Time of service that is being documented

DocumentReference.context.period
related-idtoken

Identifier of related objects or events

DocumentReference.context.related.identifier
related-refreference

Related Resource

DocumentReference.context.related.ref
relatestoreference

Target of the relationship

DocumentReference.relatesTo.target
relationtoken

replaces | transforms | signs | appends

DocumentReference.relatesTo.code
relationshipcomposite

Combination of relation and relatesTo

DocumentReference.relatesTo
securitylabeltoken

Document security-tags

DocumentReference.securityLabel
settingtoken

Additional details about where the content was created (e.g. clinical specialty)

DocumentReference.context.practiceSetting
statustoken

current | superseded | entered-in-error

DocumentReference.status
subjectreference

Who/what is the subject of the document

DocumentReference.subject
typetoken

Kind of document (LOINC if possible)

DocumentReference.type
EligibilityRequest
createddate

The creation date for the EOB

EligibilityRequest.created
facilityreference

Facility responsible for the goods and services

EligibilityRequest.facility
identifiertoken

The business identifier of the Eligibility

EligibilityRequest.identifier
organizationreference

The reference to the providing organization

EligibilityRequest.organization
patientreference

The reference to the patient

EligibilityRequest.patient
providerreference

The reference to the provider

EligibilityRequest.provider
EligibilityResponse
createddate

The creation date

EligibilityResponse.created
dispositionstring

The contents of the disposition message

EligibilityResponse.disposition
identifiertoken

The business identifier

EligibilityResponse.identifier
insurerreference

The organization which generated this resource

EligibilityResponse.insurer
outcometoken

The processing outcome

EligibilityResponse.outcome
requestreference

The EligibilityRequest reference

EligibilityResponse.request
request-organizationreference

The EligibilityRequest organization

EligibilityResponse.requestOrganization
request-providerreference

The EligibilityRequest provider

EligibilityResponse.requestProvider
Encounter
appointmentreference

The appointment that scheduled this encounter

Encounter.appointment
classtoken

inpatient | outpatient | ambulatory | emergency +

Encounter.class
conditionreference

Reason the encounter takes place (resource)

Encounter.indication
datedate

A date within the period the Encounter lasted

Encounter.period
episodeofcarereference

Episode(s) of care that this encounter should be recorded against

Encounter.episodeOfCare
identifiertoken

Identifier(s) by which this encounter is known

Encounter.identifier
incomingreferralreference

The ReferralRequest that initiated this encounter

Encounter.incomingReferral
indicationreference

Reason the encounter takes place (resource)

Encounter.indication
lengthnumber

Length of encounter in days

Encounter.length
locationreference

Location the encounter takes place

Encounter.location.location
location-perioddate

Time period during which the patient was present at the location

Encounter.location.period
part-ofreference

Another Encounter this encounter is part of

Encounter.partOf
participantreference

Persons involved in the encounter other than the patient

Encounter.participant.individual
participant-typetoken

Role of participant in encounter

Encounter.participant.type
patientreference

The patient present at the encounter

Encounter.patient
practitionerreference

Persons involved in the encounter other than the patient

Encounter.participant.individual
procedurereference

Reason the encounter takes place (resource)

Encounter.indication
reasontoken

Reason the encounter takes place (code)

Encounter.reason
service-providerreference

The custodian organization of this Encounter record

Encounter.serviceProvider
special-arrangementtoken

Wheelchair, translator, stretcher, etc.

Encounter.hospitalization.specialArrangement
statustoken

planned | arrived | in-progress | onleave | finished | cancelled | entered-in-error

Encounter.status
typetoken

Specific type of encounter

Encounter.type
Endpoint
connection-typetoken

Protocol/Profile/Standard to be used with this endpoint connection

Endpoint.connectionType
identifiertoken

Identifies this endpoint across multiple systems

Endpoint.identifier
namestring

A name that this endpoint can be identified by

Endpoint.name
organizationreference

The organization that is managing the endpoint

Endpoint.managingOrganization
payload-typetoken

The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)

Endpoint.payloadType
statustoken

The current status of the Endpoint (usually expected to be active)

Endpoint.status
EnrollmentRequest
identifiertoken

The business identifier of the Enrollment

EnrollmentRequest.identifier
organizationreference

The organization who generated this resource

EnrollmentRequest.organization
patientreference

The party to be enrolled

EnrollmentRequest.subject
subjectreference

The party to be enrolled

EnrollmentRequest.subject
EnrollmentResponse
identifiertoken

The business identifier of the EnrollmentResponse

EnrollmentResponse.identifier
organizationreference

The organization who generated this resource

EnrollmentResponse.organization
requestreference

The reference to the claim

EnrollmentResponse.request
EpisodeOfCare
care-managerreference

Care manager/care co-ordinator for the patient

EpisodeOfCare.careManager
conditionreference

Conditions/problems/diagnoses this episode of care is for

EpisodeOfCare.condition
datedate

The provided date search value falls within the episode of care's period

EpisodeOfCare.period
identifiertoken

Identifier(s) for the EpisodeOfCare

EpisodeOfCare.identifier
incomingreferralreference

Incoming Referral Request

EpisodeOfCare.referralRequest
organizationreference

The organization that has assumed the specific responsibilities of this EpisodeOfCare

EpisodeOfCare.managingOrganization
patientreference

Patient for this episode of care

EpisodeOfCare.patient
statustoken

The current status of the Episode of Care as provided (does not check the status history collection)

EpisodeOfCare.status
typetoken

Type/class - e.g. specialist referral, disease management

EpisodeOfCare.type
ExpansionProfile
datedate

The expansion profile publication date

ExpansionProfile.date
descriptionstring

Text search against the description of the expansion profile

ExpansionProfile.description
identifiertoken

External identifiers for the expansion profile

ExpansionProfile.identifier
jurisdictiontoken

Intended jurisdiction for expansion profile

ExpansionProfile.jurisdiction
namestring

Name of the expansion profile

ExpansionProfile.name
publisherstring

Name of the publisher of the expansion profile

ExpansionProfile.publisher
statustoken

The current status of the expansion profile

ExpansionProfile.status
urluri

The uri that identifies the expansion profile

ExpansionProfile.url
versiontoken

The version identifier of the expansion profile

ExpansionProfile.version
ExplanationOfBenefit
claimreference

The reference to the claim

ExplanationOfBenefit.claim
coveragereference

The plan under which the claim was adjudicated

ExplanationOfBenefit.insurance.coverage
createddate

The creation date for the EOB

ExplanationOfBenefit.created
dispositionstring

The contents of the disposition message

ExplanationOfBenefit.disposition
facilityreference

Facility responsible for the goods and services

ExplanationOfBenefit.facility
identifiertoken

The business identifier of the Explanation of Benefit

ExplanationOfBenefit.identifier
organizationreference

The reference to the providing organization

ExplanationOfBenefit.organization
patientreference

The reference to the patient

ExplanationOfBenefit.patient
providerreference

The reference to the provider

ExplanationOfBenefit.provider
FamilyMemberHistory
codetoken

A search by a condition code

FamilyMemberHistory.condition.code
datedate

When history was captured/updated

FamilyMemberHistory.date
gendertoken

A search by a gender code of a family member

FamilyMemberHistory.gender
identifiertoken

A search by a record identifier

FamilyMemberHistory.identifier
patientreference

The identity of a subject to list family member history items for

FamilyMemberHistory.patient
relationshiptoken

A search by a relationship type

FamilyMemberHistory.relationship
Flag
authorreference

Flag creator

Flag.author
datedate

Time period when flag is active

Flag.period
encounterreference

Alert relevant during encounter

Flag.encounter
patientreference

The identity of a subject to list flags for

Flag.subject
subjectreference

The identity of a subject to list flags for

Flag.subject
Goal
categorytoken

E.g. Treatment, dietary, behavioral, etc.

Goal.category
identifiertoken

External Ids for this goal

Goal.identifier
patientreference

Who this goal is intended for

Goal.subject
statustoken

proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled | on-target | ahead-of-target | behind-target | entered-in-error

Goal.status
subjectreference

Who this goal is intended for

Goal.subject
targetdatedate

Reach goal on or before

Goal.target.as(Date)
Group
actualtoken

Descriptive or actual

Group.actual
characteristictoken

Kind of characteristic

Group.characteristic.code
characteristic-valuecomposite

A composite of both characteristic and value

Group.characteristic
codetoken

The kind of resources contained

Group.code
excludetoken

Group includes or excludes

Group.characteristic.exclude
identifiertoken

Unique id

Group.identifier
memberreference

Reference to the group member

Group.member.entity
typetoken

The type of resources the group contains

Group.type
valuetoken

Value held by characteristic

Group.characteristic.value
GuidanceResponse
patientreference

The identity of a patient to search for guidance response results

GuidanceResponse.subject
subjectreference

The subject that the guidance response is about

GuidanceResponse.subject
HealthcareService
activetoken

The Healthcare Service is currently marked as active

HealthcareService.active
characteristictoken

One of the HealthcareService's characteristics

HealthcareService.characteristic
endpointreference

Technical endpoints providing access to services operated for the location

HealthcareService.endpoint
identifiertoken

External identifiers for this item

HealthcareService.identifier
locationreference

The location of the Healthcare Service

HealthcareService.location
namestring

A portion of the Healthcare service name

HealthcareService.serviceName
organizationreference

The organization that provides this Healthcare Service

HealthcareService.providedBy
programnamestring

One of the Program Names serviced by this HealthcareService

HealthcareService.programName
servicecategorytoken

Service Category of the Healthcare Service

HealthcareService.serviceCategory
servicetypetoken

The type of service provided by this healthcare service

HealthcareService.serviceType
ImagingManifest
authorreference

Author of key DICOM object selection

ImagingManifest.author
authoring-timedate

Time of key DICOM object selection authoring

ImagingManifest.authoringTime
identifieruri

UID of key DICOM object selection

ImagingManifest.uid
patientreference

Subject of key DICOM object selection

ImagingManifest.patient
selected-studyuri

Study selected in key DICOM object selection

ImagingManifest.study.uid
titletoken

Title of key DICOM object selection

ImagingManifest.title
ImagingStudy
accessiontoken

The accession identifier for the study

ImagingStudy.accession
basedonreference

The order for the image

ImagingStudy.basedOn
bodysitetoken

The body site studied

ImagingStudy.series.bodySite
contextreference

The context of the study

ImagingStudy.context
dicom-classuri

The type of the instance

ImagingStudy.series.instance.sopClass
identifiertoken

Other identifiers for the Study

ImagingStudy.identifier
modalitytoken

The modality of the series

ImagingStudy.series.modality
patientreference

Who the study is about

ImagingStudy.patient
reasontoken

The reason for the study

ImagingStudy.reason
seriesuri

The identifier of the series of images

ImagingStudy.series.uid
starteddate

When the study was started

ImagingStudy.started
studyuri

The study identifier for the image

ImagingStudy.uid
uiduri

The instance unique identifier

ImagingStudy.series.instance.uid
Immunization
datedate

Vaccination (non)-Administration Date

Immunization.date
dose-sequencenumber

Dose number within series

Immunization.vaccinationProtocol.doseSequence
identifiertoken

Business identifier

Immunization.identifier
locationreference

The service delivery location or facility in which the vaccine was / was to be administered

Immunization.location
lot-numberstring

Vaccine Lot Number

Immunization.lotNumber
manufacturerreference

Vaccine Manufacturer

Immunization.manufacturer
notgiventoken

Administrations which were not given

Immunization.wasNotGiven
patientreference

The patient for the vaccination record

Immunization.patient
performerreference

The practitioner who administered the vaccination

Immunization.performer
reactionreference

Additional information on reaction

Immunization.reaction.detail
reaction-datedate

When reaction started

Immunization.reaction.date
reasontoken

Why immunization occurred

Immunization.explanation.reason
reason-not-giventoken

Explanation of reason vaccination was not administered

Immunization.explanation.reasonNotGiven
requesterreference

The practitioner who ordered the vaccination

Immunization.requester
statustoken

Immunization event status

Immunization.status
vaccine-codetoken

Vaccine Product Administered

Immunization.vaccineCode
ImmunizationRecommendation
datedate

Date recommendation created

ImmunizationRecommendation.recommendation.date
dose-numbernumber

Recommended dose number

ImmunizationRecommendation.recommendation.doseNumber
dose-sequencenumber

Dose number within sequence

ImmunizationRecommendation.recommendation.protocol.doseSequence
identifiertoken

Business identifier

ImmunizationRecommendation.identifier
informationreference

Patient observations supporting recommendation

ImmunizationRecommendation.recommendation.supportingPatientInformation
patientreference

Who this profile is for

ImmunizationRecommendation.patient
statustoken

Vaccine administration status

ImmunizationRecommendation.recommendation.forecastStatus
supportreference

Past immunizations supporting recommendation

ImmunizationRecommendation.recommendation.supportingImmunization
vaccine-typetoken

Vaccine recommendation applies to

ImmunizationRecommendation.recommendation.vaccineCode
ImplementationGuide
datedate

The implementation guide publication date

ImplementationGuide.date
dependencyuri

Where to find dependency

ImplementationGuide.dependency.uri
descriptionstring

Text search against the description of the implementation guide

ImplementationGuide.description
experimentaltoken

If for testing purposes, not real usage

ImplementationGuide.experimental
jurisdictiontoken

Intended jurisdiction for implementation guide

ImplementationGuide.jurisdiction
namestring

Name of the implementation guide

ImplementationGuide.name
publisherstring

Name of the publisher of the implementation guide

ImplementationGuide.publisher
resourcereference

Location of the resource

ImplementationGuide.package.resource.source
statustoken

The current status of the implementation guide

ImplementationGuide.status
urluri

The uri that identifies the implementation guide

ImplementationGuide.url
versiontoken

The version identifier of the implementation guide

ImplementationGuide.version
Library
datedate

The library publication date

Library.date
descriptionstring

Text search against the description of the library

Library.description
effectivedate

Effective time associated with the library

Library.effectivePeriod
identifiertoken

External identifiers for the library

Library.identifier
jurisdictiontoken

Intended jurisdiction for library

Library.jurisdiction
namestring

Name of the library

Library.name
publisherstring

Name of the publisher of the library

Library.publisher
statustoken

The current status of the library

Library.status
titlestring

Text search against the title of the library

Library.title
topictoken

Topics associated with the module

Library.topic
urluri

The uri that identifies the library

Library.url
versiontoken

The version identifier of the library

Library.version
Linkage
authorreference

Author of the Linkage

Linkage.author
itemreference

Matches on any item in the Linkage

Linkage.item.resource
sourcereference

Matches on any item in the Linkage with a type of 'source'

Linkage.item.resource
List
codetoken

What the purpose of this list is

List.code
datedate

When the list was prepared

List.date
empty-reasontoken

Why list is empty

List.emptyReason
encounterreference

Context in which list created

List.encounter
identifiertoken

Business identifier

List.identifier
itemreference

Actual entry

List.entry.item
notesstring

The annotation - text content

List.note.text
patientreference

If all resources have the same subject

List.subject
sourcereference

Who and/or what defined the list contents (aka Author)

List.source
statustoken

current | retired | entered-in-error

List.status
subjectreference

If all resources have the same subject

List.subject
titlestring

Descriptive name for the list

List.title
Location
addressstring

A (part of the) address of the location

Location.address
address-citystring

A city specified in an address

Location.address.city
address-countrystring

A country specified in an address

Location.address.country
address-postalcodestring

A postal code specified in an address

Location.address.postalCode
address-statestring

A state specified in an address

Location.address.state
address-usetoken

A use code specified in an address

Location.address.use
endpointreference

Technical endpoints providing access to services operated for the location

Location.endpoint
identifiertoken

Unique code or number identifying the location to its users

Location.identifier
namestring

A (portion of the) name of the location or alias

Location.name or Location.alias
neartoken

The coordinates expressed as [latitude]:[longitude] (using the WGS84 datum, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency).

Requires the near-distance parameter to be provided also

Location.position
near-distancequantity

A distance quantity to limit the near search to locations within a specific distance

Requires the near parameter to be included also

Location.position
organizationreference

Searches for locations that are managed by the provided organization

Location.managingOrganization
partofreference

The location of which this location is a part

Location.partOf
statustoken

Searches for locations with a specific kind of status

Location.status
typetoken

A code for the type of location

Location.type
Measure
datedate

The measure publication date

Measure.date
descriptionstring

Text search against the description of the measure

Measure.description
effectivedate

Effective time associated with the measure

Measure.effectivePeriod
identifiertoken

External identifiers for the measure

Measure.identifier
jurisdictiontoken

Intended jurisdiction for measure

Measure.jurisdiction
namestring

Name of the measure

Measure.name
publisherstring

Name of the publisher of the measure

Measure.publisher
statustoken

The current status of the measure

Measure.status
titlestring

Text search against the title of the measure

Measure.title
topictoken

Topics associated with the module

Measure.topic
urluri

The uri that identifies the measure

Measure.url
versiontoken

The version identifier of the measure

Measure.version
MeasureReport
patientreference

The identity of a patient to search for individual measure report results for

MeasureReport.patient
Media
createddate

Date attachment was first created

Media.content.creation
identifiertoken

Identifier(s) for the image

Media.identifier
operatorreference

The person who generated the image

Media.operator
patientreference

Who/What this Media is a record of

Media.subject
subjectreference

Who/What this Media is a record of

Media.subject
subtypetoken

The type of acquisition equipment/process

Media.subtype
typetoken

photo | video | audio

Media.type
viewtoken

Imaging view, e.g. Lateral or Antero-posterior

Media.view
Medication
codetoken

Codes that identify this medication

Medication.code
containertoken

E.g. box, vial, blister-pack

Medication.package.container
formtoken

powder | tablets | capsule +

Medication.product.form
ingredientreference

The product contained

Medication.product.ingredient.item.as(Reference)
ingredient-codetoken

The product contained

Medication.product.ingredient.item.as(CodeableConcept)
manufacturerreference

Manufacturer of the item

Medication.manufacturer
package-itemreference

The item in the package

Medication.package.content.item.as(Reference)
package-item-codetoken

The item in the package

Medication.package.content.item.as(CodeableConcept)
MedicationAdministration
codetoken

Return administrations of this medication code

MedicationAdministration.medication.as(CodeableConcept)
devicereference

Return administrations with this administration device identity

MedicationAdministration.device
effective-timedate

Date administration happened (or did not happen)

MedicationAdministration.effective
encounterreference

Multiple Resources:

MedicationAdministration.encounter
identifiertoken

Return administrations with this external identifier

MedicationAdministration.identifier
medicationreference

Return administrations of this medication resource

MedicationAdministration.medication.as(Reference)
not-giventoken

Administrations that were not made

MedicationAdministration.notGiven
patientreference

The identity of a patient to list administrations for

MedicationAdministration.patient
performerreference

The identify of the individual who administered the medication

MedicationAdministration.performer
prescriptionreference

The identity of a prescription to list administrations from

MedicationAdministration.prescription
reason-giventoken

Reasons for administering the medication

MedicationAdministration.reasonGiven
reason-not-giventoken

Reasons for not administering the medication

MedicationAdministration.reasonNotGiven
statustoken

MedicationAdministration event status (for example one of active/paused/completed/nullified)

MedicationAdministration.status
MedicationDispense
codetoken

Return dispenses of this medicine code

MedicationDispense.medication.as(CodeableConcept)
destinationreference

Return dispenses that should be sent to a specific destination

MedicationDispense.destination
dispenserreference

Return dispenses performed by a specific individual

MedicationDispense.dispenser
identifiertoken

Return dispenses with this external identifier

MedicationDispense.identifier
medicationreference

Return dispenses of this medicine resource

MedicationDispense.medication.as(Reference)
patientreference

The identity of a patient to list dispenses for

MedicationDispense.patient
prescriptionreference

The identity of a prescription to list dispenses from

MedicationDispense.authorizingPrescription
receiverreference

The identity of a receiver to list dispenses for

MedicationDispense.receiver
responsiblepartyreference

Return dispenses with the specified responsible party

MedicationDispense.substitution.responsibleParty
statustoken

Return dispenses with a specified dispense status

MedicationDispense.status
typetoken

Return dispenses of a specific type

MedicationDispense.type
whenhandedoverdate

Returns dispenses handed over on this date

MedicationDispense.whenHandedOver
whenprepareddate

Returns dispenses prepared on this date

MedicationDispense.whenPrepared
MedicationRequest
categorytoken

Returns prescriptions with different categories

MedicationRequest.category
codetoken

Return prescriptions of this medication code

MedicationRequest.medication.as(CodeableConcept)
contextreference

Return prescriptions with this encounter or episode of care identifier

MedicationRequest.context
datewrittendate

Return prescriptions written on this date

MedicationRequest.dateWritten
identifiertoken

Return prescriptions with this external identifier

MedicationRequest.identifier
intended-dispenserreference

Returns prescriptions intended to be dispensed by this Organization

MedicationRequest.dispenseRequest.performer
medicationreference

Return prescriptions of this medication reference

MedicationRequest.medication.as(Reference)
patientreference

The identity of a patient to list orders for

MedicationRequest.patient
requesterreference

Returns prescriptions prescribed by this prescriber

MedicationRequest.requester
statustoken

Status of the prescription

MedicationRequest.status
MedicationStatement
categorytoken

Returns statements of this category of medicationstatement

MedicationStatement.category
codetoken

Return statements of this medication code

MedicationStatement.medication.as(CodeableConcept)
effectivedate

Date when patient was taking (or not taking) the medication

MedicationStatement.effective
identifiertoken

Return statements with this external identifier

MedicationStatement.identifier
medicationreference

Return statements of this medication reference

MedicationStatement.medication.as(Reference)
sourcereference

Who or where the information in the statement came from

MedicationStatement.informationSource
statustoken

Return statements that match the given status

MedicationStatement.status
subjectreference

The identity of a patient, animal or group to list statements for

MedicationStatement.subject
MessageDefinition
categorytoken

The behavior associated with the message

MessageDefinition.category
datedate

The message definition publication date

MessageDefinition.date
descriptionstring

Text search against the description of the message definition

MessageDefinition.description
eventtoken

The event that triggers the message

MessageDefinition.event
focustoken

A resource that is a permitted focus of the message

MessageDefinition.focus.code
jurisdictiontoken

Intended jurisdiction for message definition

MessageDefinition.jurisdiction
namestring

Name of the message definition

MessageDefinition.name
publisherstring

Name of the publisher of the message definition

MessageDefinition.publisher
statustoken

The current status of the message definition

MessageDefinition.status
titlestring

Text search against the title of the message definition

MessageDefinition.title
urluri

The uri that identifies the message definition

MessageDefinition.url
versiontoken

The version identifier of the message definition

MessageDefinition.version
MessageHeader
authorreference

The source of the decision

MessageHeader.author
codetoken

ok | transient-error | fatal-error

MessageHeader.response.code
datareference

The actual content of the message

MessageHeader.data
destinationstring

Name of system

MessageHeader.destination.name
destination-uriuri

Actual destination address or id

MessageHeader.destination.endpoint
entererreference

The source of the data entry

MessageHeader.enterer
eventtoken

Code for the event this message represents

MessageHeader.event
receiverreference

Intended "real-world" recipient for the data

MessageHeader.receiver
response-idtoken

Id of original message

MessageHeader.response.identifier
responsiblereference

Final responsibility for event

MessageHeader.responsible
sourcestring

Name of system

MessageHeader.source.name
source-uriuri

Actual message source address or id

MessageHeader.source.endpoint
targetreference

Particular delivery destination within the destination

MessageHeader.destination.target
timestampdate

Time that the message was sent

MessageHeader.timestamp
NamingSystem
contactstring

Name of an individual to contact

NamingSystem.contact.name
datedate

The naming system publication date

NamingSystem.date
descriptionstring

Text search against the description of the naming system

NamingSystem.description
id-typetoken

oid | uuid | uri | other

NamingSystem.uniqueId.type
jurisdictiontoken

Intended jurisdiction for naming system

NamingSystem.jurisdiction
kindtoken

codesystem | identifier | root

NamingSystem.kind
namestring

Name of the naming system

NamingSystem.name
perioddate

When is identifier valid?

NamingSystem.uniqueId.period
publisherstring

Name of the publisher of the naming system

NamingSystem.publisher
replaced-byreference

Use this instead

NamingSystem.replacedBy
responsiblestring

Who maintains system namespace?

NamingSystem.responsible
statustoken

The current status of the naming system

NamingSystem.status
telecomtoken

Contact details for individual or organization

NamingSystem.contact.telecom
typetoken

e.g. driver, provider, patient, bank etc.

NamingSystem.type
valuestring

The unique identifier

NamingSystem.uniqueId.value
NutritionRequest
additivetoken

Type of module component to add to the feeding

NutritionRequest.enteralFormula.additiveType
datetimedate

Return nutrition orders requested on this date

NutritionRequest.dateTime
encounterreference

Return nutrition orders with this encounter identifier

NutritionRequest.encounter
formulatoken

Type of enteral or infant formula

NutritionRequest.enteralFormula.baseFormulaType
identifiertoken

Return nutrition orders with this external identifier

NutritionRequest.identifier
oraldiettoken

Type of diet that can be consumed orally (i.e., take via the mouth).

NutritionRequest.oralDiet.type
patientreference

The identity of the person who requires the diet, formula or nutritional supplement

NutritionRequest.patient
providerreference

The identify of the provider who placed the nutrition order

NutritionRequest.orderer
statustoken

Status of the nutrition order.

NutritionRequest.status
supplementtoken

Type of supplement product requested

NutritionRequest.supplement.type
Observation
categorytoken

The classification of the type of observation

Observation.category
codetoken

The code of the observation type or component type

Observation.code | Observation.component.code
code-value-conceptcomposite

Code and coded value parameter pair, including in components

Observation | Observation.component
code-value-datecomposite

Code and date/time value parameter pair, including in components

Observation | Observation.component
code-value-quantitycomposite

Code and quantity value parameter pair, including in components

Observation | Observation.component
code-value-stringcomposite

Code and string value parameter pair, including in components

Observation | Observation.component
data-absent-reasontoken

The reason why the expected value in the element Observation.value[x] is missing.

Observation.dataAbsentReason | Observation.component.dataAbsentReason
datedate

Obtained date/time. If the obtained element is a period, a date that falls in the period

Observation.effective
devicereference

The Device that generated the observation data.

Observation.device
encounterreference

Healthcare event related to the observation

Observation.encounter
identifiertoken

The unique id for a particular observation

Observation.identifier
methodtoken

The method used for the observation

Observation.method
patientreference

The subject that the observation is about (if patient)

Observation.subject
performerreference

Who performed the observation

Observation.performer
relatedcomposite

Related Observations - search on related-type and related-target together

Observation.related
related-targetreference

Resource that is related to this one

Observation.related.target
related-typetoken

has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by

Observation.related.type
specimenreference

Specimen used for this observation

Observation.specimen
statustoken

The status of the observation

Observation.status
subjectreference

The subject that the observation is about

Observation.subject
value-concepttoken

The value or component value of the observation, if the value is a CodeableConcept

Observation.value.as(CodeableConcept) | Observation.component.value.as(CodeableConcept)
value-datedate

The value of the observation, if the value is a date or period of time

Observation.value.as(DateTime) | Observation.value.as(Period)
value-quantityquantity

The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)

Observation.value.as(Quantity) | Observation.component.value.as(Quantity)
value-stringstring

The value or component value of the observation, if the value is a string, and also searches in CodeableConcept.text

Observation.value.as(String) | Observation.component.value.as(String)
OperationDefinition
basereference

Marks this as a profile of the base

OperationDefinition.base
codetoken

Name used to invoke the operation

OperationDefinition.code
datedate

The operation definition publication date

OperationDefinition.date
descriptionstring

Text search against the description of the operation definition

OperationDefinition.description
instancetoken

Invoke on an instance?

OperationDefinition.instance
jurisdictiontoken

Intended jurisdiction for operation definition

OperationDefinition.jurisdiction
kindtoken

operation | query

OperationDefinition.kind
namestring

Name of the operation definition

OperationDefinition.name
paramprofilereference

Profile on the type

OperationDefinition.parameter.profile
publisherstring

Name of the publisher of the operation definition

OperationDefinition.publisher
statustoken

The current status of the operation definition

OperationDefinition.status
systemtoken

Invoke at the system level?

OperationDefinition.system
typetoken

Invole at the type level?

OperationDefinition.type
urluri

The uri that identifies the operation definition

OperationDefinition.url
versiontoken

The version identifier of the operation definition

OperationDefinition.version
Organization
activetoken

A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text

Organization.active
addressstring

A (part of the) address of the Organization

Organization.address
address-citystring

A city specified in an address

Organization.address.city
address-countrystring

A country specified in an address

Organization.address.country
address-postalcodestring

A postal code specified in an address

Organization.address.postalCode
address-statestring

A state specified in an address

Organization.address.state
address-usetoken

A use code specified in an address

Organization.address.use
endpointreference

Technical endpoints providing access to services operated for the organization

Organization.endpoint
identifiertoken

Any identifier for the organization (not the accreditation issuer's identifier)

Organization.identifier
namestring

A portion of the organization's name, or alias

Organization.name or Organization.alias
partofreference

Search all organizations that are part of the given organization

Organization.partOf
phoneticstring

A portion of the organization's name using some kind of phonetic matching algorithm

Organization.name
typetoken

A code for the type of organization

Organization.type
Patient
activetoken

Whether the patient record is active

Patient.active
addressstring

A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text

Patient.address
address-citystring

A city specified in an address

Patient.address.city
address-countrystring

A country specified in an address

Patient.address.country
address-postalcodestring

A postalCode specified in an address

Patient.address.postalCode
address-statestring

A state specified in an address

Patient.address.state
address-usetoken

A use code specified in an address

Patient.address.use
animal-breedtoken

The breed for animal patients

Patient.animal.breed
animal-speciestoken

The species for animal patients

Patient.animal.species
birthdatedate

The patient's date of birth

Patient.birthDate
death-datedate

The date of death has been provided and satisfies this search value

Patient.deceased.as(DateTime)
deceasedtoken

This patient has been marked as deceased, or as a death date entered

Patient.deceased.exists()
emailtoken

A value in an email contact

Patient.telecom.where(system='email')
ethnicitytoken

Returns patients with an ethnicity extension matching the specified code.

familystring

A portion of the family name of the patient

Patient.name.family
gendertoken

Gender of the patient

Patient.gender
general-practitionerreference

Patient's nominated general practitioner, not the organization that manages the record

Patient.generalPractitioner
givenstring

A portion of the given name of the patient

Patient.name.given
identifiertoken

A patient identifier

Patient.identifier
languagetoken

Language code (irrespective of use value)

Patient.communication.language
linkreference

All patients linked to the given patient

Patient.link.other
namestring

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

Patient.name
organizationreference

The organization at which this person is a patient

Patient.managingOrganization
phonetoken

A value in a phone contact

Patient.telecom.where(system='phone')
phoneticstring

A portion of either family or given name using some kind of phonetic matching algorithm

Patient.name
racetoken

Returns patients with a race extension matching the specified code.

telecomtoken

The value in any kind of telecom details of the patient

Patient.telecom
PaymentNotice
createddate

Creation date fro the notice

PaymentNotice.created
identifiertoken

The business identifier of the notice

PaymentNotice.identifier
organizationreference

The organization who generated this resource

PaymentNotice.organization
payment-statustoken

The type of payment notice

PaymentNotice.paymentStatus
providerreference

The reference to the provider

PaymentNotice.provider
requestreference

The Claim

PaymentNotice.request
responsereference

The ClaimResponse

PaymentNotice.response
statusdatedate

The date of the payment action

PaymentNotice.statusDate
PaymentReconciliation
createddate

The creation date

PaymentReconciliation.created
dispositionstring

The contents of the disposition message

PaymentReconciliation.disposition
identifiertoken

The business identifier of the Explanation of Benefit

PaymentReconciliation.identifier
organizationreference

The organization who generated this resource

PaymentReconciliation.organization
outcometoken

The processing outcome

PaymentReconciliation.outcome
requestreference

The reference to the claim

PaymentReconciliation.request
request-organizationreference

The organization who generated this resource

PaymentReconciliation.requestOrganization
request-providerreference

The reference to the provider who sumbitted the claim

PaymentReconciliation.requestProvider
Person
addressstring

A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text

Person.address
address-citystring

A city specified in an address

Person.address.city
address-countrystring

A country specified in an address

Person.address.country
address-postalcodestring

A postal code specified in an address

Person.address.postalCode
address-statestring

A state specified in an address

Person.address.state
address-usetoken

A use code specified in an address

Person.address.use
birthdatedate

The person's date of birth

Person.birthDate
emailtoken

A value in an email contact

Person.telecom.where(system='email')
gendertoken

The gender of the person

Person.gender
identifiertoken

A person Identifier

Person.identifier
linkreference

Any link has this Patient, Person, RelatedPerson or Practitioner reference

Person.link.target
namestring

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

Person.name
organizationreference

The organization at which this person record is being managed

Person.managingOrganization
patientreference

The Person links to this Patient

Person.link.target
phonetoken

A value in a phone contact

Person.telecom.where(system='phone')
phoneticstring

A portion of name using some kind of phonetic matching algorithm

Person.name
practitionerreference

The Person links to this Practitioner

Person.link.target
relatedpersonreference

The Person links to this RelatedPerson

Person.link.target
telecomtoken

The value in any kind of contact

Person.telecom
PlanDefinition
datedate

The plan definition publication date

PlanDefinition.date
descriptionstring

Text search against the description of the plan definition

PlanDefinition.description
effectivedate

Effective time associated with the plan definition

PlanDefinition.effectivePeriod
identifiertoken

External identifiers for the plan definition

PlanDefinition.identifier
jurisdictiontoken

Intended jurisdiction for plan definition

PlanDefinition.jurisdiction
namestring

Name of the plan definition

PlanDefinition.name
publisherstring

Name of the publisher of the plan definition

PlanDefinition.publisher
statustoken

The current status of the plan definition

PlanDefinition.status
titlestring

Text search against the title of the plan definition

PlanDefinition.title
topictoken

Topics associated with the module

PlanDefinition.topic
urluri

The uri that identifies the plan definition

PlanDefinition.url
versiontoken

The version identifier of the plan definition

PlanDefinition.version
Practitioner
activetoken

Whether the practitioner record is active

Practitioner.active
addressstring

A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text

Practitioner.address
address-citystring

A city specified in an address

Practitioner.address.city
address-countrystring

A country specified in an address

Practitioner.address.country
address-postalcodestring

A postalCode specified in an address

Practitioner.address.postalCode
address-statestring

A state specified in an address

Practitioner.address.state
address-usetoken

A use code specified in an address

Practitioner.address.use
communicationtoken

One of the languages that the practitioner can communicate with

Practitioner.communication
emailtoken

A value in an email contact

Practitioner.telecom.where(system='email') or Practitioner.role.telecom.where(system='email')
endpointreference

The endpoint of the practitioner for a role at an organization

Practitioner.role.endpoint
familystring

A portion of the family name

Practitioner.name.family
gendertoken

Gender of the practitioner

Practitioner.gender
givenstring

A portion of the given name

Practitioner.name.given
identifiertoken

A practitioner's Identifier

Practitioner.identifier | Practitioner.role.identifier
locationreference

One of the locations at which this practitioner provides care

Practitioner.role.location
namestring

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

Practitioner.name
organizationreference

The identity of the organization the practitioner represents / acts on behalf of

Practitioner.role.organization
phonetoken

A value in a phone contact

Practitioner.telecom.where(system='phone') or Practitioner.role.telecom.where(system='phone')
phoneticstring

A portion of either family or given name using some kind of phonetic matching algorithm

Practitioner.name
roletoken

The practitioner can perform this role at for the organization

Practitioner.role.code
specialtytoken

The practitioner has this specialty at an organization

Practitioner.role.specialty
telecomtoken

The value in any kind of contact

Practitioner.telecom | Practitioner.role.telecom
PractitionerRole
emailtoken

A value in an email contact

PractitionerRole.telecom.where(system='email')
endpointreference

Technical endpoints providing access to services operated for the practitioner with this role

PractitionerRole.endpoint
identifiertoken

A practitioner's Identifier

PractitionerRole.identifier
locationreference

One of the locations at which this practitioner provides care

PractitionerRole.location
organizationreference

The identity of the organization the practitioner represents / acts on behalf of

PractitionerRole.organization
phonetoken

A value in a phone contact

PractitionerRole.telecom.where(system='phone')
practitionerreference

Practitioner that is able to provide the defined services for the organation

PractitionerRole.practitioner
roletoken

The practitioner can perform this role at for the organization

PractitionerRole.code
specialtytoken

The practitioner has this specialty at an organization

PractitionerRole.specialty
telecomtoken

The value in any kind of contact

PractitionerRole.telecom
Procedure
categorytoken

Classification of the procedure

Procedure.category
codetoken

A code to identify a procedure

Procedure.code
datedate

Date/Period the procedure was performed

Procedure.performed
encounterreference

The encounter associated with the procedure

Procedure.encounter
identifiertoken

A unique identifier for a procedure

Procedure.identifier
locationreference

Where the procedure happened

Procedure.location
patientreference

Search by subject - a patient

Procedure.subject
performerreference

The reference to the practitioner

Procedure.performer.actor
subjectreference

Search by subject

Procedure.subject
ProcedureRequest
body-sitetoken

What part of body to perform on

ProcedureRequest.bodySite
codetoken

What procedure to perform

ProcedureRequest.code
encounterreference

Encounter request created during

ProcedureRequest.encounter
identifiertoken

A unique identifier of the Procedure Request

ProcedureRequest.identifier
ordererreference

Who made request

ProcedureRequest.orderer
patientreference

Search by subject - a patient

ProcedureRequest.subject
performerreference

Who should perform the procedure

ProcedureRequest.performer
statustoken

proposed | draft | requested | received | accepted | in-progress | completed | suspended | rejected | aborted

ProcedureRequest.status
subjectreference

Search by subject

ProcedureRequest.subject
ProcessRequest
actiontoken

The action requested by this resource

ProcessRequest.action
identifiertoken

The business identifier of the ProcessRequest

ProcessRequest.identifier
organizationreference

The organization who generated this request

ProcessRequest.organization
providerreference

The provider who regenerated this request

ProcessRequest.provider
ProcessResponse
identifiertoken

The business identifier of the Explanation of Benefit

ProcessResponse.identifier
organizationreference

The organization who generated this resource

ProcessResponse.organization
requestreference

The reference to the claim

ProcessResponse.request
request-organizationreference

The Organization who is responsible the request transaction

ProcessResponse.requestOrganization
request-providerreference

The Provider who is responsible the request transaction

ProcessResponse.requestProvider
Provenance
agentreference

Who participated

Provenance.agent.who
enddate

End time with inclusive boundary, if not ongoing

Provenance.period.end
entityreference

Identity of entity

Provenance.entity.reference
locationreference

Where the activity occurred, if relevant

Provenance.location
patientreference

Target Reference(s) (usually version specific)

Provenance.target
sigtoken

Indication of the reason the entity signed the object(s)

Provenance.signature.type
startdate

Starting time with inclusive boundary

Provenance.period.start
targetreference

Target Reference(s) (usually version specific)

Provenance.target
Questionnaire
codetoken

A code that corresponds to the questionnaire or one of its groups

Questionnaire.item.concept
contexttoken

A use context assigned to the questionnaire

Questionnaire.useContext
datedate

When the questionnaire was last changed

Questionnaire.date
identifiertoken

An identifier for the questionnaire

Questionnaire.identifier
publisherstring

The author of the questionnaire

Questionnaire.publisher
statustoken

The status of the questionnaire

Questionnaire.status
titlestring

All or part of the name of the questionnaire

Questionnaire.title
versionstring

The business version of the questionnaire

Questionnaire.version
QuestionnaireResponse
authorreference

The author of the questionnaire response

QuestionnaireResponse.author
authoreddate

When the questionnaire response was authored

QuestionnaireResponse.authored
based-onreference

Plan/proposal/order fulfilled by this questionnaire response

QuestionnaireResponse.basedOn
contextreference

Encounter or episode during which questionnaire response was authored

QuestionnaireResponse.context
identifiertoken

The unique identifier for the questionnaire response

QuestionnaireResponse.identifier
parentreference

Procedure or observation this questionnaire response is part of

QuestionnaireResponse.parent
patientreference

The patient that is the subject of the questionnaire response

QuestionnaireResponse.subject
questionnairereference

The questionnaire the answers are provided for

QuestionnaireResponse.questionnaire
sourcereference

The person who answered the questions

QuestionnaireResponse.source
statustoken

The status of the questionnaire response

QuestionnaireResponse.status
subjectreference

The subject of the questionnaire response

QuestionnaireResponse.subject
ReferralRequest
basedonreference

Request being fulfilled

ReferralRequest.basedOn
categorytoken

Proposal, plan or request

ReferralRequest.category
contextreference

Part of encounter or episode of care

ReferralRequest.context
datedate

Creation or activation date

ReferralRequest.authored
parenttoken

Part of common request

ReferralRequest.parent
patientreference

Who the referral is about

ReferralRequest.patient
prioritytoken

The priority assigned to the referral

ReferralRequest.priority
recipientreference

The person that the referral was sent to

ReferralRequest.recipient
requesterreference

Requester of referral / transfer of care

ReferralRequest.requester
specialtytoken

The specialty that the referral is for

ReferralRequest.specialty
statustoken

The status of the referral

ReferralRequest.status
typetoken

The type of the referral

ReferralRequest.type
RelatedPerson
activetoken

Wheter the related person record is active

RelatedPerson.active
addressstring

A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text

RelatedPerson.address
address-citystring

A city specified in an address

RelatedPerson.address.city
address-countrystring

A country specified in an address

RelatedPerson.address.country
address-postalcodestring

A postal code specified in an address

RelatedPerson.address.postalCode
address-statestring

A state specified in an address

RelatedPerson.address.state
address-usetoken

A use code specified in an address

RelatedPerson.address.use
birthdatedate

The Related Person's date of birth

RelatedPerson.birthDate
emailtoken

A value in an email contact

RelatedPerson.telecom.where(system='email')
gendertoken

Gender of the person

RelatedPerson.gender
identifiertoken

An Identifier of the RelatedPerson

RelatedPerson.identifier
namestring

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

RelatedPerson.name
patientreference

The patient this person is related to

RelatedPerson.patient
phonetoken

A value in a phone contact

RelatedPerson.telecom.where(system='phone')
phoneticstring

A portion of name using some kind of phonetic matching algorithm

RelatedPerson.name
telecomtoken

The value in any kind of contact

RelatedPerson.telecom
RequestGroup
authorreference

The author of the request group

RequestGroup.author
contextreference

The context the request group applies to

RequestGroup.context
encounterreference

The encounter the request group applies to

RequestGroup.context
participantreference

The participant in the requests in the group

RequestGroup.action.participant
patientreference

The identity of a patient to search for request groups

RequestGroup.subject
subjectreference

The subject that the request group is about

RequestGroup.subject
ResearchStudy
categorytoken

Classifications for the study

ResearchStudy.category
datedate

When the study began and ended

ResearchStudy.period
focustoken

Drugs, devices, conditions, etc. under study

ResearchStudy.focus
identifiertoken

Business Identifer for study

ResearchStudy.identifier
jurisdictiontoken

Geographic region(s) for study

ResearchStudy.jurisdiction
keywordtoken

Used to search for the study

ResearchStudy.keyword
partofreference

Part of larger study

ResearchStudy.partOf
principalinvestigatorreference

Individual responsible for the study

ResearchStudy.principalInvestigator
protocolreference

Steps followed in executing study

ResearchStudy.protocol
sitereference

Location involved in study execution

ResearchStudy.site
sponsorreference

Organization responsible for the study

ResearchStudy.sponsor
statustoken

draft | in-progress | suspended | stopped | completed | entered-in-error

ResearchStudy.status
titlestring

Name for this study

ResearchStudy.title
ResearchSubject
datedate

Start and end of participation

ResearchSubject.period
identifiertoken

Business Identifer for event

ResearchSubject.identifier
individualreference

Who is part of study

ResearchSubject.individual
patientreference

Who is part of study

ResearchSubject.individual
statustoken

candidate | enrolled | active | suspended | withdrawn | completed

ResearchSubject.status
RiskAssessment
conditionreference

Condition assessed

RiskAssessment.condition
datedate

When was assessment made?

RiskAssessment.occurrence.as(DateTime)
encounterreference

Where was assessment performed?

RiskAssessment.context
identifiertoken

Unique identifier for the assessment

RiskAssessment.identifier
methodtoken

Evaluation mechanism

RiskAssessment.method
patientreference

Who/what does assessment apply to?

RiskAssessment.subject
performerreference

Who did assessment?

RiskAssessment.performer
subjectreference

Who/what does assessment apply to?

RiskAssessment.subject
Schedule
activetoken

Is the schedule in active use

Schedule.active
actorreference

The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for

Schedule.actor
datedate

Search for Schedule resources that have a period that contains this date specified

Schedule.planningHorizon
identifiertoken

A Schedule Identifier

Schedule.identifier
typetoken

The type of appointments that can be booked into associated slot(s)

Schedule.serviceType
SearchParameter
basetoken

The resource type(s) this search parameter applies to

SearchParameter.base
codetoken

Code used in URL

SearchParameter.code
componentreference

Defines how the part works

SearchParameter.component.definition
datedate

The search parameter publication date

SearchParameter.date
derived-fromuri

Original Definition for the search parameter

SearchParameter.derivedFrom
descriptionstring

Text search against the description of the search parameter

SearchParameter.description
jurisdictiontoken

Intended jurisdiction for search parameter

SearchParameter.jurisdiction
namestring

Name of the search parameter

SearchParameter.name
publisherstring

Name of the publisher of the search parameter

SearchParameter.publisher
statustoken

The current status of the search parameter

SearchParameter.status
targettoken

Types of resource (if a resource reference)

SearchParameter.target
typetoken

number | date | string | token | reference | composite | quantity | uri

SearchParameter.type
urluri

The uri that identifies the search parameter

SearchParameter.url
versiontoken

The version identifier of the search parameter

SearchParameter.version
Sequence
chromosometoken

Chromosome number of the reference sequence

Sequence.referenceSeq.chromosome
coordinatecomposite

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 coordinate=1$lt345$gt123, this means it will search for the Sequence resource on chromosome 1 and with position >123 and <345, where in 1-based system resource, all strings within region 1:124-344 will be revealed, while in 0-based system resource, all strings within region 1:123-344 will be revealed. You may want to check detail about 0-based v.s. 1-based above.

Sequence.variant
endnumber

End position (0-based exclusive, which menas the acid at this position will not be included, 1-based inclusive, which means the acid at this position will be included) of the reference sequence.

Sequence.referenceSeq.windowEnd
identifiertoken

The unique identity for a particular sequence

Sequence.identifier
patientreference

The subject that the observation is about

Sequence.patient
startnumber

Start position (0-based inclusive, 1-based inclusive, that means the nucleic acid or amino acid at this position will be included) of the reference sequence.

Sequence.referenceSeq.windowStart
typetoken

Amino Acid Sequence/ DNA Sequence / RNA Sequence

Sequence.type
ServiceDefinition
datedate

The service definition publication date

ServiceDefinition.date
descriptionstring

Text search against the description of the service definition

ServiceDefinition.description
effectivedate

Effective time associated with the service definition

ServiceDefinition.effectivePeriod
identifiertoken

External identifiers for the service definition

ServiceDefinition.identifier
jurisdictiontoken

Intended jurisdiction for service definition

ServiceDefinition.jurisdiction
namestring

Name of the service definition

ServiceDefinition.name
publisherstring

Name of the publisher of the service definition

ServiceDefinition.publisher
statustoken

The current status of the service definition

ServiceDefinition.status
titlestring

Text search against the title of the service definition

ServiceDefinition.title
topictoken

Topics associated with the module

ServiceDefinition.topic
urluri

The uri that identifies the service definition

ServiceDefinition.url
versiontoken

The version identifier of the service definition

ServiceDefinition.version
Slot
identifiertoken

A Slot Identifier

Slot.identifier
schedulereference

The Schedule Resource that we are seeking a slot within

Slot.schedule
slot-typetoken

The type of appointments that can be booked into the slot

Slot.serviceType
startdate

Appointment date/time.

Slot.start
statustoken

The free/busy status of the appointment

Slot.status
Specimen
accessiontoken

The accession number associated with the specimen

Specimen.accessionIdentifier
bodysitetoken

The code for the body site from where the specimen originated

Specimen.collection.bodySite
collecteddate

The date the specimen was collected

Specimen.collection.collected
collectorreference

Who collected the specimen

Specimen.collection.collector
containertoken

The kind of specimen container

Specimen.container.type
container-idtoken

The unique identifier associated with the specimen container

Specimen.container.identifier
identifiertoken

The unique identifier associated with the specimen

Specimen.identifier
parentreference

The parent of the specimen

Specimen.parent
patientreference

The patient the specimen comes from

Specimen.subject
subjectreference

The subject of the specimen

Specimen.subject
typetoken

The specimen type

Specimen.type
StructureDefinition
abstracttoken

Whether the structure is abstract

StructureDefinition.abstract
baseuri

Definition that this type is constrained/specialized from

StructureDefinition.baseDefinition
base-pathtoken

Path that identifies the base element

StructureDefinition.snapshot.element.base.path | StructureDefinition.differential.element.base.path
context-typetoken

resource | datatype | extension

StructureDefinition.contextType
datedate

The structure definition publication date

StructureDefinition.date
derivationtoken

specialization | constraint - How relates to base definition

StructureDefinition.derivation
descriptionstring

Text search against the description of the structure definition

StructureDefinition.description
experimentaltoken

If for testing purposes, not real usage

StructureDefinition.experimental
ext-contextstring

Where the extension can be used in instances

StructureDefinition.context
identifiertoken

External identifiers for the structure definition

StructureDefinition.identifier
jurisdictiontoken

Intended jurisdiction for structure definition

StructureDefinition.jurisdiction
keywordtoken

A code for the profile

StructureDefinition.keyword
kindtoken

primitive-type | complex-type | resource | logical

StructureDefinition.kind
namestring

Name of the structure definition

StructureDefinition.name
pathtoken

A path that is constrained in the profile

StructureDefinition.snapshot.element.path | StructureDefinition.differential.element.path
publisherstring

Name of the publisher of the structure definition

StructureDefinition.publisher
statustoken

The current status of the structure definition

StructureDefinition.status
titlestring

Text search against the title of the structure definition

StructureDefinition.title
typetoken

Type defined or constrained by this structure

StructureDefinition.type
urluri

The uri that identifies the structure definition

StructureDefinition.url
valuesetreference

A vocabulary binding reference

StructureDefinition.snapshot.element.binding.valueSet
versiontoken

The version identifier of the structure definition

StructureDefinition.version
StructureMap
datedate

The structure map publication date

StructureMap.date
descriptionstring

Text search against the description of the structure map

StructureMap.description
identifiertoken

External identifiers for the structure map

StructureMap.identifier
jurisdictiontoken

Intended jurisdiction for structure map

StructureMap.jurisdiction
namestring

Name of the structure map

StructureMap.name
publisherstring

Name of the publisher of the structure map

StructureMap.publisher
statustoken

The current status of the structure map

StructureMap.status
titlestring

Text search against the title of the structure map

StructureMap.title
urluri

The uri that identifies the structure map

StructureMap.url
versiontoken

The version identifier of the structure map

StructureMap.version
Subscription
contacttoken

Contact details for source (e.g. troubleshooting)

Subscription.contact
criteriastring

Rule for server push criteria

Subscription.criteria
payloadstring

Mimetype to send, or omit for no payload

Subscription.channel.payload
statustoken

requested | active | error | off

Subscription.status
tagtoken

A tag to add to matching resources

Subscription.tag
typetoken

rest-hook | websocket | email | sms | message

Subscription.channel.type
urluri

Where the channel points to

Subscription.channel.endpoint
Substance
categorytoken

The category of the substance

Substance.category
codetoken

The code of the substance or ingredient

Substance.code | Substance.ingredient.substance.as(CodeableConcept)
container-identifiertoken

Identifier of the package/container

Substance.instance.identifier
expirydate

Expiry date of package or container of substance

Substance.instance.expiry
identifiertoken

Unique identifier for the substance

Substance.identifier
quantityquantity

Amount of substance in the package

Substance.instance.quantity
substance-referencereference

A component of the substance

Substance.ingredient.substance.as(Reference)
SupplyDelivery
identifiertoken

External identifier

SupplyDelivery.identifier
patientreference

Patient for whom the item is supplied

SupplyDelivery.patient
receiverreference

Who collected the Supply

SupplyDelivery.receiver
statustoken

in-progress | completed | abandoned

SupplyDelivery.status
supplierreference

Dispenser

SupplyDelivery.supplier
SupplyRequest
datedate

When the request was made

SupplyRequest.date
identifiertoken

Unique identifier

SupplyRequest.identifier
kindtoken

The kind of supply (central, non-stock, etc.)

SupplyRequest.kind
patientreference

Patient for whom the item is supplied

SupplyRequest.patient
sourcereference

Who initiated this order

SupplyRequest.source
statustoken

requested | completed | failed | cancelled

SupplyRequest.status
supplierreference

Who is intended to fulfill the request

SupplyRequest.supplier
Task
authored-ondate

Search by creation date

Task.authoredOn
based-onreference

Search by requests this task is based on

Task.basedOn
business-statustoken

Search by business status

Task.businessStatus
codetoken

Search by task code

Task.code
contextreference

Search by encounter or episode

Task.context
definition-refreference

Search by task definition as a Reference

Task.definition.as(Reference)
focusreference

Search by task focus

Task.focus
group-identifiertoken

Search by group identifier

Task.groupIdentifier
identifiertoken

Search for a task instance by its business identifier

Task.identifier
intenttoken

Search by task intent

Task.intent
modifieddate

Search by last modification date

Task.lastModified
organizationreference

Search by responsible organization

Task.requester.onBehalfOf
ownerreference

Search by task owner

Task.owner
part-ofreference

Search by task this task is part of

Task.partOf
patientreference

Search by patient

Task.for
performertoken

Search by recommended type of performer (e.g., Requester, Performer, Scheduler).

Task.performerType
perioddate

Search by period Task is/was underway

Task.executionPeriod
prioritytoken

Search by task priority

Task.priority
requesterreference

Search by task requester

Task.requester.agent
statustoken

Search by task status

Task.status
statusreasontoken

Search by status reason

Task.statusReason
subjectreference

Search by subject

Task.for
TestReport
identifiertoken

External identifier

TestReport.identifier
issueddate

When the TestScript was executed and this TestReport was generated

TestReport.issued
namestring

Informal name of the executed TestScript

TestReport.name
participanturi

The uri of the participant. An absolute URL is preferred

TestReport.participant.uri
testerstring

Name of the tester producing this report (Organization or individual)

TestReport.tester
testscriptreference

Reference to the version-specific TestScript that was executed to produce this TestReport

TestReport.testScript
TestScript
datedate

The test script publication date

TestScript.date
descriptionstring

Text search against the description of the test script

TestScript.description
identifiertoken

External identifiers for the test script

TestScript.identifier
jurisdictiontoken

Intended jurisdiction for test script

TestScript.jurisdiction
namestring

Name of the test script

TestScript.name
publisherstring

Name of the publisher of the test script

TestScript.publisher
statustoken

The current status of the test script

TestScript.status
testscript-capabilitystring

TestScript required and validated capability

TestScript.metadata.capability.description
titlestring

Text search against the title of the test script

TestScript.title
urluri

The uri that identifies the test script

TestScript.url
versiontoken

The version identifier of the test script

TestScript.version
ValueSet
datedate

The value set publication date

ValueSet.date
descriptionstring

Text search against the description of the value set

ValueSet.description
expansionuri

Uniquely identifies this expansion

ValueSet.expansion.identifier
identifiertoken

External identifiers for the value set

ValueSet.identifier
jurisdictiontoken

Intended jurisdiction for value set

ValueSet.jurisdiction
namestring

Name of the value set

ValueSet.name
publisherstring

Name of the publisher of the value set

ValueSet.publisher
referenceuri

A code system included or excluded in the value set or an imported value set

ValueSet.compose.include.system
statustoken

The current status of the value set

ValueSet.status
titlestring

Text search against the title of the value set

ValueSet.title
urluri

The uri that identifies the value set

ValueSet.url
versiontoken

The version identifier of the value set

ValueSet.version
VisionPrescription
datewrittendate

Return prescriptions written on this date

VisionPrescription.dateWritten
encounterreference

Return prescriptions with this encounter identifier

VisionPrescription.encounter
identifiertoken

Return prescriptions with this external identifier

VisionPrescription.identifier
patientreference

The identity of a patient to list dispenses for

VisionPrescription.patient
prescriberreference

Who authorizes the vision product

VisionPrescription.prescriber