This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 4.0.1. For a full list of available versions, see the Directory of published versions
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 | |||
_content | string | Search on the entire content of the resource | |
_id | token | Logical id of this artifact | Resource.id |
_lastUpdated | date | When the resource version last changed | Resource.meta.lastUpdated |
_profile | uri | Profiles this resource claims to conform to | Resource.meta.profile |
_query | token | A custom search profile that describes a specific defined query operation | |
_security | token | Security Labels applied to this resource | Resource.meta.security |
_tag | token | Tags applied to this resource | Resource.meta.tag |
DomainResource | |||
_text | string | Search on the narrative of the resource | |
Common Search Parameters | |||
address | string | Multiple Resources:
| 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.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 | DeviceRequest.code.as(CodeableConcept) | AllergyIntolerance.code | AllergyIntolerance.reaction.substance | Procedure.code | List.code | ProcedureRequest.code | Observation.code | DiagnosticReport.code | Condition.code |
date | date | Multiple Resources:
| Consent.dateTime | SupplyRequest.authoredOn | 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 |
token | Multiple Resources:
| PractitionerRole.telecom.where(system='email') | RelatedPerson.telecom.where(system='email') | Practitioner.telecom.where(system='email') | Person.telecom.where(system='email') | Patient.telecom.where(system='email') | |
encounter | reference | Multiple Resources:
| DocumentReference.context.encounter | RiskAssessment.context | DeviceRequest.context | Procedure.context | List.encounter | VisionPrescription.encounter | ProcedureRequest.context | Flag.encounter | Observation.context | DiagnosticReport.context | NutritionOrder.encounter | Composition.encounter |
family | string | Multiple Resources:
| Practitioner.name.family | Patient.name.family |
gender | token | Multiple Resources:
| RelatedPerson.gender | Practitioner.gender | Person.gender | Patient.gender |
given | string | Multiple Resources:
| 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 | DeviceRequest.identifier | AllergyIntolerance.identifier | CarePlan.identifier | EpisodeOfCare.identifier | Procedure.identifier | List.identifier | Immunization.identifier | VisionPrescription.identifier | ProcedureRequest.identifier | Observation.identifier | DiagnosticReport.identifier | NutritionOrder.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.subject | DocumentManifest.subject | Goal.subject | Consent.patient | DocumentReference.subject | ImagingManifest.patient | RiskAssessment.subject | CareTeam.subject | ImagingStudy.patient | FamilyMemberHistory.patient | Encounter.subject | DeviceUseStatement.subject | DeviceRequest.subject | AllergyIntolerance.patient | CarePlan.subject | EpisodeOfCare.patient | Procedure.subject | List.subject | Immunization.patient | VisionPrescription.patient | ProcedureRequest.subject | Flag.subject | Observation.subject | DiagnosticReport.subject | NutritionOrder.patient | Condition.subject | Composition.subject | DetectedIssue.patient | SupplyDelivery.patient | ClinicalImpression.subject |
patient | reference | Multiple Resources:
| MedicationRequest.subject | MedicationAdministration.subject | MedicationStatement.subject | MedicationDispense.subject |
phone | token | Multiple Resources:
| PractitionerRole.telecom.where(system='phone') | RelatedPerson.telecom.where(system='phone') | Practitioner.telecom.where(system='phone') | Person.telecom.where(system='phone') | Patient.telecom.where(system='phone') |
phonetic | string | Multiple Resources:
| 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 | Person.telecom | Patient.telecom |
type | token | Multiple Resources:
| ReferralRequest.type | DocumentManifest.type | DocumentReference.type | Encounter.type | AllergyIntolerance.type | EpisodeOfCare.type | Composition.type |
Account | |||
balance | quantity | How much is in account? | Account.balance |
identifier | token | Account number | Account.identifier |
name | string | Human-readable label | Account.name |
owner | reference | Who is responsible? | Account.owner |
patient | reference | What is account tied to? | Account.subject |
period | date | Transaction window | Account.period |
status | token | active | inactive | entered-in-error | Account.status |
subject | reference | What is account tied to? | Account.subject |
type | token | E.g. patient, expense, depreciation | Account.type |
ActivityDefinition | |||
composed-of | reference | What resource is being referenced | ActivityDefinition.relatedArtifact.where(type='composed-of').resource |
date | date | The activity definition publication date | ActivityDefinition.date |
depends-on | reference | What resource is being referenced | ActivityDefinition.relatedArtifact.where(type='depends-on').resource | ActivityDefinition.library |
derived-from | reference | What resource is being referenced | ActivityDefinition.relatedArtifact.where(type='derived-from').resource |
description | string | The description of the activity definition | ActivityDefinition.description |
effective | date | The time during which the activity definition is intended to be in use | ActivityDefinition.effectivePeriod |
identifier | token | External identifier for the activity definition | ActivityDefinition.identifier |
jurisdiction | token | Intended jurisdiction for the activity definition | ActivityDefinition.jurisdiction |
name | string | Computationally friendly name of the activity definition | ActivityDefinition.name |
predecessor | reference | What resource is being referenced | ActivityDefinition.relatedArtifact.where(type='predecessor').resource |
publisher | string | Name of the publisher of the activity definition | ActivityDefinition.publisher |
status | token | The current status of the activity definition | ActivityDefinition.status |
successor | reference | What resource is being referenced | ActivityDefinition.relatedArtifact.where(type='successor').resource |
title | string | The human-friendly name of the activity definition | ActivityDefinition.title |
topic | token | Topics associated with the module | ActivityDefinition.topic |
url | uri | The uri that identifies the activity definition | ActivityDefinition.url |
version | token | The business version of the activity definition | ActivityDefinition.version |
AdverseEvent | |||
category | token | AE | PAE An adverse event is an event that caused harm to a patient, an adverse reaction is a something that is a subject-specific event that is a result of an exposure to a medication, food, device or environmental substance, a potential adverse event is something that occurred and that could have caused harm to a patient but did not | AdverseEvent.category |
date | date | When the event occurred | AdverseEvent.date |
location | reference | Location where adverse event occurred | AdverseEvent.location |
reaction | reference | Adverse Reaction Events linked to exposure to substance | AdverseEvent.reaction |
recorder | reference | Who recorded the adverse event | AdverseEvent.recorder |
seriousness | token | Mild | Moderate | Severe | AdverseEvent.seriousness |
study | reference | AdverseEvent.study | AdverseEvent.study |
subject | reference | Subject or group impacted by event | AdverseEvent.subject |
substance | reference | Refers to the specific entity that caused the adverse event | AdverseEvent.suspectEntity.instance |
type | token | actual | potential | AdverseEvent.type |
AllergyIntolerance | |||
asserter | reference | Source of the information about the allergy | AllergyIntolerance.asserter |
category | token | food | medication | environment | biologic | AllergyIntolerance.category |
clinical-status | token | active | inactive | resolved | AllergyIntolerance.clinicalStatus |
code | token | Code that identifies the allergy or intolerance | AllergyIntolerance.code | AllergyIntolerance.reaction.substance |
criticality | token | low | high | unable-to-assess | AllergyIntolerance.criticality |
date | date | Date record was believed accurate | AllergyIntolerance.assertedDate |
identifier | token | External ids for this item | AllergyIntolerance.identifier |
last-date | date | Date(/time) of last known occurrence of a reaction | AllergyIntolerance.lastOccurrence |
manifestation | token | Clinical symptoms/signs associated with the Event | AllergyIntolerance.reaction.manifestation |
onset | date | Date(/time) when manifestations showed | AllergyIntolerance.reaction.onset |
patient | reference | Who the sensitivity is for | AllergyIntolerance.patient |
recorder | reference | Who recorded the sensitivity | AllergyIntolerance.recorder |
route | token | How the subject was exposed to the substance | AllergyIntolerance.reaction.exposureRoute |
severity | token | mild | moderate | severe (of event as a whole) | AllergyIntolerance.reaction.severity |
type | token | allergy | intolerance - Underlying mechanism (if known) | AllergyIntolerance.type |
verification-status | token | unconfirmed | confirmed | refuted | entered-in-error | AllergyIntolerance.verificationStatus |
Appointment | |||
actor | reference | Any one of the individuals participating in the appointment | Appointment.participant.actor |
appointment-type | token | The style of appointment or patient that has been booked in the slot (not service type) | Appointment.appointmentType |
date | date | Appointment date/time. | Appointment.start |
identifier | token | An Identifier of the Appointment | Appointment.identifier |
incomingreferral | reference | The ReferralRequest provided as information to allocate to the Encounter | Appointment.incomingReferral |
location | reference | This location is listed in the participants of the appointment | Appointment.participant.actor |
part-status | token | The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests. | Appointment.participant.status |
patient | reference | One of the individuals of the appointment is this patient | Appointment.participant.actor |
practitioner | reference | One of the individuals of the appointment is this practitioner | Appointment.participant.actor |
service-type | token | The specific service that is to be performed during this appointment | Appointment.serviceType |
status | token | The overall status of the appointment | Appointment.status |
AppointmentResponse | |||
actor | reference | The Person, Location/HealthcareService or Device that this appointment response replies for | AppointmentResponse.actor |
appointment | reference | The appointment that the response is attached to | AppointmentResponse.appointment |
identifier | token | An Identifier in this appointment response | AppointmentResponse.identifier |
location | reference | This Response is for this Location | AppointmentResponse.actor |
part-status | token | The participants acceptance status for this appointment | AppointmentResponse.participantStatus |
patient | reference | This Response is for this Patient | AppointmentResponse.actor |
practitioner | reference | This Response is for this Practitioner | AppointmentResponse.actor |
AuditEvent | |||
action | token | Type of action performed during the event | AuditEvent.action |
address | string | Identifier for the network access point of the user device | AuditEvent.agent.network.address |
agent | reference | Direct reference to resource | AuditEvent.agent.reference |
agent-name | string | Human-meaningful name for the agent | AuditEvent.agent.name |
agent-role | token | Agent role in the event | AuditEvent.agent.role |
altid | token | Alternative User id e.g. authentication | AuditEvent.agent.altId |
date | date | Time when the event occurred on source | AuditEvent.recorded |
entity | reference | Specific instance of resource | AuditEvent.entity.reference |
entity-id | token | Specific instance of object | AuditEvent.entity.identifier |
entity-name | string | Descriptor for entity | AuditEvent.entity.name |
entity-role | token | What role the entity played | AuditEvent.entity.role |
entity-type | token | Type of entity involved | AuditEvent.entity.type |
outcome | token | Whether the event succeeded or failed | AuditEvent.outcome |
patient | reference | Direct reference to resource | AuditEvent.agent.reference | AuditEvent.entity.reference |
policy | uri | Policy that authorized event | AuditEvent.agent.policy |
site | token | Logical source location within the enterprise | AuditEvent.source.site |
source | token | The identity of source detecting the event | AuditEvent.source.identifier |
subtype | token | More specific type/id for the event | AuditEvent.subtype |
type | token | Type/identifier of event | AuditEvent.type |
user | token | Unique identifier for the user | AuditEvent.agent.userId |
Basic | |||
author | reference | Who created | Basic.author |
code | token | Kind of Resource | Basic.code |
created | date | When created | Basic.created |
identifier | token | Business identifier | Basic.identifier |
patient | reference | Identifies the focus of this resource | Basic.subject |
subject | reference | Identifies the focus of this resource | Basic.subject |
Binary | |||
contenttype | token | MimeType of the binary content | Binary.contentType |
BodySite | |||
code | token | Named anatomical location | BodySite.code |
identifier | token | Identifier for this instance of the anatomical location | BodySite.identifier |
patient | reference | Patient to whom bodysite belongs | BodySite.patient |
Bundle | |||
composition | reference | 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 |
identifier | token | Persistent identifier for the bundle | Bundle.identifier |
message | reference | 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 |
type | token | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | Bundle.type |
CapabilityStatement | |||
date | date | The capability statement publication date | CapabilityStatement.date |
description | string | The description of the capability statement | CapabilityStatement.description |
event | token | Event code in a capability statement | CapabilityStatement.messaging.event.code |
fhirversion | token | The version of FHIR | CapabilityStatement.version |
format | token | formats supported (xml | json | ttl | mime type) | CapabilityStatement.format |
guide | uri | Implementation guides supported | CapabilityStatement.implementationGuide |
jurisdiction | token | Intended jurisdiction for the capability statement | CapabilityStatement.jurisdiction |
mode | token | Mode - restful (server/client) or messaging (sender/receiver) | CapabilityStatement.rest.mode |
name | string | Computationally friendly name of the capability statement | CapabilityStatement.name |
publisher | string | Name of the publisher of the capability statement | CapabilityStatement.publisher |
resource | token | Name of a resource mentioned in a capability statement | CapabilityStatement.rest.resource.type |
resource-profile | reference | A profile id invoked in a capability statement | CapabilityStatement.rest.resource.profile |
security-service | token | OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates | CapabilityStatement.rest.security.service |
software | string | Part of a the name of a software application | CapabilityStatement.software.name |
status | token | The current status of the capability statement | CapabilityStatement.status |
supported-profile | reference | Profiles for use cases supported | CapabilityStatement.profile |
title | string | The human-friendly name of the capability statement | CapabilityStatement.title |
url | uri | The uri that identifies the capability statement | CapabilityStatement.url |
version | token | The business version of the capability statement | CapabilityStatement.version |
CarePlan | |||
activity-code | token | Detail type of activity | CarePlan.activity.detail.code |
activity-date | date | Specified date occurs within period specified by CarePlan.activity.timingSchedule | CarePlan.activity.detail.scheduled |
activity-reference | reference | Activity details defined in specific resource | CarePlan.activity.reference |
based-on | reference | Fulfills care plan | CarePlan.basedOn |
care-team | reference | Who's involved in plan? | CarePlan.careTeam |
category | token | Type of plan | CarePlan.category |
condition | reference | Health issues this plan addresses | CarePlan.addresses |
context | reference | Created in context of | CarePlan.context |
date | date | Time period plan covers | CarePlan.period |
definition | reference | Protocol or definition | CarePlan.definition |
encounter | reference | Created in context of | CarePlan.context |
goal | reference | Desired outcome of plan | CarePlan.goal |
identifier | token | External Ids for this plan | CarePlan.identifier |
intent | token | proposal | plan | order | option | CarePlan.intent |
part-of | reference | Part of referenced CarePlan | CarePlan.partOf |
patient | reference | Who care plan is for | CarePlan.subject |
performer | reference | Matches if the practitioner is listed as a performer in any of the "simple" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.) | CarePlan.activity.detail.performer |
replaces | reference | CarePlan replaced by this CarePlan | CarePlan.replaces |
status | token | draft | active | suspended | completed | entered-in-error | cancelled | unknown | CarePlan.status |
subject | reference | Who care plan is for | CarePlan.subject |
CareTeam | |||
category | token | Type of team | CareTeam.category |
context | reference | Encounter or episode associated with CareTeam | CareTeam.context |
date | date | Time period team covers | CareTeam.period |
encounter | reference | Encounter or episode associated with CareTeam | CareTeam.context |
identifier | token | External Ids for this team | CareTeam.identifier |
participant | reference | Who is involved | CareTeam.participant.member |
patient | reference | Who care team is for | CareTeam.subject |
status | token | proposed | active | suspended | inactive | entered-in-error | CareTeam.status |
subject | reference | Who care team is for | CareTeam.subject |
ChargeItem | |||
account | reference | Account to place this charge | ChargeItem.account |
code | token | A code that identifies the charge, like a billing code | ChargeItem.code |
context | reference | Encounter / Episode associated with event | ChargeItem.context |
entered-date | date | Date the charge item was entered | ChargeItem.enteredDate |
enterer | reference | Individual who was entering | ChargeItem.enterer |
factor-override | number | Factor overriding the associated rules | ChargeItem.factorOverride |
identifier | token | Business Identifier for item | ChargeItem.identifier |
occurrence | date | When the charged service was applied | ChargeItem.occurrence |
participant-actor | reference | Individual who was performing | ChargeItem.participant.actor |
participant-role | token | What type of performance was done | ChargeItem.participant.role |
patient | reference | Individual service was done for/to | ChargeItem.subject |
performing-organization | reference | Organization providing the charged sevice | ChargeItem.performingOrganization |
price-override | quantity | Price overriding the associated rules | ChargeItem.priceOverride |
quantity | quantity | Quantity of which the charge item has been serviced | ChargeItem.quantity |
requesting-organization | reference | Organization requesting the charged service | ChargeItem.requestingOrganization |
service | reference | Which rendered service is being charged? | ChargeItem.service |
subject | reference | Individual service was done for/to | ChargeItem.subject |
Claim | |||
care-team | reference | Member of the CareTeam | Claim.careTeam.provider |
created | date | The creation date for the Claim | Claim.created |
encounter | reference | Encounters associated with a billed line item | Claim.item.encounter |
enterer | reference | The party responsible for the entry of the Claim | Claim.enterer |
facility | reference | Facility responsible for the goods and services | Claim.facility |
identifier | token | The primary identifier of the financial resource | Claim.identifier |
insurer | reference | The target payor/insurer for the Claim | Claim.insurer |
organization | reference | The reference to the providing organization | Claim.organization |
patient | reference | Patient receiving the services | Claim.patient |
payee | reference | The party receiving any payment for the Claim | Claim.payee.party |
priority | token | Processing priority requested | Claim.priority |
provider | reference | Provider responsible for the Claim | Claim.provider |
use | token | The kind of financial resource | Claim.use |
ClaimResponse | |||
created | date | The creation date | ClaimResponse.created |
disposition | string | The contents of the disposition message | ClaimResponse.disposition |
identifier | token | The identity of the claimresponse | ClaimResponse.identifier |
insurer | reference | The organization who generated this resource | ClaimResponse.insurer |
outcome | token | The processing outcome | ClaimResponse.outcome |
patient | reference | The subject of care. | ClaimResponse.patient |
payment-date | date | The expected paymentDate | ClaimResponse.payment.date |
request | reference | The claim reference | ClaimResponse.request |
request-provider | reference | The Provider of the claim | ClaimResponse.requestProvider |
ClinicalImpression | |||
action | reference | Action taken as part of assessment procedure | ClinicalImpression.action |
assessor | reference | The clinician performing the assessment | ClinicalImpression.assessor |
context | reference | Encounter or Episode created from | ClinicalImpression.context |
date | date | When the assessment was documented | ClinicalImpression.date |
finding-code | token | What was found | ClinicalImpression.finding.item.as(CodeableConcept) |
finding-ref | reference | What was found | ClinicalImpression.finding.item.as(Reference) |
identifier | token | Business identifier | ClinicalImpression.identifier |
investigation | reference | Record of a specific investigation | ClinicalImpression.investigation.item |
patient | reference | Patient or group assessed | ClinicalImpression.subject |
previous | reference | Reference to last assessment | ClinicalImpression.previous |
problem | reference | Relevant impressions of patient state | ClinicalImpression.problem |
status | token | draft | completed | entered-in-error | ClinicalImpression.status |
subject | reference | Patient or group assessed | ClinicalImpression.subject |
CodeSystem | |||
code | token | A code defined in the code system | CodeSystem.concept.code |
content-mode | token | not-present | example | fragment | complete | CodeSystem.content |
date | date | The code system publication date | CodeSystem.date |
description | string | The description of the code system | CodeSystem.description |
identifier | token | External identifier for the code system | CodeSystem.identifier |
jurisdiction | token | Intended jurisdiction for the code system | CodeSystem.jurisdiction |
language | token | A language in which a designation is provided | CodeSystem.concept.designation.language |
name | string | Computationally friendly name of the code system | CodeSystem.name |
publisher | string | Name of the publisher of the code system | CodeSystem.publisher |
status | token | The current status of the code system | CodeSystem.status |
system | uri | The system for any codes defined by this code system (same as 'url') | CodeSystem.url |
title | string | The human-friendly name of the code system | CodeSystem.title |
url | uri | The uri that identifies the code system | CodeSystem.url |
version | token | The business version of the code system | CodeSystem.version |
Communication | |||
based-on | reference | Request fulfilled by this communication | Communication.basedOn |
category | token | Message category | Communication.category |
context | reference | Encounter or episode leading to message | Communication.context |
definition | reference | Instantiates protocol or definition | Communication.definition |
encounter | reference | Encounter leading to message | Communication.context |
identifier | token | Unique identifier | Communication.identifier |
medium | token | A channel of communication | Communication.medium |
part-of | reference | Part of this action | Communication.partOf |
patient | reference | Focus of message | Communication.subject |
received | date | When received | Communication.received |
recipient | reference | Message recipient | Communication.recipient |
sender | reference | Message sender | Communication.sender |
sent | date | When sent | Communication.sent |
status | token | preparation | in-progress | suspended | aborted | completed | entered-in-error | Communication.status |
subject | reference | Focus of message | Communication.subject |
CommunicationRequest | |||
authored | date | When request transitioned to being actionable | CommunicationRequest.authoredOn |
based-on | reference | Fulfills plan or proposal | CommunicationRequest.basedOn |
category | token | Message category | CommunicationRequest.category |
context | reference | Encounter or episode leading to message | CommunicationRequest.context |
encounter | reference | Encounter leading to message | CommunicationRequest.context |
group-identifier | token | Composite request this is part of | CommunicationRequest.groupIdentifier |
identifier | token | Unique identifier | CommunicationRequest.identifier |
medium | token | A channel of communication | CommunicationRequest.medium |
occurrence | date | When scheduled | CommunicationRequest.occurrence.as(DateTime) |
patient | reference | Focus of message | CommunicationRequest.subject |
priority | token | Message urgency | CommunicationRequest.priority |
recipient | reference | Message recipient | CommunicationRequest.recipient |
replaces | reference | Request(s) replaced by this request | CommunicationRequest.replaces |
requester | reference | Individual making the request | CommunicationRequest.requester.agent |
sender | reference | Message sender | CommunicationRequest.sender |
status | token | draft | active | suspended | cancelled | completed | entered-in-error | unknown | CommunicationRequest.status |
subject | reference | Focus of message | CommunicationRequest.subject |
CompartmentDefinition | |||
code | token | Patient | Encounter | RelatedPerson | Practitioner | Device | CompartmentDefinition.code |
date | date | The compartment definition publication date | CompartmentDefinition.date |
description | string | The description of the compartment definition | CompartmentDefinition.description |
jurisdiction | token | Intended jurisdiction for the compartment definition | CompartmentDefinition.jurisdiction |
name | string | Computationally friendly name of the compartment definition | CompartmentDefinition.name |
publisher | string | Name of the publisher of the compartment definition | CompartmentDefinition.publisher |
resource | token | Name of resource type | CompartmentDefinition.resource.code |
status | token | The current status of the compartment definition | CompartmentDefinition.status |
title | string | The human-friendly name of the compartment definition | CompartmentDefinition.title |
url | uri | The uri that identifies the compartment definition | CompartmentDefinition.url |
Composition | |||
attester | reference | Who attested the composition | Composition.attester.party |
author | reference | Who and/or what authored the composition | Composition.author |
class | token | Categorization of Composition | Composition.class |
confidentiality | token | As defined by affinity domain | Composition.confidentiality |
context | token | Code(s) that apply to the event being documented | Composition.event.code |
date | date | Composition editing time | Composition.date |
encounter | reference | Context of the Composition | Composition.encounter |
entry | reference | A reference to data that supports this section | Composition.section.entry |
identifier | token | Logical identifier of composition (version-independent) | Composition.identifier |
patient | reference | Who and/or what the composition is about | Composition.subject |
period | date | The period covered by the documentation | Composition.event.period |
related-id | token | Target of the relationship | Composition.relatesTo.target.as(Identifier) |
related-ref | reference | Target of the relationship | Composition.relatesTo.target.as(Reference) |
section | token | Classification of section (recommended) | Composition.section.code |
status | token | preliminary | final | amended | entered-in-error | Composition.status |
subject | reference | Who and/or what the composition is about | Composition.subject |
title | string | Human Readable name/title | Composition.title |
type | token | Kind of composition (LOINC if possible) | Composition.type |
ConceptMap | |||
date | date | The concept map publication date | ConceptMap.date |
dependson | uri | Reference to property mapping depends on | ConceptMap.group.element.target.dependsOn.property |
description | string | The description of the concept map | ConceptMap.description |
identifier | token | External identifier for the concept map | ConceptMap.identifier |
jurisdiction | token | Intended jurisdiction for the concept map | ConceptMap.jurisdiction |
name | string | Computationally friendly name of the concept map | ConceptMap.name |
other | uri | Canonical URL for other concept map | ConceptMap.group.unmapped.url |
product | uri | Reference to property mapping depends on | ConceptMap.group.element.target.product.property |
publisher | string | Name of the publisher of the concept map | ConceptMap.publisher |
source | reference | Identifies the source of the concepts which are being mapped | ConceptMap.source.as(Reference) |
source-code | token | Identifies element being mapped | ConceptMap.group.element.code |
source-system | uri | Code System (if value set crosses code systems) | ConceptMap.group.source |
source-uri | reference | Identifies the source of the concepts which are being mapped | ConceptMap.source.as(Uri) |
status | token | The current status of the concept map | ConceptMap.status |
target | reference | Provides context to the mappings | ConceptMap.target.as(Reference) |
target-code | token | Code that identifies the target element | ConceptMap.group.element.target.code |
target-system | uri | System of the target (if necessary) | ConceptMap.group.target |
target-uri | reference | Provides context to the mappings | ConceptMap.target.as(Uri) |
title | string | The human-friendly name of the concept map | ConceptMap.title |
url | uri | The uri that identifies the concept map | ConceptMap.url |
version | token | The business version of the concept map | ConceptMap.version |
Condition | |||
abatement-age | quantity | Abatement as age or age range | Condition.abatement.as(Age) | Condition.abatement.as(Range) | Condition.abatement.as(Age) |
abatement-boolean | token | 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-date | date | Date-related abatements (dateTime and period) | Condition.abatement.as(dateTime) | Condition.abatement.as(Period) |
abatement-string | string | Abatement as a string | Condition.abatement.as(string) |
asserted-date | date | Date record was believed accurate | Condition.assertedDate |
asserter | reference | Person who asserts this condition | Condition.asserter |
body-site | token | Anatomical location, if relevant | Condition.bodySite |
category | token | The category of the condition | Condition.category |
clinical-status | token | The clinical status of the condition | Condition.clinicalStatus |
code | token | Code for the condition | Condition.code |
context | reference | Encounter or episode when condition first asserted | Condition.context |
encounter | reference | Encounter when condition first asserted | Condition.context |
evidence | token | Manifestation/symptom | Condition.evidence.code |
evidence-detail | reference | Supporting information found elsewhere | Condition.evidence.detail |
identifier | token | A unique identifier of the condition record | Condition.identifier |
onset-age | quantity | Onsets as age or age range | Condition.onset.as(Age) | Condition.onset.as(Range) |
onset-date | date | Date related onsets (dateTime and Period) | Condition.onset.as(dateTime) | Condition.onset.as(Period) |
onset-info | string | Onsets as a string | Condition.onset.as(string) |
patient | reference | Who has the condition? | Condition.subject |
severity | token | The severity of the condition | Condition.severity |
stage | token | Simple summary (disease specific) | Condition.stage.summary |
subject | reference | Who has the condition? | Condition.subject |
verification-status | token | provisional | differential | confirmed | refuted | entered-in-error | unknown | Condition.verificationStatus |
Consent | |||
action | token | Actions controlled by this consent | Consent.action | Consent.except.action |
actor | reference | Resource for the actor (or group, by role) | Consent.actor.reference | Consent.except.actor.reference |
category | token | Classification of the consent statement - for indexing/retrieval | Consent.category |
consentor | reference | Who is agreeing to the policy and exceptions | Consent.consentingParty |
data | reference | The actual data reference | Consent.data.reference | Consent.except.data.reference |
date | date | When this Consent was created or indexed | Consent.dateTime |
identifier | token | Identifier for this record (external references) | Consent.identifier |
organization | reference | Custodian of the consent | Consent.organization |
patient | reference | Who the consent applies to | Consent.patient |
period | date | Period that this consent applies | Consent.period |
purpose | token | Context of activities for which the agreement is made | Consent.purpose | Consent.except.purpose |
securitylabel | token | Security Labels that define affected resources | Consent.securityLabel | Consent.except.securityLabel |
source | reference | Source from which this consent is taken | Consent.source |
status | token | draft | proposed | active | rejected | inactive | entered-in-error | Consent.status |
Contract | |||
agent | reference | Agent to the Contact | Contract.agent.actor |
authority | reference | The authority of the contract | Contract.authority |
domain | reference | The domain of the contract | Contract.domain |
identifier | token | The identity of the contract | Contract.identifier |
issued | date | The date/time the contract was issued | Contract.issued |
patient | reference | The identity of the subject of the contract (if a patient) | Contract.subject |
signer | reference | Contract Signatory Party | Contract.signer.party |
subject | reference | The identity of the subject of the contract | Contract.subject |
term-topic | reference | The identity of the topic of the contract terms | Contract.term.topic |
Coverage | |||
beneficiary | reference | Covered party | Coverage.beneficiary |
class | string | Class identifier | Coverage.grouping.class |
dependent | string | Dependent number | Coverage.dependent |
group | string | Group identifier | Coverage.grouping.group |
identifier | token | The primary identifier of the insured and the coverage | Coverage.identifier |
payor | reference | The identity of the insurer or party paying for services | Coverage.payor |
plan | string | A plan or policy identifier | Coverage.grouping.plan |
policy-holder | reference | Reference to the policyholder | Coverage.policyHolder |
sequence | string | Sequence number | Coverage.sequence |
subclass | string | Sub-class identifier | Coverage.grouping.subClass |
subgroup | string | Sub-group identifier | Coverage.grouping.subGroup |
subplan | string | Sub-plan identifier | Coverage.grouping.subPlan |
subscriber | reference | Reference to the subscriber | Coverage.subscriber |
type | token | The kind of coverage (health plan, auto, Workers Compensation) | Coverage.type |
DataElement | |||
code | token | A code for the data element (server may choose to do subsumption) | DataElement.element.code |
date | date | The data element publication date | DataElement.date |
description | string | Text search in the description of the data element. This corresponds to the definition of the first DataElement.element. | DataElement.element.definition |
identifier | token | External identifier for the data element | DataElement.identifier |
jurisdiction | token | Intended jurisdiction for the data element | DataElement.jurisdiction |
name | string | Computationally friendly name of the data element | DataElement.name |
objectClass | token | Matches on the 11179-objectClass extension value | |
objectClassProperty | token | Matches on the 11179-objectClassProperty extension value | |
publisher | string | Name of the publisher of the data element | DataElement.publisher |
status | token | The current status of the data element | DataElement.status |
stringency | token | The stringency of the data element definition | DataElement.stringency |
title | string | The human-friendly name of the data element | DataElement.title |
url | uri | The uri that identifies the data element | DataElement.url |
version | token | The business version of the data element | DataElement.version |
DetectedIssue | |||
author | reference | The provider or device that identified the issue | DetectedIssue.author |
category | token | Issue Category, e.g. drug-drug, duplicate therapy, etc. | DetectedIssue.category |
date | date | When identified | DetectedIssue.date |
identifier | token | Unique id for the detected issue | DetectedIssue.identifier |
implicated | reference | Problem resource | DetectedIssue.implicated |
patient | reference | Associated patient | DetectedIssue.patient |
Device | |||
device-name | string | A server defined search that may match any of the string fields in the Device.udi.name or Device.type.coding.display or Device.type.text | Device.udi.name | Device.type.text | Device.type.coding.display |
identifier | token | Instance id from manufacturer, owner, and others | Device.identifier |
location | reference | A location, where the resource is found | Device.location |
manufacturer | string | The manufacturer of the device | Device.manufacturer |
model | string | The model of the device | Device.model |
organization | reference | The organization responsible for the device | Device.owner |
patient | reference | Patient information, if the resource is affixed to a person | Device.patient |
status | token | active | inactive | entered-in-error | unknown | Device.status |
type | token | The type of the device | Device.type |
udi-carrier | string | UDI Barcode (RFID or other technology) string either in HRF format or AIDC format converted to base64 string. | Device.udi.carrierHRF | Device.udi.carrierAIDC |
udi-di | string | The udi Device Identifier (DI) | Device.udi.deviceIdentifier |
url | uri | Network address to contact device | Device.url |
DeviceComponent | |||
identifier | token | The identifier of the component | DeviceComponent.identifier |
parent | reference | The parent DeviceComponent resource | DeviceComponent.parent |
source | reference | The device source | DeviceComponent.source |
type | token | The device component type | DeviceComponent.type |
DeviceMetric | |||
category | token | The category of the metric | DeviceMetric.category |
identifier | token | The identifier of the metric | DeviceMetric.identifier |
parent | reference | The parent DeviceMetric resource | DeviceMetric.parent |
source | reference | The device resource | DeviceMetric.source |
type | token | The component type | DeviceMetric.type |
DeviceRequest | |||
authored-on | date | When the request transitioned to being actionable | DeviceRequest.authoredOn |
based-on | reference | Plan/proposal/order fulfilled by this request | DeviceRequest.basedOn |
code | token | Code for what is being requested/ordered | DeviceRequest.code.as(CodeableConcept) |
definition | reference | Protocol or definition followed by this request | DeviceRequest.definition |
device | reference | Reference to resource that is being requested/ordered | DeviceRequest.code.as(Reference) |
encounter | reference | Encounter or Episode during which request was created | DeviceRequest.context |
event-date | date | When service should occur | DeviceRequest.occurrence.as(DateTime) | DeviceRequest.occurrence.as(Period) |
group-identifier | token | Composite request this is part of | DeviceRequest.groupIdentifier |
identifier | token | Business identifier for request/order | DeviceRequest.identifier |
intent | token | proposal | plan | original-order |reflex-order | DeviceRequest.intent |
patient | reference | Individual the service is ordered for | DeviceRequest.subject |
performer | reference | Desired performer for service | DeviceRequest.performer |
priorrequest | reference | Request takes the place of referenced completed or terminated requests | DeviceRequest.priorRequest |
requester | reference | Who/what is requesting service | DeviceRequest.requester.agent |
status | token | entered-in-error | draft | active |suspended | completed | DeviceRequest.status |
subject | reference | Individual the service is ordered for | DeviceRequest.subject |
DeviceUseStatement | |||
device | reference | Search by device | DeviceUseStatement.device |
identifier | token | Search by identifier | DeviceUseStatement.identifier |
patient | reference | Search by subject - a patient | DeviceUseStatement.subject |
subject | reference | Search by subject | DeviceUseStatement.subject |
DiagnosticReport | |||
based-on | reference | Reference to the procedure request. | DiagnosticReport.basedOn |
category | token | Which diagnostic discipline/department created the report | DiagnosticReport.category |
code | token | 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 |
context | reference | Healthcare event (Episode of Care or Encounter) related to the report | DiagnosticReport.context |
date | date | The clinically relevant time of the report | DiagnosticReport.effective |
diagnosis | token | A coded diagnosis on the report | DiagnosticReport.codedDiagnosis |
encounter | reference | The Encounter when the order was made | DiagnosticReport.context |
identifier | token | An identifier for the report | DiagnosticReport.identifier |
image | reference | A reference to the image source. | DiagnosticReport.image.link |
issued | date | When the report was issued | DiagnosticReport.issued |
patient | reference | The subject of the report if a patient | DiagnosticReport.subject |
performer | reference | Who was the source of the report (organization) | DiagnosticReport.performer.actor |
result | reference | Link to an atomic result (observation resource) | DiagnosticReport.result |
specimen | reference | The specimen details | DiagnosticReport.specimen |
status | token | The status of the report | DiagnosticReport.status |
subject | reference | The subject of the report | DiagnosticReport.subject |
DocumentManifest | |||
author | reference | Who and/or what authored the manifest | DocumentManifest.author |
content-ref | reference | Contents of this set of documents | DocumentManifest.content.p.as(Reference) |
created | date | When this document manifest created | DocumentManifest.created |
description | string | Human-readable description (title) | DocumentManifest.description |
identifier | token | Unique Identifier for the set of documents | DocumentManifest.masterIdentifier | DocumentManifest.identifier |
patient | reference | The subject of the set of documents | DocumentManifest.subject |
recipient | reference | Intended to get notified about this set of documents | DocumentManifest.recipient |
related-id | token | Identifiers of things that are related | DocumentManifest.related.identifier |
related-ref | reference | Related Resource | DocumentManifest.related.ref |
source | uri | The source system/application/software | DocumentManifest.source |
status | token | current | superseded | entered-in-error | DocumentManifest.status |
subject | reference | The subject of the set of documents | DocumentManifest.subject |
type | token | Kind of document set | DocumentManifest.type |
DocumentReference | |||
authenticator | reference | Who/what authenticated the document | DocumentReference.authenticator |
author | reference | Who and/or what authored the document | DocumentReference.author |
class | token | Categorization of document | DocumentReference.class |
created | date | Document creation time | DocumentReference.created |
custodian | reference | Organization which maintains the document | DocumentReference.custodian |
description | string | Human-readable description (title) | DocumentReference.description |
encounter | reference | Context of the document content | DocumentReference.context.encounter |
event | token | Main clinical acts documented | DocumentReference.context.event |
facility | token | Kind of facility where patient was seen | DocumentReference.context.facilityType |
format | token | Format/content rules for the document | DocumentReference.content.format |
identifier | token | Master Version Specific Identifier | DocumentReference.masterIdentifier | DocumentReference.identifier |
indexed | date | When this document reference was created | DocumentReference.indexed |
language | token | Human language of the content (BCP-47) | DocumentReference.content.attachment.language |
location | uri | Uri where the data can be found | DocumentReference.content.attachment.url |
patient | reference | Who/what is the subject of the document | DocumentReference.subject |
period | date | Time of service that is being documented | DocumentReference.context.period |
related-id | token | Identifier of related objects or events | DocumentReference.context.related.identifier |
related-ref | reference | Related Resource | DocumentReference.context.related.ref |
relatesto | reference | Target of the relationship | DocumentReference.relatesTo.target |
relation | token | replaces | transforms | signs | appends | DocumentReference.relatesTo.code |
relationship | composite | Combination of relation and relatesTo | DocumentReference.relatesTo |
securitylabel | token | Document security-tags | DocumentReference.securityLabel |
setting | token | Additional details about where the content was created (e.g. clinical specialty) | DocumentReference.context.practiceSetting |
status | token | current | superseded | entered-in-error | DocumentReference.status |
subject | reference | Who/what is the subject of the document | DocumentReference.subject |
type | token | Kind of document (LOINC if possible) | DocumentReference.type |
EligibilityRequest | |||
created | date | The creation date for the EOB | EligibilityRequest.created |
enterer | reference | The party who is responsible for the request | EligibilityRequest.enterer |
facility | reference | Facility responsible for the goods and services | EligibilityRequest.facility |
identifier | token | The business identifier of the Eligibility | EligibilityRequest.identifier |
organization | reference | The reference to the providing organization | EligibilityRequest.organization |
patient | reference | The reference to the patient | EligibilityRequest.patient |
provider | reference | The reference to the provider | EligibilityRequest.provider |
EligibilityResponse | |||
created | date | The creation date | EligibilityResponse.created |
disposition | string | The contents of the disposition message | EligibilityResponse.disposition |
identifier | token | The business identifier | EligibilityResponse.identifier |
insurer | reference | The organization which generated this resource | EligibilityResponse.insurer |
outcome | token | The processing outcome | EligibilityResponse.outcome |
request | reference | The EligibilityRequest reference | EligibilityResponse.request |
request-organization | reference | The EligibilityRequest organization | EligibilityResponse.requestOrganization |
request-provider | reference | The EligibilityRequest provider | EligibilityResponse.requestProvider |
Encounter | |||
appointment | reference | The appointment that scheduled this encounter | Encounter.appointment |
class | token | inpatient | outpatient | ambulatory | emergency + | Encounter.class |
date | date | A date within the period the Encounter lasted | Encounter.period |
diagnosis | reference | Reason the encounter takes place (resource) | Encounter.diagnosis.condition |
episodeofcare | reference | Episode(s) of care that this encounter should be recorded against | Encounter.episodeOfCare |
identifier | token | Identifier(s) by which this encounter is known | Encounter.identifier |
incomingreferral | reference | The ReferralRequest that initiated this encounter | Encounter.incomingReferral |
length | number | Length of encounter in days | Encounter.length |
location | reference | Location the encounter takes place | Encounter.location.location |
location-period | date | Time period during which the patient was present at the location | Encounter.location.period |
part-of | reference | Another Encounter this encounter is part of | Encounter.partOf |
participant | reference | Persons involved in the encounter other than the patient | Encounter.participant.individual |
participant-type | token | Role of participant in encounter | Encounter.participant.type |
patient | reference | The patient ro group present at the encounter | Encounter.subject |
practitioner | reference | Persons involved in the encounter other than the patient | Encounter.participant.individual |
reason | token | Reason the encounter takes place (code) | Encounter.reason |
service-provider | reference | The custodian organization of this Encounter record | Encounter.serviceProvider |
special-arrangement | token | Wheelchair, translator, stretcher, etc. | Encounter.hospitalization.specialArrangement |
status | token | planned | arrived | triaged | in-progress | onleave | finished | cancelled + | Encounter.status |
subject | reference | The patient ro group present at the encounter | Encounter.subject |
type | token | Specific type of encounter | Encounter.type |
Endpoint | |||
connection-type | token | Protocol/Profile/Standard to be used with this endpoint connection | Endpoint.connectionType |
identifier | token | Identifies this endpoint across multiple systems | Endpoint.identifier |
name | string | A name that this endpoint can be identified by | Endpoint.name |
organization | reference | The organization that is managing the endpoint | Endpoint.managingOrganization |
payload-type | token | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) | Endpoint.payloadType |
status | token | The current status of the Endpoint (usually expected to be active) | Endpoint.status |
EnrollmentRequest | |||
identifier | token | The business identifier of the Enrollment | EnrollmentRequest.identifier |
organization | reference | The organization who generated this resource | EnrollmentRequest.organization |
patient | reference | The party to be enrolled | EnrollmentRequest.subject |
subject | reference | The party to be enrolled | EnrollmentRequest.subject |
EnrollmentResponse | |||
identifier | token | The business identifier of the EnrollmentResponse | EnrollmentResponse.identifier |
organization | reference | The organization who generated this resource | EnrollmentResponse.organization |
request | reference | The reference to the claim | EnrollmentResponse.request |
EpisodeOfCare | |||
care-manager | reference | Care manager/care co-ordinator for the patient | EpisodeOfCare.careManager |
condition | reference | Conditions/problems/diagnoses this episode of care is for | EpisodeOfCare.diagnosis.condition |
date | date | The provided date search value falls within the episode of care's period | EpisodeOfCare.period |
identifier | token | Business Identifier(s) relevant for this EpisodeOfCare | EpisodeOfCare.identifier |
incomingreferral | reference | Incoming Referral Request | EpisodeOfCare.referralRequest |
organization | reference | The organization that has assumed the specific responsibilities of this EpisodeOfCare | EpisodeOfCare.managingOrganization |
patient | reference | The patient who is the focus of this episode of care | EpisodeOfCare.patient |
status | token | The current status of the Episode of Care as provided (does not check the status history collection) | EpisodeOfCare.status |
type | token | Type/class - e.g. specialist referral, disease management | EpisodeOfCare.type |
ExpansionProfile | |||
date | date | The expansion profile publication date | ExpansionProfile.date |
description | string | The description of the expansion profile | ExpansionProfile.description |
identifier | token | External identifier for the expansion profile | ExpansionProfile.identifier |
jurisdiction | token | Intended jurisdiction for the expansion profile | ExpansionProfile.jurisdiction |
name | string | Computationally friendly name of the expansion profile | ExpansionProfile.name |
publisher | string | Name of the publisher of the expansion profile | ExpansionProfile.publisher |
status | token | The current status of the expansion profile | ExpansionProfile.status |
url | uri | The uri that identifies the expansion profile | ExpansionProfile.url |
version | token | The business version of the expansion profile | ExpansionProfile.version |
ExplanationOfBenefit | |||
care-team | reference | Member of the CareTeam | ExplanationOfBenefit.careTeam.provider |
claim | reference | The reference to the claim | ExplanationOfBenefit.claim |
coverage | reference | The plan under which the claim was adjudicated | ExplanationOfBenefit.insurance.coverage |
created | date | The creation date for the EOB | ExplanationOfBenefit.created |
disposition | string | The contents of the disposition message | ExplanationOfBenefit.disposition |
encounter | reference | Encounters associated with a billed line item | ExplanationOfBenefit.item.encounter |
enterer | reference | The party responsible for the entry of the Claim | ExplanationOfBenefit.enterer |
facility | reference | Facility responsible for the goods and services | ExplanationOfBenefit.facility |
identifier | token | The business identifier of the Explanation of Benefit | ExplanationOfBenefit.identifier |
organization | reference | The reference to the providing organization | ExplanationOfBenefit.organization |
patient | reference | The reference to the patient | ExplanationOfBenefit.patient |
payee | reference | The party receiving any payment for the Claim | ExplanationOfBenefit.payee.party |
provider | reference | The reference to the provider | ExplanationOfBenefit.provider |
FamilyMemberHistory | |||
code | token | A search by a condition code | FamilyMemberHistory.condition.code |
date | date | When history was captured/updated | FamilyMemberHistory.date |
definition | reference | Instantiates protocol or definition | FamilyMemberHistory.definition |
gender | token | A search by a gender code of a family member | FamilyMemberHistory.gender |
identifier | token | A search by a record identifier | FamilyMemberHistory.identifier |
patient | reference | The identity of a subject to list family member history items for | FamilyMemberHistory.patient |
relationship | token | A search by a relationship type | FamilyMemberHistory.relationship |
status | token | partial | completed | entered-in-error | health-unknown | FamilyMemberHistory.status |
Flag | |||
author | reference | Flag creator | Flag.author |
date | date | Time period when flag is active | Flag.period |
encounter | reference | Alert relevant during encounter | Flag.encounter |
identifier | token | Business identifier | Flag.identifier |
patient | reference | The identity of a subject to list flags for | Flag.subject |
subject | reference | The identity of a subject to list flags for | Flag.subject |
Goal | |||
category | token | E.g. Treatment, dietary, behavioral, etc. | Goal.category |
identifier | token | External Ids for this goal | Goal.identifier |
patient | reference | Who this goal is intended for | Goal.subject |
start-date | date | When goal pursuit begins | Goal.start.as(Date) |
status | token | proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected | Goal.status |
subject | reference | Who this goal is intended for | Goal.subject |
target-date | date | Reach goal on or before | Goal.target.due.as(Date) |
GraphDefinition | |||
date | date | The graph definition publication date | GraphDefinition.date |
description | string | The description of the graph definition | GraphDefinition.description |
jurisdiction | token | Intended jurisdiction for the graph definition | GraphDefinition.jurisdiction |
name | string | Computationally friendly name of the graph definition | GraphDefinition.name |
publisher | string | Name of the publisher of the graph definition | GraphDefinition.publisher |
start | token | Type of resource at which the graph starts | GraphDefinition.start |
status | token | The current status of the graph definition | GraphDefinition.status |
url | uri | The uri that identifies the graph definition | GraphDefinition.url |
version | token | The business version of the graph definition | GraphDefinition.version |
Group | |||
actual | token | Descriptive or actual | Group.actual |
characteristic | token | Kind of characteristic | Group.characteristic.code |
characteristic-value | composite | A composite of both characteristic and value | Group.characteristic |
code | token | The kind of resources contained | Group.code |
exclude | token | Group includes or excludes | Group.characteristic.exclude |
identifier | token | Unique id | Group.identifier |
member | reference | Reference to the group member | Group.member.entity |
type | token | The type of resources the group contains | Group.type |
value | token | Value held by characteristic | Group.characteristic.value |
GuidanceResponse | |||
identifier | token | The identifier of the guidance response | GuidanceResponse.identifier |
patient | reference | The identity of a patient to search for guidance response results | GuidanceResponse.subject |
request | token | The identifier of the request associated with the response | GuidanceResponse.requestId |
subject | reference | The subject that the guidance response is about | GuidanceResponse.subject |
HealthcareService | |||
active | token | The Healthcare Service is currently marked as active | HealthcareService.active |
category | token | Service Category of the Healthcare Service | HealthcareService.category |
characteristic | token | One of the HealthcareService's characteristics | HealthcareService.characteristic |
endpoint | reference | Technical endpoints providing access to services operated for the location | HealthcareService.endpoint |
identifier | token | External identifiers for this item | HealthcareService.identifier |
location | reference | The location of the Healthcare Service | HealthcareService.location |
name | string | A portion of the Healthcare service name | HealthcareService.name |
organization | reference | The organization that provides this Healthcare Service | HealthcareService.providedBy |
programname | string | One of the Program Names serviced by this HealthcareService | HealthcareService.programName |
type | token | The type of service provided by this healthcare service | HealthcareService.type |
ImagingManifest | |||
author | reference | Author of the ImagingManifest (or a DICOM Key Object Selection which it represents) | ImagingManifest.author |
authoring-time | date | Time of the ImagingManifest (or a DICOM Key Object Selection which it represents) authoring | ImagingManifest.authoringTime |
endpoint | reference | The endpoint for the study or series | ImagingManifest.study.endpoint | ImagingManifest.study.series.endpoint |
identifier | token | UID of the ImagingManifest (or a DICOM Key Object Selection which it represents) | ImagingManifest.identifier |
imaging-study | reference | ImagingStudy resource selected in the ImagingManifest (or a DICOM Key Object Selection which it represents) | ImagingManifest.study.imagingStudy |
patient | reference | Subject of the ImagingManifest (or a DICOM Key Object Selection which it represents) | ImagingManifest.patient |
selected-study | uri | Study selected in the ImagingManifest (or a DICOM Key Object Selection which it represents) | ImagingManifest.study.uid |
ImagingStudy | |||
accession | token | The accession identifier for the study | ImagingStudy.accession |
basedon | reference | The order for the image | ImagingStudy.basedOn |
bodysite | token | The body site studied | ImagingStudy.series.bodySite |
context | reference | The context of the study | ImagingStudy.context |
dicom-class | uri | The type of the instance | ImagingStudy.series.instance.sopClass |
endpoint | reference | The endpoint for te study or series | ImagingStudy.endpoint | ImagingStudy.series.endpoint |
identifier | token | Other identifiers for the Study | ImagingStudy.identifier |
modality | token | The modality of the series | ImagingStudy.series.modality |
patient | reference | Who the study is about | ImagingStudy.patient |
performer | reference | The person who performed the study | ImagingStudy.series.performer |
reason | token | The reason for the study | ImagingStudy.reason |
series | uri | The identifier of the series of images | ImagingStudy.series.uid |
started | date | When the study was started | ImagingStudy.started |
study | uri | The study identifier for the image | ImagingStudy.uid |
uid | uri | The instance unique identifier | ImagingStudy.series.instance.uid |
Immunization | |||
date | date | Vaccination (non)-Administration Date | Immunization.date |
dose-sequence | number | Dose number within series | Immunization.vaccinationProtocol.doseSequence |
identifier | token | Business identifier | Immunization.identifier |
location | reference | The service delivery location or facility in which the vaccine was / was to be administered | Immunization.location |
lot-number | string | Vaccine Lot Number | Immunization.lotNumber |
manufacturer | reference | Vaccine Manufacturer | Immunization.manufacturer |
notgiven | token | Administrations which were not given | Immunization.notGiven |
patient | reference | The patient for the vaccination record | Immunization.patient |
practitioner | reference | The practitioner who played a role in the vaccination | Immunization.practitioner.actor |
reaction | reference | Additional information on reaction | Immunization.reaction.detail |
reaction-date | date | When reaction started | Immunization.reaction.date |
reason | token | Why immunization occurred | Immunization.explanation.reason |
reason-not-given | token | Explanation of reason vaccination was not administered | Immunization.explanation.reasonNotGiven |
status | token | Immunization event status | Immunization.status |
vaccine-code | token | Vaccine Product Administered | Immunization.vaccineCode |
ImmunizationRecommendation | |||
date | date | Date recommendation created | ImmunizationRecommendation.recommendation.date |
dose-number | number | Recommended dose number | ImmunizationRecommendation.recommendation.doseNumber |
dose-sequence | number | Dose number within sequence | ImmunizationRecommendation.recommendation.protocol.doseSequence |
identifier | token | Business identifier | ImmunizationRecommendation.identifier |
information | reference | Patient observations supporting recommendation | ImmunizationRecommendation.recommendation.supportingPatientInformation |
patient | reference | Who this profile is for | ImmunizationRecommendation.patient |
status | token | Vaccine administration status | ImmunizationRecommendation.recommendation.forecastStatus |
support | reference | Past immunizations supporting recommendation | ImmunizationRecommendation.recommendation.supportingImmunization |
target-disease | token | Disease to be immunized against | ImmunizationRecommendation.recommendation.targetDisease |
vaccine-type | token | Vaccine recommendation applies to | ImmunizationRecommendation.recommendation.vaccineCode |
ImplementationGuide | |||
date | date | The implementation guide publication date | ImplementationGuide.date |
dependency | uri | Where to find dependency | ImplementationGuide.dependency.uri |
description | string | The description of the implementation guide | ImplementationGuide.description |
experimental | token | For testing purposes, not real usage | ImplementationGuide.experimental |
jurisdiction | token | Intended jurisdiction for the implementation guide | ImplementationGuide.jurisdiction |
name | string | Computationally friendly name of the implementation guide | ImplementationGuide.name |
publisher | string | Name of the publisher of the implementation guide | ImplementationGuide.publisher |
resource | reference | Location of the resource | ImplementationGuide.package.resource.source |
status | token | The current status of the implementation guide | ImplementationGuide.status |
url | uri | The uri that identifies the implementation guide | ImplementationGuide.url |
version | token | The business version of the implementation guide | ImplementationGuide.version |
Library | |||
composed-of | reference | What resource is being referenced | Library.relatedArtifact.where(type='composed-of').resource |
date | date | The library publication date | Library.date |
depends-on | reference | What resource is being referenced | Library.relatedArtifact.where(type='depends-on').resource |
derived-from | reference | What resource is being referenced | Library.relatedArtifact.where(type='derived-from').resource |
description | string | The description of the library | Library.description |
effective | date | The time during which the library is intended to be in use | Library.effectivePeriod |
identifier | token | External identifier for the library | Library.identifier |
jurisdiction | token | Intended jurisdiction for the library | Library.jurisdiction |
name | string | Computationally friendly name of the library | Library.name |
predecessor | reference | What resource is being referenced | Library.relatedArtifact.where(type='predecessor').resource |
publisher | string | Name of the publisher of the library | Library.publisher |
status | token | The current status of the library | Library.status |
successor | reference | What resource is being referenced | Library.relatedArtifact.where(type='successor').resource |
title | string | The human-friendly name of the library | Library.title |
topic | token | Topics associated with the module | Library.topic |
url | uri | The uri that identifies the library | Library.url |
version | token | The business version of the library | Library.version |
Linkage | |||
author | reference | Author of the Linkage | Linkage.author |
item | reference | Matches on any item in the Linkage | Linkage.item.resource |
source | reference | Matches on any item in the Linkage with a type of 'source' | Linkage.item.resource |
List | |||
code | token | What the purpose of this list is | List.code |
date | date | When the list was prepared | List.date |
empty-reason | token | Why list is empty | List.emptyReason |
encounter | reference | Context in which list created | List.encounter |
identifier | token | Business identifier | List.identifier |
item | reference | Actual entry | List.entry.item |
notes | string | The annotation - text content | List.note.text |
patient | reference | If all resources have the same subject | List.subject |
source | reference | Who and/or what defined the list contents (aka Author) | List.source |
status | token | current | retired | entered-in-error | List.status |
subject | reference | If all resources have the same subject | List.subject |
title | string | Descriptive name for the list | List.title |
Location | |||
address | string | A (part of the) address of the location | Location.address |
address-city | string | A city specified in an address | Location.address.city |
address-country | string | A country specified in an address | Location.address.country |
address-postalcode | string | A postal code specified in an address | Location.address.postalCode |
address-state | string | A state specified in an address | Location.address.state |
address-use | token | A use code specified in an address | Location.address.use |
endpoint | reference | Technical endpoints providing access to services operated for the location | Location.endpoint |
identifier | token | An identifier for the location | Location.identifier |
name | string | A portion of the location's name or alias | Location.name | Location.alias |
near | token | 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-distance | quantity | A distance quantity to limit the near search to locations within a specific distance Requires the near parameter to also be included | Location.position |
operational-status | token | Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping) | Location.operationalStatus |
organization | reference | Searches for locations that are managed by the provided organization | Location.managingOrganization |
partof | reference | A location of which this location is a part | Location.partOf |
status | token | Searches for locations with a specific kind of status | Location.status |
type | token | A code for the type of location | Location.type |
Measure | |||
composed-of | reference | What resource is being referenced | Measure.relatedArtifact.where(type='composed-of').resource |
date | date | The measure publication date | Measure.date |
depends-on | reference | What resource is being referenced | Measure.relatedArtifact.where(type='depends-on').resource | Measure.library |
derived-from | reference | What resource is being referenced | Measure.relatedArtifact.where(type='derived-from').resource |
description | string | The description of the measure | Measure.description |
effective | date | The time during which the measure is intended to be in use | Measure.effectivePeriod |
identifier | token | External identifier for the measure | Measure.identifier |
jurisdiction | token | Intended jurisdiction for the measure | Measure.jurisdiction |
name | string | Computationally friendly name of the measure | Measure.name |
predecessor | reference | What resource is being referenced | Measure.relatedArtifact.where(type='predecessor').resource |
publisher | string | Name of the publisher of the measure | Measure.publisher |
status | token | The current status of the measure | Measure.status |
successor | reference | What resource is being referenced | Measure.relatedArtifact.where(type='successor').resource |
title | string | The human-friendly name of the measure | Measure.title |
topic | token | Topics associated with the module | Measure.topic |
url | uri | The uri that identifies the measure | Measure.url |
version | token | The business version of the measure | Measure.version |
MeasureReport | |||
identifier | token | External identifier of the measure report to be returned | MeasureReport.identifier |
patient | reference | The identity of a patient to search for individual measure report results for | MeasureReport.patient |
status | token | The status of the measure report | MeasureReport.status |
Media | |||
based-on | reference | Procedure that caused this media to be created | Media.basedOn |
context | reference | Encounter / Episode associated with media | Media.context |
created | date | Date attachment was first created | Media.content.creation |
date | date | When Media was collected | Media.occurrence |
device | reference | Observing Device | Media.device |
identifier | token | Identifier(s) for the image | Media.identifier |
operator | reference | The person who generated the image | Media.operator |
patient | reference | Who/What this Media is a record of | Media.subject |
site | token | Body part in media | Media.bodySite |
subject | reference | Who/What this Media is a record of | Media.subject |
subtype | token | The type of acquisition equipment/process | Media.subtype |
type | token | photo | video | audio | Media.type |
view | token | Imaging view, e.g. Lateral or Antero-posterior | Media.view |
Medication | |||
code | token | Codes that identify this medication | Medication.code |
container | token | E.g. box, vial, blister-pack | Medication.package.container |
form | token | powder | tablets | capsule + | Medication.form |
ingredient | reference | The product contained | Medication.ingredient.item.as(Reference) |
ingredient-code | token | The product contained | Medication.ingredient.item.as(CodeableConcept) |
manufacturer | reference | Manufacturer of the item | Medication.manufacturer |
over-the-counter | token | True if medication does not require a prescription | Medication.isOverTheCounter |
package-item | reference | The item in the package | Medication.package.content.item.as(Reference) |
package-item-code | token | The item in the package | Medication.package.content.item.as(CodeableConcept) |
status | token | active | inactive | entered-in-error | Medication.status |
MedicationAdministration | |||
code | token | Return administrations of this medication code | MedicationAdministration.medication.as(CodeableConcept) |
context | reference | Return administrations that share this encounter or episode of care | MedicationAdministration.context |
device | reference | Return administrations with this administration device identity | MedicationAdministration.device |
effective-time | date | Date administration happened (or did not happen) | MedicationAdministration.effective |
identifier | token | Return administrations with this external identifier | MedicationAdministration.identifier |
medication | reference | Return administrations of this medication resource | MedicationAdministration.medication.as(Reference) |
not-given | token | Administrations that were not made | MedicationAdministration.notGiven |
patient | reference | The identity of a patient to list administrations for | MedicationAdministration.subject |
performer | reference | The identify of the individual who administered the medication | MedicationAdministration.performer.actor |
prescription | reference | The identity of a prescription to list administrations from | MedicationAdministration.prescription |
reason-given | token | Reasons for administering the medication | MedicationAdministration.reasonCode |
reason-not-given | token | Reasons for not administering the medication | MedicationAdministration.reasonNotGiven |
status | token | MedicationAdministration event status (for example one of active/paused/completed/nullified) | MedicationAdministration.status |
subject | reference | The identify of the individual or group to list administrations for | MedicationAdministration.subject |
MedicationDispense | |||
code | token | Return dispenses of this medicine code | MedicationDispense.medication.as(CodeableConcept) |
context | reference | Returns dispenses with a specific context (episode or episode of care) | MedicationDispense.context |
destination | reference | Return dispenses that should be sent to a specific destination | MedicationDispense.destination |
identifier | token | Return dispenses with this external identifier | MedicationDispense.identifier |
medication | reference | Return dispenses of this medicine resource | MedicationDispense.medication.as(Reference) |
patient | reference | The identity of a patient to list dispenses for | MedicationDispense.subject |
performer | reference | Return dispenses performed by a specific individual | MedicationDispense.performer.actor |
prescription | reference | The identity of a prescription to list dispenses from | MedicationDispense.authorizingPrescription |
receiver | reference | The identity of a receiver to list dispenses for | MedicationDispense.receiver |
responsibleparty | reference | Return dispenses with the specified responsible party | MedicationDispense.substitution.responsibleParty |
status | token | Return dispenses with a specified dispense status | MedicationDispense.status |
subject | reference | The identity of a patient to list dispenses for | MedicationDispense.subject |
type | token | Return dispenses of a specific type | MedicationDispense.type |
whenhandedover | date | Returns dispenses handed over on this date | MedicationDispense.whenHandedOver |
whenprepared | date | Returns dispenses prepared on this date | MedicationDispense.whenPrepared |
MedicationRequest | |||
authoredon | date | Return prescriptions written on this date | MedicationRequest.authoredOn |
category | token | Returns prescriptions with different categories | MedicationRequest.category |
code | token | Return prescriptions of this medication code | MedicationRequest.medication.as(CodeableConcept) |
context | reference | Return prescriptions with this encounter or episode of care identifier | MedicationRequest.context |
date | date | Multiple Resources:
| MedicationRequest.dosageInstruction.timing.event |
identifier | token | Return prescriptions with this external identifier | MedicationRequest.identifier |
intended-dispenser | reference | Returns prescriptions intended to be dispensed by this Organization | MedicationRequest.dispenseRequest.performer |
intent | token | Returns prescriptions with different intents | MedicationRequest.intent |
medication | reference | Return prescriptions of this medication reference | MedicationRequest.medication.as(Reference) |
patient | reference | Returns prescriptions for a specific patient | MedicationRequest.subject |
priority | token | Returns prescriptions with different priorities | MedicationRequest.priority |
requester | reference | Returns prescriptions prescribed by this prescriber | MedicationRequest.requester.agent |
status | token | Status of the prescription | MedicationRequest.status |
subject | reference | The identity of a patient to list orders for | MedicationRequest.subject |
MedicationStatement | |||
category | token | Returns statements of this category of medicationstatement | MedicationStatement.category |
code | token | Return statements of this medication code | MedicationStatement.medication.as(CodeableConcept) |
context | reference | Returns statements for a specific context (episode or episode of Care). | MedicationStatement.context |
effective | date | Date when patient was taking (or not taking) the medication | MedicationStatement.effective |
identifier | token | Return statements with this external identifier | MedicationStatement.identifier |
medication | reference | Return statements of this medication reference | MedicationStatement.medication.as(Reference) |
part-of | reference | Returns statements that are part of another event. | MedicationStatement.partOf |
patient | reference | Returns statements for a specific patient. | MedicationStatement.subject |
source | reference | Who or where the information in the statement came from | MedicationStatement.informationSource |
status | token | Return statements that match the given status | MedicationStatement.status |
subject | reference | The identity of a patient, animal or group to list statements for | MedicationStatement.subject |
MessageDefinition | |||
category | token | The behavior associated with the message | MessageDefinition.category |
date | date | The message definition publication date | MessageDefinition.date |
description | string | The description of the message definition | MessageDefinition.description |
event | token | The event that triggers the message | MessageDefinition.event |
focus | token | A resource that is a permitted focus of the message | MessageDefinition.focus.code |
identifier | token | External identifier for the message definition | MessageDefinition.identifier |
jurisdiction | token | Intended jurisdiction for the message definition | MessageDefinition.jurisdiction |
name | string | Computationally friendly name of the message definition | MessageDefinition.name |
publisher | string | Name of the publisher of the message definition | MessageDefinition.publisher |
status | token | The current status of the message definition | MessageDefinition.status |
title | string | The human-friendly name of the message definition | MessageDefinition.title |
url | uri | The uri that identifies the message definition | MessageDefinition.url |
version | token | The business version of the message definition | MessageDefinition.version |
MessageHeader | |||
author | reference | The source of the decision | MessageHeader.author |
code | token | ok | transient-error | fatal-error | MessageHeader.response.code |
destination | string | Name of system | MessageHeader.destination.name |
destination-uri | uri | Actual destination address or id | MessageHeader.destination.endpoint |
enterer | reference | The source of the data entry | MessageHeader.enterer |
event | token | Code for the event this message represents | MessageHeader.event |
focus | reference | The actual content of the message | MessageHeader.focus |
receiver | reference | Intended "real-world" recipient for the data | MessageHeader.receiver |
response-id | token | Id of original message | MessageHeader.response.identifier |
responsible | reference | Final responsibility for event | MessageHeader.responsible |
sender | reference | Real world sender of the message | MessageHeader.sender |
source | string | Name of system | MessageHeader.source.name |
source-uri | uri | Actual message source address or id | MessageHeader.source.endpoint |
target | reference | Particular delivery destination within the destination | MessageHeader.destination.target |
timestamp | date | Time that the message was sent | MessageHeader.timestamp |
NamingSystem | |||
contact | string | Name of an individual to contact | NamingSystem.contact.name |
date | date | The naming system publication date | NamingSystem.date |
description | string | The description of the naming system | NamingSystem.description |
id-type | token | oid | uuid | uri | other | NamingSystem.uniqueId.type |
jurisdiction | token | Intended jurisdiction for the naming system | NamingSystem.jurisdiction |
kind | token | codesystem | identifier | root | NamingSystem.kind |
name | string | Computationally friendly name of the naming system | NamingSystem.name |
period | date | When is identifier valid? | NamingSystem.uniqueId.period |
publisher | string | Name of the publisher of the naming system | NamingSystem.publisher |
replaced-by | reference | Use this instead | NamingSystem.replacedBy |
responsible | string | Who maintains system namespace? | NamingSystem.responsible |
status | token | The current status of the naming system | NamingSystem.status |
telecom | token | Contact details for individual or organization | NamingSystem.contact.telecom |
type | token | e.g. driver, provider, patient, bank etc. | NamingSystem.type |
value | string | The unique identifier | NamingSystem.uniqueId.value |
NutritionOrder | |||
additive | token | Type of module component to add to the feeding | NutritionOrder.enteralFormula.additiveType |
datetime | date | Return nutrition orders requested on this date | NutritionOrder.dateTime |
encounter | reference | Return nutrition orders with this encounter identifier | NutritionOrder.encounter |
formula | token | Type of enteral or infant formula | NutritionOrder.enteralFormula.baseFormulaType |
identifier | token | Return nutrition orders with this external identifier | NutritionOrder.identifier |
oraldiet | token | Type of diet that can be consumed orally (i.e., take via the mouth). | NutritionOrder.oralDiet.type |
patient | reference | The identity of the person who requires the diet, formula or nutritional supplement | NutritionOrder.patient |
provider | reference | The identify of the provider who placed the nutrition order | NutritionOrder.orderer |
status | token | Status of the nutrition order. | NutritionOrder.status |
supplement | token | Type of supplement product requested | NutritionOrder.supplement.type |
Observation | |||
based-on | reference | Reference to the test or procedure request. | Observation.basedOn |
category | token | The classification of the type of observation | Observation.category |
code | token | The code of the observation type | Observation.code |
code-value-concept | composite | Code and coded value parameter pair | Observation |
code-value-date | composite | Code and date/time value parameter pair | Observation |
code-value-quantity | composite | Code and quantity value parameter pair | Observation |
code-value-string | composite | Code and string value parameter pair | Observation |
combo-code | token | The code of the observation type or component type | Observation.code | Observation.component.code |
combo-code-value-concept | composite | Code and coded value parameter pair, including in components | Observation | Observation.component |
combo-code-value-quantity | composite | Code and quantity value parameter pair, including in components | Observation | Observation.component |
combo-data-absent-reason | token | The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing. | Observation.dataAbsentReason | Observation.component.dataAbsentReason |
combo-value-concept | token | The value or component value of the observation, if the value is a CodeableConcept | Observation.value.as(CodeableConcept) | Observation.component.value.as(CodeableConcept) |
combo-value-quantity | quantity | The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) | Observation.value.as(Quantity) | Observation.component.value.as(Quantity) |
component-code | token | The component code of the observation type | Observation.component.code |
component-code-value-concept | composite | Component code and component coded value parameter pair | Observation.component |
component-code-value-quantity | composite | Component code and component quantity value parameter pair | Observation.component |
component-data-absent-reason | token | The reason why the expected value in the element Observation.component.value[x] is missing. | Observation.component.dataAbsentReason |
component-value-concept | token | The value of the component observation, if the value is a CodeableConcept | Observation.component.value.as(CodeableConcept) |
component-value-quantity | quantity | The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) | Observation.component.value.as(Quantity) |
context | reference | Healthcare event (Episode-of-care or Encounter) related to the observation | Observation.context |
data-absent-reason | token | The reason why the expected value in the element Observation.value[x] is missing. | Observation.dataAbsentReason |
date | date | Obtained date/time. If the obtained element is a period, a date that falls in the period | Observation.effective |
device | reference | The Device that generated the observation data. | Observation.device |
encounter | reference | Encounter related to the observation | Observation.context |
identifier | token | The unique id for a particular observation | Observation.identifier |
method | token | The method used for the observation | Observation.method |
patient | reference | The subject that the observation is about (if patient) | Observation.subject |
performer | reference | Who performed the observation | Observation.performer |
related | composite | Related Observations - search on related-type and related-target together | Observation.related |
related-target | reference | Resource that is related to this one | Observation.related.target |
related-type | token | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by | Observation.related.type |
specimen | reference | Specimen used for this observation | Observation.specimen |
status | token | The status of the observation | Observation.status |
subject | reference | The subject that the observation is about | Observation.subject |
value-concept | token | The value of the observation, if the value is a CodeableConcept | Observation.value.as(CodeableConcept) |
value-date | date | The value of the observation, if the value is a date or period of time | Observation.value.as(DateTime) | Observation.value.as(Period) |
value-quantity | quantity | The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) | Observation.value.as(Quantity) |
value-string | string | The value of the observation, if the value is a string, and also searches in CodeableConcept.text | Observation.value.as(String) |
OperationDefinition | |||
base | reference | Marks this as a profile of the base | OperationDefinition.base |
code | token | Name used to invoke the operation | OperationDefinition.code |
date | date | The operation definition publication date | OperationDefinition.date |
description | string | The description of the operation definition | OperationDefinition.description |
instance | token | Invoke on an instance? | OperationDefinition.instance |
jurisdiction | token | Intended jurisdiction for the operation definition | OperationDefinition.jurisdiction |
kind | token | operation | query | OperationDefinition.kind |
name | string | Computationally friendly name of the operation definition | OperationDefinition.name |
param-profile | reference | Profile on the type | OperationDefinition.parameter.profile |
publisher | string | Name of the publisher of the operation definition | OperationDefinition.publisher |
status | token | The current status of the operation definition | OperationDefinition.status |
system | token | Invoke at the system level? | OperationDefinition.system |
type | token | Invole at the type level? | OperationDefinition.type |
url | uri | The uri that identifies the operation definition | OperationDefinition.url |
version | token | The business version of the operation definition | OperationDefinition.version |
Organization | |||
active | token | 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 |
address | string | A (part of the) address of the organization | Organization.address |
address-city | string | A city specified in an address | Organization.address.city |
address-country | string | A country specified in an address | Organization.address.country |
address-postalcode | string | A postal code specified in an address | Organization.address.postalCode |
address-state | string | A state specified in an address | Organization.address.state |
address-use | token | A use code specified in an address | Organization.address.use |
endpoint | reference | Technical endpoints providing access to services operated for the organization | Organization.endpoint |
identifier | token | Any identifier for the organization (not the accreditation issuer's identifier) | Organization.identifier |
name | string | A portion of the organization's name or alias | Organization.name | Organization.alias |
partof | reference | An organization of which this organization forms a part | Organization.partOf |
phonetic | string | A portion of the organization's name using some kind of phonetic matching algorithm | Organization.name |
type | token | A code for the type of organization | Organization.type |
Patient | |||
active | token | Whether the patient record is active | Patient.active |
address | string | 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-city | string | A city specified in an address | Patient.address.city |
address-country | string | A country specified in an address | Patient.address.country |
address-postalcode | string | A postalCode specified in an address | Patient.address.postalCode |
address-state | string | A state specified in an address | Patient.address.state |
address-use | token | A use code specified in an address | Patient.address.use |
animal-breed | token | The breed for animal patients | Patient.animal.breed |
animal-species | token | The species for animal patients | Patient.animal.species |
birthdate | date | The patient's date of birth | Patient.birthDate |
death-date | date | The date of death has been provided and satisfies this search value | Patient.deceased.as(DateTime) |
deceased | token | This patient has been marked as deceased, or as a death date entered | Patient.deceased.exists() |
token | A value in an email contact | Patient.telecom.where(system='email') | |
family | string | A portion of the family name of the patient | Patient.name.family |
gender | token | Gender of the patient | Patient.gender |
general-practitioner | reference | Patient's nominated general practitioner, not the organization that manages the record | Patient.generalPractitioner |
given | string | A portion of the given name of the patient | Patient.name.given |
identifier | token | A patient identifier | Patient.identifier |
language | token | Language code (irrespective of use value) | Patient.communication.language |
link | reference | All patients linked to the given patient | Patient.link.other |
name | string | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text | Patient.name |
organization | reference | The organization at which this person is a patient | Patient.managingOrganization |
phone | token | A value in a phone contact | Patient.telecom.where(system='phone') |
phonetic | string | A portion of either family or given name using some kind of phonetic matching algorithm | Patient.name |
telecom | token | The value in any kind of telecom details of the patient | Patient.telecom |
PaymentNotice | |||
created | date | Creation date fro the notice | PaymentNotice.created |
identifier | token | The business identifier of the notice | PaymentNotice.identifier |
organization | reference | The organization who generated this resource | PaymentNotice.organization |
payment-status | token | The type of payment notice | PaymentNotice.paymentStatus |
provider | reference | The reference to the provider | PaymentNotice.provider |
request | reference | The Claim | PaymentNotice.request |
response | reference | The ClaimResponse | PaymentNotice.response |
statusdate | date | The date of the payment action | PaymentNotice.statusDate |
PaymentReconciliation | |||
created | date | The creation date | PaymentReconciliation.created |
disposition | string | The contents of the disposition message | PaymentReconciliation.disposition |
identifier | token | The business identifier of the Explanation of Benefit | PaymentReconciliation.identifier |
organization | reference | The organization who generated this resource | PaymentReconciliation.organization |
outcome | token | The processing outcome | PaymentReconciliation.outcome |
request | reference | The reference to the claim | PaymentReconciliation.request |
request-organization | reference | The organization who generated this resource | PaymentReconciliation.requestOrganization |
request-provider | reference | The reference to the provider who sumbitted the claim | PaymentReconciliation.requestProvider |
Person | |||
address | string | 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-city | string | A city specified in an address | Person.address.city |
address-country | string | A country specified in an address | Person.address.country |
address-postalcode | string | A postal code specified in an address | Person.address.postalCode |
address-state | string | A state specified in an address | Person.address.state |
address-use | token | A use code specified in an address | Person.address.use |
birthdate | date | The person's date of birth | Person.birthDate |
token | A value in an email contact | Person.telecom.where(system='email') | |
gender | token | The gender of the person | Person.gender |
identifier | token | A person Identifier | Person.identifier |
link | reference | Any link has this Patient, Person, RelatedPerson or Practitioner reference | Person.link.target |
name | string | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text | Person.name |
organization | reference | The organization at which this person record is being managed | Person.managingOrganization |
patient | reference | The Person links to this Patient | Person.link.target |
phone | token | A value in a phone contact | Person.telecom.where(system='phone') |
phonetic | string | A portion of name using some kind of phonetic matching algorithm | Person.name |
practitioner | reference | The Person links to this Practitioner | Person.link.target |
relatedperson | reference | The Person links to this RelatedPerson | Person.link.target |
telecom | token | The value in any kind of contact | Person.telecom |
PlanDefinition | |||
composed-of | reference | What resource is being referenced | PlanDefinition.relatedArtifact.where(type='composed-of').resource |
date | date | The plan definition publication date | PlanDefinition.date |
depends-on | reference | What resource is being referenced | PlanDefinition.relatedArtifact.where(type='depends-on').resource | PlanDefinition.library |
derived-from | reference | What resource is being referenced | PlanDefinition.relatedArtifact.where(type='derived-from').resource |
description | string | The description of the plan definition | PlanDefinition.description |
effective | date | The time during which the plan definition is intended to be in use | PlanDefinition.effectivePeriod |
identifier | token | External identifier for the plan definition | PlanDefinition.identifier |
jurisdiction | token | Intended jurisdiction for the plan definition | PlanDefinition.jurisdiction |
name | string | Computationally friendly name of the plan definition | PlanDefinition.name |
predecessor | reference | What resource is being referenced | PlanDefinition.relatedArtifact.where(type='predecessor').resource |
publisher | string | Name of the publisher of the plan definition | PlanDefinition.publisher |
status | token | The current status of the plan definition | PlanDefinition.status |
successor | reference | What resource is being referenced | PlanDefinition.relatedArtifact.where(type='successor').resource |
title | string | The human-friendly name of the plan definition | PlanDefinition.title |
topic | token | Topics associated with the module | PlanDefinition.topic |
url | uri | The uri that identifies the plan definition | PlanDefinition.url |
version | token | The business version of the plan definition | PlanDefinition.version |
Practitioner | |||
active | token | Whether the practitioner record is active | Practitioner.active |
address | string | 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-city | string | A city specified in an address | Practitioner.address.city |
address-country | string | A country specified in an address | Practitioner.address.country |
address-postalcode | string | A postalCode specified in an address | Practitioner.address.postalCode |
address-state | string | A state specified in an address | Practitioner.address.state |
address-use | token | A use code specified in an address | Practitioner.address.use |
communication | token | One of the languages that the practitioner can communicate with | Practitioner.communication |
token | A value in an email contact | Practitioner.telecom.where(system='email') | |
family | string | A portion of the family name | Practitioner.name.family |
gender | token | Gender of the practitioner | Practitioner.gender |
given | string | A portion of the given name | Practitioner.name.given |
identifier | token | A practitioner's Identifier | Practitioner.identifier |
name | string | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text | Practitioner.name |
phone | token | A value in a phone contact | Practitioner.telecom.where(system='phone') |
phonetic | string | A portion of either family or given name using some kind of phonetic matching algorithm | Practitioner.name |
telecom | token | The value in any kind of contact | Practitioner.telecom |
PractitionerRole | |||
active | token | Whether this practitioner's record is in active use | PractitionerRole.active |
date | date | The period during which the practitioner is authorized to perform in these role(s) | PractitionerRole.period |
token | A value in an email contact | PractitionerRole.telecom.where(system='email') | |
endpoint | reference | Technical endpoints providing access to services operated for the practitioner with this role | PractitionerRole.endpoint |
identifier | token | A practitioner's Identifier | PractitionerRole.identifier |
location | reference | One of the locations at which this practitioner provides care | PractitionerRole.location |
organization | reference | The identity of the organization the practitioner represents / acts on behalf of | PractitionerRole.organization |
phone | token | A value in a phone contact | PractitionerRole.telecom.where(system='phone') |
practitioner | reference | Practitioner that is able to provide the defined services for the organation | PractitionerRole.practitioner |
role | token | The practitioner can perform this role at for the organization | PractitionerRole.code |
service | reference | The list of healthcare services that this worker provides for this role's Organization/Location(s) | PractitionerRole.healthcareService |
specialty | token | The practitioner has this specialty at an organization | PractitionerRole.specialty |
telecom | token | The value in any kind of contact | PractitionerRole.telecom |
Procedure | |||
based-on | reference | A request for this procedure | Procedure.basedOn |
category | token | Classification of the procedure | Procedure.category |
code | token | A code to identify a procedure | Procedure.code |
context | reference | Encounter or episode associated with the procedure | Procedure.context |
date | date | Date/Period the procedure was performed | Procedure.performed |
definition | reference | Instantiates protocol or definition | Procedure.definition |
encounter | reference | Search by encounter | Procedure.context |
identifier | token | A unique identifier for a procedure | Procedure.identifier |
location | reference | Where the procedure happened | Procedure.location |
part-of | reference | Part of referenced event | Procedure.partOf |
patient | reference | Search by subject - a patient | Procedure.subject |
performer | reference | The reference to the practitioner | Procedure.performer.actor |
status | token | preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown | Procedure.status |
subject | reference | Search by subject | Procedure.subject |
ProcedureRequest | |||
authored | date | Date request signed | ProcedureRequest.authoredOn |
based-on | reference | What request fulfills | ProcedureRequest.basedOn |
body-site | token | Where procedure is going to be done | ProcedureRequest.bodySite |
code | token | What is being requested/ordered | ProcedureRequest.code |
context | reference | Encounter or Episode during which request was created | ProcedureRequest.context |
definition | reference | Protocol or definition | ProcedureRequest.definition |
encounter | reference | An encounter in which this request is made | ProcedureRequest.context |
identifier | token | Identifiers assigned to this order | ProcedureRequest.identifier |
intent | token | proposal | plan | order + | ProcedureRequest.intent |
occurrence | date | When procedure should occur | ProcedureRequest.occurrence |
patient | reference | Search by subject - a patient | ProcedureRequest.subject |
performer | reference | Requested perfomer | ProcedureRequest.performer |
performer-type | token | Performer role | ProcedureRequest.performerType |
priority | token | routine | urgent | asap | stat | ProcedureRequest.priority |
replaces | reference | What request replaces | ProcedureRequest.replaces |
requester | reference | Individual making the request | ProcedureRequest.requester.agent |
requisition | token | Composite Request ID | ProcedureRequest.requisition |
specimen | reference | Specimen to be tested | ProcedureRequest.specimen |
status | token | draft | active | suspended | completed | entered-in-error | cancelled | ProcedureRequest.status |
subject | reference | Search by subject | ProcedureRequest.subject |
ProcessRequest | |||
action | token | The action requested by this resource | ProcessRequest.action |
identifier | token | The business identifier of the ProcessRequest | ProcessRequest.identifier |
organization | reference | The organization who generated this request | ProcessRequest.organization |
provider | reference | The provider who regenerated this request | ProcessRequest.provider |
ProcessResponse | |||
identifier | token | The business identifier of the Explanation of Benefit | ProcessResponse.identifier |
organization | reference | The organization who generated this resource | ProcessResponse.organization |
request | reference | The reference to the claim | ProcessResponse.request |
request-organization | reference | The Organization who is responsible the request transaction | ProcessResponse.requestOrganization |
request-provider | reference | The Provider who is responsible the request transaction | ProcessResponse.requestProvider |
Provenance | |||
agent | reference | Who participated | Provenance.agent.who |
agent-role | token | What the agents role was | Provenance.agent.role |
end | date | End time with inclusive boundary, if not ongoing | Provenance.period.end |
entity-id | token | Identity of entity | Provenance.entity.what.as(Identifier) |
entity-ref | reference | Identity of entity | Provenance.entity.what.as(Reference) |
location | reference | Where the activity occurred, if relevant | Provenance.location |
patient | reference | Target Reference(s) (usually version specific) | Provenance.target |
recorded | date | When the activity was recorded / updated | Provenance.recorded |
signature-type | token | Indication of the reason the entity signed the object(s) | Provenance.signature.type |
start | date | Starting time with inclusive boundary | Provenance.period.start |
target | reference | Target Reference(s) (usually version specific) | Provenance.target |
Questionnaire | |||
code | token | A code that corresponds to one of its items in the questionnaire | Questionnaire.item.code |
date | date | The questionnaire publication date | Questionnaire.date |
description | string | The description of the questionnaire | Questionnaire.description |
effective | date | The time during which the questionnaire is intended to be in use | Questionnaire.effectivePeriod |
identifier | token | External identifier for the questionnaire | Questionnaire.identifier |
jurisdiction | token | Intended jurisdiction for the questionnaire | Questionnaire.jurisdiction |
name | string | Computationally friendly name of the questionnaire | Questionnaire.name |
publisher | string | Name of the publisher of the questionnaire | Questionnaire.publisher |
status | token | The current status of the questionnaire | Questionnaire.status |
title | string | The human-friendly name of the questionnaire | Questionnaire.title |
url | uri | The uri that identifies the questionnaire | Questionnaire.url |
version | token | The business version of the questionnaire | Questionnaire.version |
QuestionnaireResponse | |||
author | reference | The author of the questionnaire response | QuestionnaireResponse.author |
authored | date | When the questionnaire response was last changed | QuestionnaireResponse.authored |
based-on | reference | Plan/proposal/order fulfilled by this questionnaire response | QuestionnaireResponse.basedOn |
context | reference | Encounter or episode associated with the questionnaire response | QuestionnaireResponse.context |
identifier | token | The unique identifier for the questionnaire response | QuestionnaireResponse.identifier |
parent | reference | Procedure or observation this questionnaire response was performed as a part of | QuestionnaireResponse.parent |
patient | reference | The patient that is the subject of the questionnaire response | QuestionnaireResponse.subject |
questionnaire | reference | The questionnaire the answers are provided for | QuestionnaireResponse.questionnaire |
source | reference | The individual providing the information reflected in the questionnaire respose | QuestionnaireResponse.source |
status | token | The status of the questionnaire response | QuestionnaireResponse.status |
subject | reference | The subject of the questionnaire response | QuestionnaireResponse.subject |
ReferralRequest | |||
authored-on | date | Creation or activation date | ReferralRequest.authoredOn |
based-on | reference | Request being fulfilled | ReferralRequest.basedOn |
context | reference | Part of encounter or episode of care | ReferralRequest.context |
definition | reference | Instantiates protocol or definition | ReferralRequest.definition |
encounter | reference | Originating encounter | ReferralRequest.context |
group-identifier | token | Part of common request | ReferralRequest.groupIdentifier |
identifier | token | Business identifier | ReferralRequest.identifier |
intent | token | Proposal, plan or order | ReferralRequest.intent |
occurrence-date | date | When the service(s) requested in the referral should occur | ReferralRequest.occurrence |
patient | reference | Who the referral is about | ReferralRequest.subject |
priority | token | The priority assigned to the referral | ReferralRequest.priority |
recipient | reference | The person that the referral was sent to | ReferralRequest.recipient |
replaces | reference | Request(s) replaced by this request | ReferralRequest.replaces |
requester | reference | Individual making the request | ReferralRequest.requester.agent |
service | token | Actions requested as part of the referral | ReferralRequest.serviceRequested |
specialty | token | The specialty that the referral is for | ReferralRequest.specialty |
status | token | The status of the referral | ReferralRequest.status |
subject | reference | Patient referred to care or transfer | ReferralRequest.subject |
type | token | The type of the referral | ReferralRequest.type |
RelatedPerson | |||
active | token | Indicates if the related person record is active | RelatedPerson.active |
address | string | 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-city | string | A city specified in an address | RelatedPerson.address.city |
address-country | string | A country specified in an address | RelatedPerson.address.country |
address-postalcode | string | A postal code specified in an address | RelatedPerson.address.postalCode |
address-state | string | A state specified in an address | RelatedPerson.address.state |
address-use | token | A use code specified in an address | RelatedPerson.address.use |
birthdate | date | The Related Person's date of birth | RelatedPerson.birthDate |
token | A value in an email contact | RelatedPerson.telecom.where(system='email') | |
gender | token | Gender of the related person | RelatedPerson.gender |
identifier | token | An Identifier of the RelatedPerson | RelatedPerson.identifier |
name | string | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text | RelatedPerson.name |
patient | reference | The patient this related person is related to | RelatedPerson.patient |
phone | token | A value in a phone contact | RelatedPerson.telecom.where(system='phone') |
phonetic | string | A portion of name using some kind of phonetic matching algorithm | RelatedPerson.name |
telecom | token | The value in any kind of contact | RelatedPerson.telecom |
RequestGroup | |||
author | reference | The author of the request group | RequestGroup.author |
authored | date | The date the request group was authored | RequestGroup.authoredOn |
context | reference | The context the request group applies to | RequestGroup.context |
definition | reference | The definition from which the request group is realized | RequestGroup.definition |
encounter | reference | The encounter the request group applies to | RequestGroup.context |
group-identifier | token | The group identifier for the request group | RequestGroup.groupIdentifier |
identifier | token | External identifiers for the request group | RequestGroup.identifier |
intent | token | The intent of the request group | RequestGroup.intent |
participant | reference | The participant in the requests in the group | RequestGroup.action.participant |
patient | reference | The identity of a patient to search for request groups | RequestGroup.subject |
priority | token | The priority of the request group | RequestGroup.priority |
status | token | The status of the request group | RequestGroup.status |
subject | reference | The subject that the request group is about | RequestGroup.subject |
ResearchStudy | |||
category | token | Classifications for the study | ResearchStudy.category |
date | date | When the study began and ended | ResearchStudy.period |
focus | token | Drugs, devices, conditions, etc. under study | ResearchStudy.focus |
identifier | token | Business Identifier for study | ResearchStudy.identifier |
jurisdiction | token | Geographic region(s) for study | ResearchStudy.jurisdiction |
keyword | token | Used to search for the study | ResearchStudy.keyword |
partof | reference | Part of larger study | ResearchStudy.partOf |
principalinvestigator | reference | The individual responsible for the study | ResearchStudy.principalInvestigator |
protocol | reference | Steps followed in executing study | ResearchStudy.protocol |
site | reference | Location involved in study execution | ResearchStudy.site |
sponsor | reference | Organization responsible for the study | ResearchStudy.sponsor |
status | token | draft | in-progress | suspended | stopped | completed | entered-in-error | ResearchStudy.status |
title | string | Name for this study | ResearchStudy.title |
ResearchSubject | |||
date | date | Start and end of participation | ResearchSubject.period |
identifier | token | Business Identifier for research subject | ResearchSubject.identifier |
individual | reference | Who is part of study | ResearchSubject.individual |
patient | reference | Who is part of study | ResearchSubject.individual |
status | token | candidate | enrolled | active | suspended | withdrawn | completed | ResearchSubject.status |
RiskAssessment | |||
condition | reference | Condition assessed | RiskAssessment.condition |
date | date | When was assessment made? | RiskAssessment.occurrence.as(DateTime) |
encounter | reference | Where was assessment performed? | RiskAssessment.context |
identifier | token | Unique identifier for the assessment | RiskAssessment.identifier |
method | token | Evaluation mechanism | RiskAssessment.method |
patient | reference | Who/what does assessment apply to? | RiskAssessment.subject |
performer | reference | Who did assessment? | RiskAssessment.performer |
probability | number | Likelihood of specified outcome | RiskAssessment.prediction.probability |
risk | token | Likelihood of specified outcome as a qualitative value | RiskAssessment.prediction.qualitativeRisk |
subject | reference | Who/what does assessment apply to? | RiskAssessment.subject |
Schedule | |||
active | token | Is the schedule in active use | Schedule.active |
actor | reference | The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for | Schedule.actor |
date | date | Search for Schedule resources that have a period that contains this date specified | Schedule.planningHorizon |
identifier | token | A Schedule Identifier | Schedule.identifier |
type | token | The type of appointments that can be booked into associated slot(s) | Schedule.serviceType |
SearchParameter | |||
base | token | The resource type(s) this search parameter applies to | SearchParameter.base |
code | token | Code used in URL | SearchParameter.code |
component | reference | Defines how the part works | SearchParameter.component.definition |
date | date | The search parameter publication date | SearchParameter.date |
derived-from | uri | Original Definition for the search parameter | SearchParameter.derivedFrom |
description | string | The description of the search parameter | SearchParameter.description |
jurisdiction | token | Intended jurisdiction for the search parameter | SearchParameter.jurisdiction |
name | string | Computationally friendly name of the search parameter | SearchParameter.name |
publisher | string | Name of the publisher of the search parameter | SearchParameter.publisher |
status | token | The current status of the search parameter | SearchParameter.status |
target | token | Types of resource (if a resource reference) | SearchParameter.target |
type | token | number | date | string | token | reference | composite | quantity | uri | SearchParameter.type |
url | uri | The uri that identifies the search parameter | SearchParameter.url |
version | token | The business version of the search parameter | SearchParameter.version |
Sequence | |||
chromosome | token | Chromosome number of the reference sequence | Sequence.referenceSeq.chromosome |
coordinate | composite | Search parameter for region of the reference DNA sequence string. This will refer to part of a locus or part of a gene where search region will be represented in 1-based system. Since the coordinateSystem can either be 0-based or 1-based, this search query will include the result of both coordinateSystem that contains the equivalent segment of the gene or whole genome sequence. For example, a search for sequence can be represented as | Sequence.variant |
end | number | End position (0-based exclusive, which menas the acid at this position will not be included, 1-based inclusive, which means the acid at this position will be included) of the reference sequence. | Sequence.referenceSeq.windowEnd |
identifier | token | The unique identity for a particular sequence | Sequence.identifier |
patient | reference | The subject that the observation is about | Sequence.patient |
start | number | Start position (0-based inclusive, 1-based inclusive, that means the nucleic acid or amino acid at this position will be included) of the reference sequence. | Sequence.referenceSeq.windowStart |
type | token | Amino Acid Sequence/ DNA Sequence / RNA Sequence | Sequence.type |
ServiceDefinition | |||
composed-of | reference | What resource is being referenced | ServiceDefinition.relatedArtifact.where(type='composed-of').resource |
date | date | The service definition publication date | ServiceDefinition.date |
depends-on | reference | What resource is being referenced | ServiceDefinition.relatedArtifact.where(type='depends-on').resource |
derived-from | reference | What resource is being referenced | ServiceDefinition.relatedArtifact.where(type='derived-from').resource |
description | string | The description of the service definition | ServiceDefinition.description |
effective | date | The time during which the service definition is intended to be in use | ServiceDefinition.effectivePeriod |
identifier | token | External identifier for the service definition | ServiceDefinition.identifier |
jurisdiction | token | Intended jurisdiction for the service definition | ServiceDefinition.jurisdiction |
name | string | Computationally friendly name of the service definition | ServiceDefinition.name |
predecessor | reference | What resource is being referenced | ServiceDefinition.relatedArtifact.where(type='predecessor').resource |
publisher | string | Name of the publisher of the service definition | ServiceDefinition.publisher |
status | token | The current status of the service definition | ServiceDefinition.status |
successor | reference | What resource is being referenced | ServiceDefinition.relatedArtifact.where(type='successor').resource |
title | string | The human-friendly name of the service definition | ServiceDefinition.title |
topic | token | Topics associated with the module | ServiceDefinition.topic |
url | uri | The uri that identifies the service definition | ServiceDefinition.url |
version | token | The business version of the service definition | ServiceDefinition.version |
Slot | |||
identifier | token | A Slot Identifier | Slot.identifier |
schedule | reference | The Schedule Resource that we are seeking a slot within | Slot.schedule |
slot-type | token | The type of appointments that can be booked into the slot | Slot.serviceType |
start | date | Appointment date/time. | Slot.start |
status | token | The free/busy status of the appointment | Slot.status |
Specimen | |||
accession | token | The accession number associated with the specimen | Specimen.accessionIdentifier |
bodysite | token | The code for the body site from where the specimen originated | Specimen.collection.bodySite |
collected | date | The date the specimen was collected | Specimen.collection.collected |
collector | reference | Who collected the specimen | Specimen.collection.collector |
container | token | The kind of specimen container | Specimen.container.type |
container-id | token | The unique identifier associated with the specimen container | Specimen.container.identifier |
identifier | token | The unique identifier associated with the specimen | Specimen.identifier |
parent | reference | The parent of the specimen | Specimen.parent |
patient | reference | The patient the specimen comes from | Specimen.subject |
status | token | available | unavailable | unsatisfactory | entered-in-error | Specimen.status |
subject | reference | The subject of the specimen | Specimen.subject |
type | token | The specimen type | Specimen.type |
StructureDefinition | |||
abstract | token | Whether the structure is abstract | StructureDefinition.abstract |
base | uri | Definition that this type is constrained/specialized from | StructureDefinition.baseDefinition |
base-path | token | Path that identifies the base element | StructureDefinition.snapshot.element.base.path | StructureDefinition.differential.element.base.path |
context-type | token | resource | datatype | extension | StructureDefinition.contextType |
date | date | The structure definition publication date | StructureDefinition.date |
derivation | token | specialization | constraint - How relates to base definition | StructureDefinition.derivation |
description | string | The description of the structure definition | StructureDefinition.description |
experimental | token | For testing purposes, not real usage | StructureDefinition.experimental |
ext-context | string | Where the extension can be used in instances | StructureDefinition.context |
identifier | token | External identifier for the structure definition | StructureDefinition.identifier |
jurisdiction | token | Intended jurisdiction for the structure definition | StructureDefinition.jurisdiction |
keyword | token | A code for the profile | StructureDefinition.keyword |
kind | token | primitive-type | complex-type | resource | logical | StructureDefinition.kind |
name | string | Computationally friendly name of the structure definition | StructureDefinition.name |
path | token | A path that is constrained in the profile | StructureDefinition.snapshot.element.path | StructureDefinition.differential.element.path |
publisher | string | Name of the publisher of the structure definition | StructureDefinition.publisher |
status | token | The current status of the structure definition | StructureDefinition.status |
title | string | The human-friendly name of the structure definition | StructureDefinition.title |
type | token | Type defined or constrained by this structure | StructureDefinition.type |
url | uri | The uri that identifies the structure definition | StructureDefinition.url |
valueset | reference | A vocabulary binding reference | StructureDefinition.snapshot.element.binding.valueSet |
version | token | The business version of the structure definition | StructureDefinition.version |
StructureMap | |||
date | date | The structure map publication date | StructureMap.date |
description | string | The description of the structure map | StructureMap.description |
identifier | token | External identifier for the structure map | StructureMap.identifier |
jurisdiction | token | Intended jurisdiction for the structure map | StructureMap.jurisdiction |
name | string | Computationally friendly name of the structure map | StructureMap.name |
publisher | string | Name of the publisher of the structure map | StructureMap.publisher |
status | token | The current status of the structure map | StructureMap.status |
title | string | The human-friendly name of the structure map | StructureMap.title |
url | uri | The uri that identifies the structure map | StructureMap.url |
version | token | The business version of the structure map | StructureMap.version |
Subscription | |||
add-tag | token | A tag to be added to the resource matching the criteria | Subscription.tag |
contact | token | Contact details for the subscription | Subscription.contact |
criteria | string | The search rules used to determine when to send a notification | Subscription.criteria |
payload | string | The mime-type of the notification payload | Subscription.channel.payload |
status | token | The current state of the subscription | Subscription.status |
type | token | The type of channel for the sent notifications | Subscription.channel.type |
url | uri | The uri that will receive the notifications | Subscription.channel.endpoint |
Substance | |||
category | token | The category of the substance | Substance.category |
code | token | The code of the substance or ingredient | Substance.code | Substance.ingredient.substance.as(CodeableConcept) |
container-identifier | token | Identifier of the package/container | Substance.instance.identifier |
expiry | date | Expiry date of package or container of substance | Substance.instance.expiry |
identifier | token | Unique identifier for the substance | Substance.identifier |
quantity | quantity | Amount of substance in the package | Substance.instance.quantity |
status | token | active | inactive | entered-in-error | Substance.status |
substance-reference | reference | A component of the substance | Substance.ingredient.substance.as(Reference) |
SupplyDelivery | |||
identifier | token | External identifier | SupplyDelivery.identifier |
patient | reference | Patient for whom the item is supplied | SupplyDelivery.patient |
receiver | reference | Who collected the Supply | SupplyDelivery.receiver |
status | token | in-progress | completed | abandoned | entered-in-error | SupplyDelivery.status |
supplier | reference | Dispenser | SupplyDelivery.supplier |
SupplyRequest | |||
category | token | The kind of supply (central, non-stock, etc.) | SupplyRequest.category |
date | date | When the request was made | SupplyRequest.authoredOn |
identifier | token | Unique identifier | SupplyRequest.identifier |
requester | reference | Individual making the request | SupplyRequest.requester.agent |
status | token | draft | active | suspended + | SupplyRequest.status |
supplier | reference | Who is intended to fulfill the request | SupplyRequest.supplier |
Task | |||
authored-on | date | Search by creation date | Task.authoredOn |
based-on | reference | Search by requests this task is based on | Task.basedOn |
business-status | token | Search by business status | Task.businessStatus |
code | token | Search by task code | Task.code |
context | reference | Search by encounter or episode | Task.context |
focus | reference | Search by task focus | Task.focus |
group-identifier | token | Search by group identifier | Task.groupIdentifier |
identifier | token | Search for a task instance by its business identifier | Task.identifier |
intent | token | Search by task intent | Task.intent |
modified | date | Search by last modification date | Task.lastModified |
organization | reference | Search by responsible organization | Task.requester.onBehalfOf |
owner | reference | Search by task owner | Task.owner |
part-of | reference | Search by task this task is part of | Task.partOf |
patient | reference | Search by patient | Task.for |
performer | token | Search by recommended type of performer (e.g., Requester, Performer, Scheduler). | Task.performerType |
period | date | Search by period Task is/was underway | Task.executionPeriod |
priority | token | Search by task priority | Task.priority |
requester | reference | Search by task requester | Task.requester.agent |
status | token | Search by task status | Task.status |
subject | reference | Search by subject | Task.for |
TestReport | |||
identifier | token | An external identifier for the test report | TestReport.identifier |
issued | date | The test report generation date | TestReport.issued |
participant | uri | The reference to a participant in the test execution | TestReport.participant.uri |
result | token | The result disposition of the test execution | TestReport.result |
tester | string | The name of the testing organization | TestReport.tester |
testscript | reference | The test script executed to produce this report | TestReport.testScript |
TestScript | |||
date | date | The test script publication date | TestScript.date |
description | string | The description of the test script | TestScript.description |
identifier | token | External identifier for the test script | TestScript.identifier |
jurisdiction | token | Intended jurisdiction for the test script | TestScript.jurisdiction |
name | string | Computationally friendly name of the test script | TestScript.name |
publisher | string | Name of the publisher of the test script | TestScript.publisher |
status | token | The current status of the test script | TestScript.status |
testscript-capability | string | TestScript required and validated capability | TestScript.metadata.capability.description |
title | string | The human-friendly name of the test script | TestScript.title |
url | uri | The uri that identifies the test script | TestScript.url |
version | token | The business version of the test script | TestScript.version |
ValueSet | |||
date | date | The value set publication date | ValueSet.date |
description | string | The description of the value set | ValueSet.description |
expansion | uri | Uniquely identifies this expansion | ValueSet.expansion.identifier |
identifier | token | External identifier for the value set | ValueSet.identifier |
jurisdiction | token | Intended jurisdiction for the value set | ValueSet.jurisdiction |
name | string | Computationally friendly name of the value set | ValueSet.name |
publisher | string | Name of the publisher of the value set | ValueSet.publisher |
reference | uri | A code system included or excluded in the value set or an imported value set | ValueSet.compose.include.system |
status | token | The current status of the value set | ValueSet.status |
title | string | The human-friendly name of the value set | ValueSet.title |
url | uri | The uri that identifies the value set | ValueSet.url |
version | token | The business version of the value set | ValueSet.version |
VisionPrescription | |||
datewritten | date | Return prescriptions written on this date | VisionPrescription.dateWritten |
encounter | reference | Return prescriptions with this encounter identifier | VisionPrescription.encounter |
identifier | token | Return prescriptions with this external identifier | VisionPrescription.identifier |
patient | reference | The identity of a patient to list dispenses for | VisionPrescription.patient |
prescriber | reference | Who authorizes the vision product | VisionPrescription.prescriber |