STU 3 Ballot
FoundationThis page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3
| FHIR Infrastructure Work Group | Maturity Level: N/A | Ballot Status: STU 3 |
This page lists all search parameters defined as part of this specification. For further details regarding using search parameters, see searching on the RESTful API.
| Parameter | Type | Description | Paths |
|---|---|---|---|
| Resource | |||
| _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 | |
| 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.coveragePeriod |
| 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 | |||
| description | string | Text search against the description | ActivityDefinition.description |
| identifier | token | Logical identifier for the module (e.g. CMS-143) | ActivityDefinition.identifier |
| status | token | Status of the module | ActivityDefinition.status |
| title | string | Text search against the title | ActivityDefinition.title |
| topic | token | Topics associated with the module | ActivityDefinition.topic |
| version | string | Version of the module (e.g. 1.0.0) | ActivityDefinition.version |
| AllergyIntolerance | |||
| category | token | food | medication | biologic | environment | AllergyIntolerance.category |
| code | token | Allergy or intolerance code | AllergyIntolerance.code | AllergyIntolerance.reaction.substance |
| criticality | token | low | high | unable-to-assess | AllergyIntolerance.criticality |
| date | date | Date record was believed accurate | AllergyIntolerance.attestedDate |
| 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 |
| reporter | reference | Source of the information about the allergy | AllergyIntolerance.reporter |
| 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 |
| status | token | active | active-confirmed | inactive | resolved | refuted | entered-in-error | AllergyIntolerance.status |
| type | token | allergy | intolerance - Underlying mechanism (if known) | AllergyIntolerance.type |
| 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 |
| 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 |
| 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-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 |
| role | token | What role the entity played | AuditEvent.entity.role |
| 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 |
| 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 |
| CarePlan | |||
| activitycode | token | Detail type of activity | CarePlan.activity.detail.code |
| activitydate | date | Specified date occurs within period specified by CarePlan.activity.timingSchedule | CarePlan.activity.detail.scheduled |
| activityreference | reference | Activity details defined in specific resource | CarePlan.activity.reference |
| careteam | reference | Who's involved in plan? | CarePlan.careTeam |
| category | token | Type of plan | CarePlan.category |
| condition | reference | Health issues this plan addresses | CarePlan.addresses |
| date | date | Time period plan covers | CarePlan.period |
| goal | reference | Desired outcome of plan | CarePlan.goal |
| 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 |
| related | composite | A combination of the type of relationship and the related plan | |
| relatedcode | token | includes | replaces | fulfills | CarePlan.relatedPlan.code |
| relatedplan | reference | Plan relationship exists with | CarePlan.relatedPlan.plan |
| subject | reference | Who care plan is for | CarePlan.subject |
| CareTeam | |||
| date | date | Time period team covers | CareTeam.period |
| 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 | active | suspended | inactive | entered in error | CareTeam.status |
| subject | reference | Who care team is for | CareTeam.subject |
| type | token | Type of team | CareTeam.type |
| Claim | |||
| created | date | The creation date for the Claim | Claim.created |
| facility-identifier | token | Facility responsible for the goods and services | Claim.facility.as(Identifier) |
| facility-reference | reference | Facility responsible for the goods and services | Claim.facility.as(Reference) |
| identifier | token | The primary identifier of the financial resource | Claim.identifier |
| insurer-identifier | token | The target payor/insurer for the Claim | Claim.insurer.as(Identifier) |
| insurer-reference | reference | The target payor/insurer for the Claim | Claim.insurer.as(Reference) |
| organization-identifier | token | The reference to the providing organization | Claim.organization.as(Identifier) |
| organization-reference | reference | The reference to the providing organization | Claim.organization.as(Reference) |
| patient-identifier | token | Patient receiving the services | Claim.patient.as(Identifier) |
| patient-reference | reference | Patient receiving the services | Claim.patient.as(Reference) |
| priority | token | Processing priority requested | Claim.priority |
| provider-identifier | token | Provider responsible for the Claim | Claim.provider.as(Identifier) |
| provider-reference | reference | Provider responsible for the Claim | Claim.provider.as(Reference) |
| 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 insurer | ClaimResponse.identifier |
| organization-identifier | token | The organization who generated this resource | ClaimResponse.organization.as(Identifier) |
| organization-reference | reference | The organization who generated this resource | ClaimResponse.organization.as(Reference) |
| outcome | token | The processing outcome | ClaimResponse.outcome |
| paymentdate | date | The expected paymentDate | ClaimResponse.payment.date |
| request-identifier | token | The claim reference | ClaimResponse.request.as(Identifier) |
| request-reference | reference | The claim reference | ClaimResponse.request.as(Reference) |
| ClinicalImpression | |||
| action | reference | Actions taken during assessment | 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) |
| investigation | reference | Record of a specific investigation | ClinicalImpression.investigations.item |
| patient | reference | Patient or group assessed | ClinicalImpression.subject |
| plan | reference | Plan of action after assessment | ClinicalImpression.plan |
| 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 | token | not-present | examplar | fragment | complete | CodeSystem.content |
| context | token | A use context assigned to the code system | CodeSystem.useContext |
| date | date | The code system publication date | CodeSystem.date |
| description | string | Text search in the description of the code system | CodeSystem.description |
| identifier | token | The identifier for the code system | CodeSystem.identifier |
| language | token | A language in which a designation is provided | CodeSystem.concept.designation.language |
| name | string | The name of the code system | CodeSystem.name |
| publisher | string | Name of the publisher of the code system | CodeSystem.publisher |
| status | token | The status of the code system | CodeSystem.status |
| system | uri | The system for any codes defined by this code system (same as 'url') | CodeSystem.url |
| url | uri | The logical URL for the code system | CodeSystem.url |
| version | token | The version identifier 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 |
| identifier | token | Unique identifier | Communication.identifier |
| medium | token | A channel of communication | Communication.medium |
| 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 | in-progress | completed | suspended | rejected | failed | Communication.status |
| subject | reference | Focus of message | Communication.subject |
| CommunicationRequest | |||
| category | token | Message category | CommunicationRequest.category |
| encounter | reference | Encounter leading to message | CommunicationRequest.encounter |
| identifier | token | Unique identifier | CommunicationRequest.identifier |
| medium | token | A channel of communication | CommunicationRequest.medium |
| patient | reference | Focus of message | CommunicationRequest.subject |
| priority | token | Message urgency | CommunicationRequest.priority |
| recipient | reference | Message recipient | CommunicationRequest.recipient |
| requested | date | When ordered or proposed | CommunicationRequest.requestedOn |
| requester | reference | An individual who requested a communication | CommunicationRequest.requester |
| sender | reference | Message sender | CommunicationRequest.sender |
| status | token | proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed | CommunicationRequest.status |
| subject | reference | Focus of message | CommunicationRequest.subject |
| time | date | When scheduled | CommunicationRequest.scheduled.as(DateTime) |
| CompartmentDefinition | |||
| code | token | Patient | Encounter | RelatedPerson | Practitioner | Device | CompartmentDefinition.code |
| date | date | Publication Date(/time) | CompartmentDefinition.date |
| name | string | Informal name for this compartment definition | CompartmentDefinition.name |
| resource | token | Name of resource type | CompartmentDefinition.resource.code |
| status | token | draft | active | retired | CompartmentDefinition.status |
| url | uri | Absolute URL used to reference this 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 |
| 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 | |||
| context | token | A use context assigned to the concept map | ConceptMap.useContext |
| 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 | Text search in the description of the concept map | ConceptMap.description |
| identifier | token | Additional identifier for the concept map | ConceptMap.identifier |
| name | string | Name of the concept map | ConceptMap.name |
| 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 | 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) |
| url | uri | The URL of the concept map | ConceptMap.url |
| version | token | The version identifier of the concept map | ConceptMap.version |
| Condition | |||
| abatement-age | quantity | Abatement as age or age range | Condition.abatement.as(Quantity) | Condition.abatement.as(Range) |
| 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-info | quantity | Abatement as a string | Condition.abatement.as(string) |
| 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 |
| clinicalstatus | token | The clinical status of the condition | Condition.clinicalStatus |
| code | token | Code for the condition | Condition.code |
| context | reference | Encounter when condition first asserted | Condition.context |
| date-recorded | date | A date, when the Condition statement was documented | Condition.dateRecorded |
| evidence | token | Manifestation/symptom | Condition.evidence.code |
| identifier | token | A unique identifier of the condition record | Condition.identifier |
| onset-age | quantity | Onsets as age or age range | Condition.onset.as(Quantity) | 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 |
| Conformance | |||
| context | token | A use context assigned to the conformance statement | Conformance.useContext |
| date | date | The conformance statement publication date | Conformance.date |
| description | string | Text search in the description of the conformance statement | Conformance.description |
| event | token | Event code in a conformance statement | Conformance.messaging.event.code |
| fhirversion | token | The version of FHIR | Conformance.version |
| format | token | formats supported (xml | json | ttl | mime type) | Conformance.format |
| mode | token | Mode - restful (server/client) or messaging (sender/receiver) | Conformance.rest.mode |
| name | string | Name of the conformance statement | Conformance.name |
| publisher | string | Name of the publisher of the conformance statement | Conformance.publisher |
| resource | token | Name of a resource mentioned in a conformance statement | Conformance.rest.resource.type |
| resourceprofile | reference | A profile id invoked in a conformance statement | Conformance.rest.resource.profile |
| securityservice | token | OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates | Conformance.rest.security.service |
| software | string | Part of a the name of a software application | Conformance.software.name |
| status | token | The current status of the conformance statement | Conformance.status |
| supported-profile | reference | Profiles for use cases supported | Conformance.profile |
| url | uri | The uri that identifies the conformance statement | Conformance.url |
| version | token | The version identifier of the conformance statement | Conformance.version |
| Consent | |||
| action | token | Actions controlled by this exception | Consent.except.action |
| actor | reference | Resource for the actor (or group, by role) | 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.consentor |
| data | reference | The actual 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 | Organization that manages 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 covered by this exception | Consent.except.purpose |
| recipient | reference | Whose access is controlled by the policy | Consent.recipient |
| security | token | Security Labels that define affected resources | 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 |
| topic | reference | The identity of the topic of the contract | Contract.topic |
| ttopic | reference | The identity of the topic of the contract terms | Contract.term.topic |
| Coverage | |||
| beneficiary-identifier | token | Covered party | Coverage.beneficiary.as(Identifier) |
| beneficiary-reference | reference | Covered party | Coverage.beneficiary.as(Reference) |
| dependent | number | Dependent number | Coverage.dependent |
| group | token | Group identifier | Coverage.group |
| identifier | token | The primary identifier of the insured and the coverage | Coverage.identifier |
| issuer-identifier | token | The identity of the insurer | Coverage.issuer.as(Identifier) |
| issuer-reference | reference | The identity of the insurer | Coverage.issuer.as(Reference) |
| plan | token | A plan or policy identifier | Coverage.plan |
| planholder-identifier | token | Reference to the planholder | Coverage.planholder.as(Identifier) |
| planholder-reference | reference | Reference to the planholder | Coverage.planholder.as(Reference) |
| sequence | number | Sequence number | Coverage.sequence |
| subgroup | token | Sub-group identifier | Coverage.subGroup |
| subplan | token | Sub-plan identifier | Coverage.subPlan |
| 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 |
| context | token | A use context assigned to the data element | DataElement.useContext |
| 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 | The identifier of the data element | DataElement.identifier |
| name | string | Name of the data element | DataElement.name |
| 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 |
| url | uri | The official URL for the data element | DataElement.url |
| version | string | The version identifier of the data element | DataElement.version |
| objectClass | token | Matches on the 11179-objectClass extension value | |
| objectClassProperty | token | Matches on the 11179-objectClassProperty extension value | |
| DecisionSupportServiceModule | |||
| description | string | Text search against the description | DecisionSupportServiceModule.description |
| identifier | token | Logical identifier for the module (e.g. CMS-143) | DecisionSupportServiceModule.identifier |
| status | token | Status of the module | DecisionSupportServiceModule.status |
| title | string | Text search against the title | DecisionSupportServiceModule.title |
| topic | token | Topics associated with the module | DecisionSupportServiceModule.topic |
| version | string | Version of the module (e.g. 1.0.0) | DecisionSupportServiceModule.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 | |||
| 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 |
| type | token | The type of the device | Device.type |
| udicarrier | token | Barcode string (udi) | Device.udiCarrier |
| url | uri | Network address to contact device | Device.url |
| DeviceComponent | |||
| 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 |
| DeviceUseRequest | |||
| author-date | date | When the request transitioned to being actionable | DeviceUseRequest.authored |
| based-on | reference | Plan/proposal/order fulfilled by this request | DeviceUseRequest.basedOn |
| code | token | Code for what is being requested/ordered | DeviceUseRequest.device.as(CodeableConcept) |
| definition | reference | Protocol or definition followed by this request | DeviceUseRequest.definition |
| device | reference | Reference to resource that is being requested/ordered | DeviceUseRequest.device.as(Reference) |
| encounter | reference | Encounter or Episode during which request was created | DeviceUseRequest.context |
| event-date | date | When service should occur | DeviceUseRequest.occurrence.as(DateTime) | DeviceUseRequest.occurrence.as(Period) |
| filler | reference | Desired performer for service | DeviceUseRequest.performer |
| identifier | token | Business identifier for request/order | DeviceUseRequest.identifier |
| patient | reference | Individual the service is ordered for | DeviceUseRequest.subject |
| replaces | reference | Request takes the place of referenced completed or terminated requests | DeviceUseRequest.replaces |
| requester | reference | Who/what is requesting service | DeviceUseRequest.requester |
| requisition | token | Composite request this is part of | DeviceUseRequest.requisition |
| stage | token | proposal | plan | original-order |reflex-order | DeviceUseRequest.stage |
| status | token | entered-in-error | draft | active |suspended | completed | DeviceUseRequest.status |
| subject | reference | Individual the service is ordered for | DeviceUseRequest.subject |
| DeviceUseStatement | |||
| device | reference | Search by device | DeviceUseStatement.device |
| patient | reference | Search by subject - a patient | DeviceUseStatement.subject |
| subject | reference | Search by subject | DeviceUseStatement.subject |
| DiagnosticReport | |||
| 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 |
| 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.encounter |
| 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 |
| request | reference | Reference to the test or procedure request. | DiagnosticReport.request |
| 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 |
| DiagnosticRequest | |||
| author-date | date | When the request transitioned to being actionable | DiagnosticRequest.authored |
| based-on | reference | Plan/proposal/order fulfilled by this request | DiagnosticRequest.basedOn |
| code | token | What’s being requested/ordered | DiagnosticRequest.code |
| definition | reference | Protocol or definition followed by this request | DiagnosticRequest.definition |
| encounter | reference | Encounter or Episode during which request was created | DiagnosticRequest.context |
| event-date | date | When service should occur | DiagnosticRequest.occurrence.as(DateTime) | DiagnosticRequest.occurrence.as(Period) |
| filler | reference | Desired performer for service | DiagnosticRequest.performer |
| identifier | token | Business identifier for request/order | DiagnosticRequest.identifier |
| patient | reference | Individual the service is ordered for | DiagnosticRequest.subject |
| replaces | reference | Request takes the place of referenced completed or terminated requests | DiagnosticRequest.replaces |
| requester | reference | Who/what is requesting service | DiagnosticRequest.requester |
| requisition | token | Composite request this is part of | DiagnosticRequest.requisition |
| stage | token | proposal | plan | original-order |reflex-order | DiagnosticRequest.stage |
| status | token | entered-in-error | draft | active |suspended | completed | DiagnosticRequest.status |
| subject | reference | Individual the service is ordered for | DiagnosticRequest.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 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 | |
| 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 |
| facility-identifier | token | Facility responsible for the goods and services | EligibilityRequest.facility.as(identifier) |
| facility-reference | reference | Facility responsible for the goods and services | EligibilityRequest.facility.as(Reference) |
| identifier | token | The business identifier of the Eligibility | EligibilityRequest.identifier |
| organization-identifier | token | The reference to the providing organization | EligibilityRequest.organization.as(identifier) |
| organization-reference | reference | The reference to the providing organization | EligibilityRequest.organization.as(Reference) |
| patient-identifier | token | The reference to the patient | EligibilityRequest.patient.as(Identifier) |
| patient-reference | reference | The reference to the patient | EligibilityRequest.patient.as(Reference) |
| provider-identifier | token | The reference to the provider | EligibilityRequest.provider.as(identifier) |
| provider-reference | reference | The reference to the provider | EligibilityRequest.provider.as(Reference) |
| 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 |
| organization-identifier | token | The organization which generated this resource | EligibilityResponse.organization.as(Identifier) |
| organization-reference | reference | The organization which generated this resource | EligibilityResponse.organization.as(Reference) |
| outcome | token | The processing outcome | EligibilityResponse.outcome |
| request-identifier | token | The EligibilityRequest reference | EligibilityResponse.request.as(Identifier) |
| request-organization-identifier | token | The EligibilityRequest organization | EligibilityResponse.requestOrganization.as(Identifier) |
| request-organization-reference | reference | The EligibilityRequest organization | EligibilityResponse.requestOrganization.as(Reference) |
| request-provider-identifier | token | The EligibilityRequest provider | EligibilityResponse.requestProvider.as(Identifier) |
| request-provider-reference | reference | The EligibilityRequest provider | EligibilityResponse.requestProvider.as(Reference) |
| request-reference | reference | The EligibilityRequest reference | EligibilityResponse.request.as(Reference) |
| Encounter | |||
| appointment | reference | The appointment that scheduled this encounter | Encounter.appointment |
| class | token | inpatient | outpatient | ambulatory | emergency + | Encounter.class |
| condition | reference | Reason the encounter takes place (resource) | Encounter.indication |
| date | date | A date within the period the Encounter lasted | Encounter.period |
| 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 |
| indication | reference | Reason the encounter takes place (resource) | Encounter.indication |
| 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 present at the encounter | Encounter.patient |
| practitioner | reference | Persons involved in the encounter other than the patient | Encounter.participant.individual |
| procedure | reference | Reason the encounter takes place (resource) | Encounter.indication |
| reason | token | Reason the encounter takes place (code) | Encounter.reason |
| special-arrangement | token | Wheelchair, translator, stretcher, etc. | Encounter.hospitalization.specialArrangement |
| status | token | planned | arrived | in-progress | onleave | finished | cancelled | entered-in-error | Encounter.status |
| type | token | Specific type of encounter | Encounter.type |
| Endpoint | |||
| 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 exposing 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 |
| patient-identifier | token | The party to be enrolled | EnrollmentRequest.subject.as(identifier) |
| patient-reference | reference | The party to be enrolled | EnrollmentRequest.subject.as(reference) |
| subject-identifier | token | The party to be enrolled | EnrollmentRequest.subject.as(identifier) |
| subject-reference | reference | The party to be enrolled | EnrollmentRequest.subject.as(reference) |
| EnrollmentResponse | |||
| identifier | token | The business identifier of the EnrollmentResponse | EnrollmentResponse.identifier |
| 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.condition |
| date | date | The provided date search value falls within the episode of care's period | EpisodeOfCare.period |
| identifier | token | Identifier(s) for the 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 | Patient for 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 | Text search in the description of the expansion profile | ExpansionProfile.description |
| identifier | token | The identifier for the expansion profile | ExpansionProfile.identifier |
| name | string | The name of the expansion profile | ExpansionProfile.name |
| publisher | string | Name of the publisher of the expansion profile | ExpansionProfile.publisher |
| status | token | The status of the expansion profile | ExpansionProfile.status |
| url | uri | The logical URL for the expansion profile | ExpansionProfile.url |
| version | token | The version identifier of the expansion profile | ExpansionProfile.version |
| ExplanationOfBenefit | |||
| claimidentifier | token | The reference to the claim | ExplanationOfBenefit.claim.as(Identifier) |
| claimreference | reference | The reference to the claim | ExplanationOfBenefit.claim.as(Reference) |
| created | date | The creation date for the EOB | ExplanationOfBenefit.created |
| disposition | string | The contents of the disposition message | ExplanationOfBenefit.disposition |
| facilityidentifier | token | Facility responsible for the goods and services | ExplanationOfBenefit.facility.as(Identifier) |
| facilityreference | reference | Facility responsible for the goods and services | ExplanationOfBenefit.facility.as(Reference) |
| identifier | token | The business identifier of the Explanation of Benefit | ExplanationOfBenefit.identifier |
| organizationidentifier | token | The reference to the providing organization | ExplanationOfBenefit.organization.as(Identifier) |
| organizationreference | reference | The reference to the providing organization | ExplanationOfBenefit.organization.as(Reference) |
| patientidentifier | token | The reference to the patient | ExplanationOfBenefit.patient.as(Identifier) |
| patientreference | reference | The reference to the patient | ExplanationOfBenefit.patient.as(Reference) |
| provideridentifier | token | The reference to the provider | ExplanationOfBenefit.provider.as(Identifier) |
| providerreference | reference | The reference to the provider | ExplanationOfBenefit.provider.as(Reference) |
| FamilyMemberHistory | |||
| code | token | A search by a condition code | FamilyMemberHistory.condition.code |
| date | date | When history was captured/updated | FamilyMemberHistory.date |
| 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 |
| 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 |
| 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 |
| status | token | proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled | on-target | ahead-of-target | behind-target | Goal.status |
| subject | reference | Who this goal is intended for | Goal.subject |
| targetdate | date | Reach goal on or before | Goal.target.as(Date) |
| 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 | |
| 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 | |||
| patient | reference | The identity of a patient to search for guidance response results | GuidanceResponse.subject |
| 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 |
| characteristic | token | One of the HealthcareService's characteristics | HealthcareService.characteristic |
| 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.serviceName |
| organization | reference | The organization that provides this Healthcare Service | HealthcareService.providedBy |
| programname | string | One of the Program Names serviced by this HealthcareService | HealthcareService.programName |
| servicecategory | token | Service Category of the Healthcare Service | HealthcareService.serviceCategory |
| servicetype | token | The type of service provided by this healthcare service | HealthcareService.serviceType |
| ImagingManifest | |||
| author | reference | Author of key DICOM object selection | ImagingManifest.author |
| authoring-time | date | Time of key DICOM object selection authoring | ImagingManifest.authoringTime |
| identifier | uri | UID of key DICOM object selection | ImagingManifest.uid |
| patient | reference | Subject of key DICOM object selection | ImagingManifest.patient |
| selected-study | uri | Study selected in key DICOM object selection | ImagingManifest.study.uid |
| title | token | Title of key DICOM object selection | ImagingManifest.title |
| 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 |
| 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 |
| 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.wasNotGiven |
| patient | reference | The patient for the vaccination record | Immunization.patient |
| performer | reference | The practitioner who administered the vaccination | Immunization.performer |
| 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 |
| requester | reference | The practitioner who ordered the vaccination | Immunization.requester |
| 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 |
| vaccine-type | token | Vaccine recommendation applies to | ImmunizationRecommendation.recommendation.vaccineCode |
| ImplementationGuide | |||
| context | token | A use context assigned to the structure | ImplementationGuide.useContext |
| date | date | The implementation guide publication date | ImplementationGuide.date |
| dependency | uri | Where to find dependency | ImplementationGuide.dependency.uri |
| description | string | Text search in the description of the implementation guide | ImplementationGuide.description |
| experimental | token | If for testing purposes, not real usage | ImplementationGuide.experimental |
| name | string | 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 | Absolute URL used to reference this Implementation Guide | ImplementationGuide.url |
| version | token | The version identifier of the implementation guide | ImplementationGuide.version |
| Library | |||
| description | string | Text search against the description | Library.description |
| identifier | token | Logical identifier for the module (e.g. CMS-143) | Library.identifier |
| status | token | Status of the module | Library.status |
| title | string | Text search against the title | Library.title |
| topic | token | Topics associated with the module | Library.topic |
| version | string | Version of the module (e.g. 1.0.0) | 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 |
| identifier | token | Unique code or number identifying the location to its users | Location.identifier |
| name | string | A (portion of the) name of the location or alias | Location.name or 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 be included also | Location.position |
| organization | reference | Searches for locations that are managed by the provided organization | Location.managingOrganization |
| partof | reference | The 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 | |||
| description | string | Text search against the description | Measure.description |
| identifier | token | Logical identifier for the module (e.g. CMS-143) | Measure.identifier |
| status | token | Status of the module | Measure.status |
| title | string | Text search against the title | Measure.title |
| topic | token | Topics associated with the module | Measure.topic |
| version | string | Version of the module (e.g. 1.0.0) | Measure.version |
| MeasureReport | |||
| patient | reference | The identity of a patient to search for individual measure report results for | MeasureReport.patient |
| Media | |||
| created | date | Date attachment was first created | Media.content.creation |
| 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 |
| 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 | carton + | Medication.product.form |
| ingredient | reference | The product contained | Medication.product.ingredient.item.as(Reference) |
| ingredient-code | token | The product contained | Medication.product.ingredient.item.as(CodeableConcept) |
| manufacturer | reference | Manufacturer of the item | Medication.manufacturer |
| 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) |
| MedicationAdministration | |||
| code | token | Return administrations of this medication code | MedicationAdministration.medication.as(CodeableConcept) |
| device | reference | Return administrations with this administration device identity | MedicationAdministration.device |
| effectivetime | date | Date administration happened (or did not happen) | MedicationAdministration.effectiveTime |
| encounter | reference | Return administrations that share this encounter | MedicationAdministration.encounter |
| identifier | token | Return administrations with this external identifier | MedicationAdministration.identifier |
| medication | reference | Return administrations of this medication resource | MedicationAdministration.medication.as(Reference) |
| patient | reference | The identity of a patient to list administrations for | MedicationAdministration.patient |
| performer | reference | Who administered substance | MedicationAdministration.performer |
| prescription | reference | The identity of a prescription to list administrations from | MedicationAdministration.prescription |
| status | token | MedicationAdministration event status (for example one of active/paused/completed/nullified) | MedicationAdministration.status |
| wasnotgiven | token | Administrations that were not made | MedicationAdministration.wasNotGiven |
| MedicationDispense | |||
| code | token | Return dispenses of this medicine code | MedicationDispense.medication.as(CodeableConcept) |
| destination | reference | Return dispenses that should be sent to a specific destination | MedicationDispense.destination |
| dispenser | reference | Return dispenses performed by a specific individual | MedicationDispense.dispenser |
| 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.patient |
| 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 |
| 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 |
| MedicationOrder | |||
| code | token | Return prescriptions of this medication code | MedicationOrder.medication.as(CodeableConcept) |
| datewritten | date | Return prescriptions written on this date | MedicationOrder.dateWritten |
| encounter | reference | Return prescriptions with this encounter identifier | MedicationOrder.encounter |
| identifier | token | Return prescriptions with this external identifier | MedicationOrder.identifier |
| medication | reference | Return prescriptions of this medication reference | MedicationOrder.medication.as(Reference) |
| patient | reference | The identity of a patient to list orders for | MedicationOrder.patient |
| prescriber | reference | Returns prescriptions prescribed by this prescriber | MedicationOrder.prescriber |
| status | token | Status of the prescription | MedicationOrder.status |
| MedicationStatement | |||
| code | token | Return statements of this medication code | MedicationStatement.medication.as(CodeableConcept) |
| 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) |
| patient | reference | The identity of a patient to list statements for | MedicationStatement.patient |
| source | reference | Who the information in the statement came from | MedicationStatement.informationSource |
| status | token | Return statements that match the given status | MedicationStatement.status |
| MessageHeader | |||
| author | reference | The source of the decision | MessageHeader.author |
| code | token | ok | transient-error | fatal-error | MessageHeader.response.code |
| data | reference | The actual content of the message | MessageHeader.data |
| 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 |
| 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 |
| 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 |
| context | token | Content intends to support these contexts | NamingSystem.useContext |
| date | date | Publication Date(/time) | NamingSystem.date |
| id-type | token | oid | uuid | uri | other | NamingSystem.uniqueId.type |
| kind | token | codesystem | identifier | root | NamingSystem.kind |
| name | string | Human-readable label | NamingSystem.name |
| period | date | When is identifier valid? | NamingSystem.uniqueId.period |
| publisher | string | Name of the publisher (Organization or individual) | NamingSystem.publisher |
| replaced-by | reference | Use this instead | NamingSystem.replacedBy |
| responsible | string | Who maintains system namespace? | NamingSystem.responsible |
| status | token | draft | active | retired | NamingSystem.status |
| telecom | token | Contact details for individual or publisher | NamingSystem.contact.telecom |
| type | token | e.g. driver, provider, patient, bank etc. | NamingSystem.type |
| value | string | The unique identifier | NamingSystem.uniqueId.value |
| NutritionRequest | |||
| additive | token | Type of module component to add to the feeding | NutritionRequest.enteralFormula.additiveType |
| datetime | date | Return nutrition orders requested on this date | NutritionRequest.dateTime |
| encounter | reference | Return nutrition orders with this encounter identifier | NutritionRequest.encounter |
| formula | token | Type of enteral or infant formula | NutritionRequest.enteralFormula.baseFormulaType |
| identifier | token | Return nutrition orders with this external identifier | NutritionRequest.identifier |
| oraldiet | token | Type of diet that can be consumed orally (i.e., take via the mouth). | NutritionRequest.oralDiet.type |
| patient | reference | The identity of the person who requires the diet, formula or nutritional supplement | NutritionRequest.patient |
| provider | reference | The identify of the provider who placed the nutrition order | NutritionRequest.orderer |
| status | token | Status of the nutrition order. | NutritionRequest.status |
| supplement | token | Type of supplement product requested | NutritionRequest.supplement.type |
| Observation | |||
| category | token | The classification of the type of observation | Observation.category |
| code | token | The code of the observation type or component type | Observation.code | Observation.component.code |
| code-value-[x] | composite | Code and value parameter pair | |
| data-absent-reason | token | The reason why the expected value in the element Observation.value[x] is missing. | Observation.dataAbsentReason | Observation.component.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 | Healthcare event related to the observation | Observation.encounter |
| 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 | |
| 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 or component value of the observation, if the value is a CodeableConcept | Observation.value.as(CodeableConcept) | Observation.component.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 or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) | Observation.value.as(Quantity) | Observation.component.value.as(Quantity) |
| value-string | string | The value or component value of the observation, if the value is a string, and also searches in CodeableConcept.text | Observation.value.as(String) | Observation.component.value.as(String) |
| OperationDefinition | |||
| base | reference | Marks this as a profile of the base | OperationDefinition.base |
| code | token | Name used to invoke the operation | OperationDefinition.code |
| context | token | A use context assigned to the operation definition | OperationDefinition.useContext |
| date | date | Date for this version of the operation definition | OperationDefinition.date |
| instance | token | Invoke on an instance? | OperationDefinition.instance |
| kind | token | operation | query | OperationDefinition.kind |
| name | string | Informal name for this operation | OperationDefinition.name |
| paramprofile | reference | Profile on the type | OperationDefinition.parameter.profile |
| publisher | string | Name of the publisher (Organization or individual) | OperationDefinition.publisher |
| status | token | draft | active | retired | OperationDefinition.status |
| system | token | Invoke at the system level? | OperationDefinition.system |
| type | token | Invoke at resource level for these type | OperationDefinition.type |
| url | uri | Logical URL to reference this operation definition | OperationDefinition.url |
| version | token | Logical id for this 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 |
| 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 or Organization.alias |
| partof | reference | Search all organizations that are part of the given organization | 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 |
| race | token | Returns patients with a race extension matching the specified code. | |
| ethnicity | token | Returns patients with an ethnicity extension matching the specified code. | |
| PaymentNotice | |||
| created | date | Creation date fro the notice | PaymentNotice.created |
| identifier | token | The business identifier of the notice | PaymentNotice.identifier |
| organization-identifier | token | The organization who generated this resource | PaymentNotice.organization.as(Identifier) |
| organization-reference | reference | The organization who generated this resource | PaymentNotice.organization.as(Reference) |
| payment-status | token | The type of payment notice | PaymentNotice.paymentStatus |
| provider-identifier | token | The reference to the provider | PaymentNotice.provider.as(Identifier) |
| provider-reference | reference | The reference to the provider | PaymentNotice.provider.as(Reference) |
| request-identifier | token | The Claim | PaymentNotice.request.as(Identifier) |
| request-reference | reference | The Claim | PaymentNotice.request.as(Reference) |
| response-identifier | token | The ClaimResponse | PaymentNotice.response.as(Identifier) |
| response-reference | reference | The ClaimResponse | PaymentNotice.response.as(Reference) |
| 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-identifier | token | The organization who generated this resource | PaymentReconciliation.organization.as(Identifier) |
| organization-reference | reference | The organization who generated this resource | PaymentReconciliation.organization.as(Reference) |
| outcome | token | The processing outcome | PaymentReconciliation.outcome |
| request-identifier | token | The reference to the claim | PaymentReconciliation.request.as(Identifier) |
| request-organization-identifier | token | The organization who generated this resource | PaymentReconciliation.requestOrganization.as(Identifier) |
| request-organization-reference | reference | The organization who generated this resource | PaymentReconciliation.requestOrganization.as(Reference) |
| request-provider-identifier | token | The reference to the provider who sumbitted the claim | PaymentReconciliation.requestProvider.as(Identifier) |
| request-provider-reference | reference | The reference to the provider who sumbitted the claim | PaymentReconciliation.requestProvider.as(Reference) |
| request-reference | reference | The reference to the claim | PaymentReconciliation.request.as(Reference) |
| 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 | |||
| description | string | Text search against the description | PlanDefinition.description |
| identifier | token | Logical identifier for the module (e.g. CMS-143) | PlanDefinition.identifier |
| status | token | Status of the module | PlanDefinition.status |
| title | string | Text search against the title | PlanDefinition.title |
| topic | token | Topics associated with the module | PlanDefinition.topic |
| version | string | Version of the module (e.g. 1.0.0) | 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') or Practitioner.role.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 | Practitioner.role.identifier |
| location | reference | One of the locations at which this practitioner provides care | Practitioner.role.location |
| 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 |
| organization | reference | The identity of the organization the practitioner represents / acts on behalf of | Practitioner.role.organization |
| phone | token | A value in a phone contact | Practitioner.telecom.where(system='phone') or Practitioner.role.telecom.where(system='phone') |
| phonetic | string | A portion of either family or given name using some kind of phonetic matching algorithm | Practitioner.name |
| role | token | The practitioner can perform this role at for the organization | Practitioner.role.code |
| specialty | token | The practitioner has this specialty at an organization | Practitioner.role.specialty |
| telecom | token | The value in any kind of contact | Practitioner.telecom | Practitioner.role.telecom |
| PractitionerRole | |||
| token | A value in an email contact | PractitionerRole.telecom.where(system='email') | |
| 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 |
| specialty | token | The practitioner has this specialty at an organization | PractitionerRole.specialty |
| telecom | token | The value in any kind of contact | PractitionerRole.telecom |
| Procedure | |||
| category | token | Classification of the procedure | Procedure.category |
| code | token | A code to identify a procedure | Procedure.code |
| date | date | Date/Period the procedure was performed | Procedure.performed |
| encounter | reference | The encounter associated with the procedure | Procedure.encounter |
| identifier | token | A unique identifier for a procedure | Procedure.identifier |
| location | reference | Where the procedure happened | Procedure.location |
| patient | reference | Search by subject - a patient | Procedure.subject |
| performer | reference | The reference to the practitioner | Procedure.performer.actor |
| subject | reference | Search by subject | Procedure.subject |
| ProcedureRequest | |||
| encounter | reference | Encounter request created during | ProcedureRequest.encounter |
| identifier | token | A unique identifier of the Procedure Request | ProcedureRequest.identifier |
| orderer | reference | Who made request | ProcedureRequest.orderer |
| patient | reference | Search by subject - a patient | ProcedureRequest.subject |
| performer | reference | Who should perform the procedure | ProcedureRequest.performer |
| 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-identifier | token | The organization who generated this request | ProcessRequest.organization.as(Identifier) |
| organization-reference | reference | The organization who generated this request | ProcessRequest.organization.as(Reference) |
| provider-identifier | token | The provider who regenerated this request | ProcessRequest.provider.as(Identifier) |
| provider-reference | reference | The provider who regenerated this request | ProcessRequest.provider.as(Reference) |
| ProcessResponse | |||
| identifier | token | The business identifier of the Explanation of Benefit | ProcessResponse.identifier |
| organization-identifier | token | The organization who generated this resource | ProcessResponse.organization.as(Identifier) |
| organization-reference | reference | The organization who generated this resource | ProcessResponse.organization.as(Reference) |
| request-identifier | token | The reference to the claim | ProcessResponse.request.as(Identifier) |
| request-organization-identifier | token | The Organization who is responsible the request transaction | ProcessResponse.requestOrganization.as(Identifier) |
| request-organization-reference | reference | The Organization who is responsible the request transaction | ProcessResponse.requestOrganization.as(Reference) |
| request-provide-ridentifier | token | The Provider who is responsible the request transaction | ProcessResponse.requestProvider.as(Identifier) |
| request-provider-reference | reference | The Provider who is responsible the request transaction | ProcessResponse.requestProvider.as(Reference) |
| request-reference | reference | The reference to the claim | ProcessResponse.request.as(Reference) |
| Provenance | |||
| agent | reference | Individual, device or organization playing role | Provenance.agent.actor |
| end | date | End time with inclusive boundary, if not ongoing | Provenance.period.end |
| entity | uri | Identity of entity | Provenance.entity.reference |
| entity-type | token | The type of resource in this entity | Provenance.entity.type |
| location | reference | Where the activity occurred, if relevant | Provenance.location |
| patient | reference | Target Reference(s) (usually version specific) | Provenance.target |
| sig | 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 |
| userid | token | Authorization-system identifier for the agent | Provenance.agent.userId |
| Questionnaire | |||
| code | token | A code that corresponds to the questionnaire or one of its groups | Questionnaire.item.concept |
| context | token | A use context assigned to the questionnaire | Questionnaire.useContext |
| date | date | When the questionnaire was last changed | Questionnaire.date |
| identifier | token | An identifier for the questionnaire | Questionnaire.identifier |
| publisher | string | The author of the questionnaire | Questionnaire.publisher |
| status | token | The status of the questionnaire | Questionnaire.status |
| title | string | All or part of the name of the questionnaire | Questionnaire.title |
| version | string | The business version of the questionnaire | Questionnaire.version |
| QuestionnaireResponse | |||
| author | reference | The author of the questionnaire | QuestionnaireResponse.author |
| authored | date | When the questionnaire was authored | QuestionnaireResponse.authored |
| based-on | reference | Plan/proposal/order fulfilled by this questionnaire response | QuestionnaireResponse.basedOn |
| context | reference | Encounter or episode during which questionnaire was authored | QuestionnaireResponse.context |
| identifier | token | The unique identifier for the questionnaire response | QuestionnaireResponse.identifier |
| parent | reference | Procedure or observation this questionnaire response is part of | QuestionnaireResponse.parent |
| patient | reference | The patient that is the subject of the questionnaire | QuestionnaireResponse.subject |
| questionnaire | reference | The questionnaire the answers are provided for | QuestionnaireResponse.questionnaire |
| source | reference | The person who answered the questions | QuestionnaireResponse.source |
| status | token | The status of the questionnaire response | QuestionnaireResponse.status |
| subject | reference | The subject of the questionnaire | QuestionnaireResponse.subject |
| ReferralRequest | |||
| basedon | reference | Request being fulfilled | ReferralRequest.basedOn |
| category | token | Proposal, plan or request | ReferralRequest.category |
| context | reference | Part of encounter or episode of care | ReferralRequest.context |
| date | date | Creation or activation date | ReferralRequest.authored |
| parent | token | Part of common request | ReferralRequest.parent |
| patient | reference | Who the referral is about | ReferralRequest.patient |
| priority | token | The priority assigned to the referral | ReferralRequest.priority |
| recipient | reference | The person that the referral was sent to | ReferralRequest.recipient |
| requester | reference | Requester of referral / transfer of care | ReferralRequest.requester |
| specialty | token | The specialty that the referral is for | ReferralRequest.specialty |
| status | token | The status of the referral | ReferralRequest.status |
| type | token | The type of the referral | ReferralRequest.type |
| RelatedPerson | |||
| active | token | Wheter 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 person | RelatedPerson.gender |
| identifier | token | A patient Identifier | 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 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 |
| 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 |
| 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 this search parameter applies to | SearchParameter.base |
| code | token | Code used in URL | SearchParameter.code |
| component | reference | For Composite resources to define the parts | SearchParameter.component |
| context | token | A use context assigned to the search parameter | SearchParameter.useContext |
| description | string | Documentation for search parameter | SearchParameter.description |
| name | string | Informal name for this search parameter | SearchParameter.name |
| 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 | Absolute URL used to reference this search parameter | SearchParameter.url |
| Sequence | |||
| chromosome | token | Chromosome of the sequence | Sequence.referenceSeq.chromosome |
| coordinate | composite | Genomic coordinate of the sequence. For example, a search for sequence in region 1:123-345 can be represented as `coordinate=1$lt345$gt123` | |
| end | number | End position (0-based exclusive) of the sequence | Sequence.variant.end |
| patient | reference | The subject that the observation is about | Sequence.patient |
| start | number | Start position (0-based inclusive) of the sequence | Sequence.variant.start |
| type | token | The type of the variant: Amino acid / cDNA transcript / RNA variant. | Sequence.type |
| 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 |
| 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 |
| code | token | A code for the profile | StructureDefinition.code |
| context | token | A use context assigned to the structure | StructureDefinition.useContext |
| context-type | token | resource | datatype | extension | StructureDefinition.contextType |
| date | date | The profile publication date | StructureDefinition.date |
| derivation | token | specialization | constraint - How relates to base definition | StructureDefinition.derivation |
| description | string | Text search in the description of the profile | StructureDefinition.description |
| display | string | Use this name when displaying the value | StructureDefinition.display |
| experimental | token | If for testing purposes, not real usage | StructureDefinition.experimental |
| ext-context | string | Where the extension can be used in instances | StructureDefinition.context |
| identifier | token | The identifier of the profile | StructureDefinition.identifier |
| kind | token | primitive-type | complex-type | resource | logical | StructureDefinition.kind |
| name | string | Name of the profile | 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 profile | StructureDefinition.publisher |
| status | token | The current status of the profile | StructureDefinition.status |
| type | token | Type defined or constrained by this structure | StructureDefinition.type |
| url | uri | Absolute URL used to reference this StructureDefinition | StructureDefinition.url |
| valueset | reference | A vocabulary binding reference | StructureDefinition.snapshot.element.binding.valueSet |
| version | token | The version identifier of the profile | StructureDefinition.version |
| StructureMap | |||
| context | token | A use context assigned to the structure | StructureMap.useContext |
| date | date | The profile publication date | StructureMap.date |
| description | string | Text search in the description of the profile | StructureMap.description |
| experimental | token | Whether the map is defined purely for experimental reasons | StructureMap.experimental |
| identifier | token | The identifier of the profile | StructureMap.identifier |
| name | string | Name of the profile | StructureMap.name |
| publisher | string | Name of the publisher of the profile | StructureMap.publisher |
| status | token | The current status of the profile | StructureMap.status |
| url | uri | The url that identifies the structure map | StructureMap.url |
| version | token | The version identifier of the profile | StructureMap.version |
| Subscription | |||
| contact | token | Contact details for source (e.g. troubleshooting) | Subscription.contact |
| criteria | string | Rule for server push criteria | Subscription.criteria |
| payload | string | Mimetype to send, or omit for no payload | Subscription.channel.payload |
| status | token | requested | active | error | off | Subscription.status |
| tag | token | A tag to add to matching resources | Subscription.tag |
| type | token | rest-hook | websocket | email | sms | message | Subscription.channel.type |
| url | uri | Where the channel points to | 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 |
| 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 | SupplyDelivery.status |
| supplier | reference | Dispenser | SupplyDelivery.supplier |
| SupplyRequest | |||
| date | date | When the request was made | SupplyRequest.date |
| identifier | token | Unique identifier | SupplyRequest.identifier |
| kind | token | The kind of supply (central, non-stock, etc.) | SupplyRequest.kind |
| patient | reference | Patient for whom the item is supplied | SupplyRequest.patient |
| source | reference | Who initiated this order | SupplyRequest.source |
| status | token | requested | completed | failed | cancelled | SupplyRequest.status |
| supplier | reference | Who is intended to fulfill the request | SupplyRequest.supplier |
| Task | |||
| code | token | Search by task code | Task.code |
| created | date | Search by creation date | Task.created |
| definition | uri | Search by task definition | Task.definition |
| focus | reference | Search by task focus | Task.focus |
| identifier | token | Search for a task instance by its business identifier | Task.identifier |
| modified | date | Search by last modification date | Task.lastModified |
| owner | reference | Search by task owner | Task.owner |
| parent | reference | Search by parent task | Task.parent |
| patient | reference | Search by patient | Task.for |
| performer | token | Search by recommended type of performer (e.g., Requester, Performer, Scheduler). | Task.performerType |
| priority | token | Search by task priority | Task.priority |
| requester | reference | Search by task requester | Task.requester |
| stage | token | Search by task stage | Task.stage |
| status | token | Search by task status | Task.status |
| statusreason | token | Search by status reason | Task.statusReason |
| TestScript | |||
| date | date | Date for this version of the TestScript | TestScript.date |
| description | string | Natural language description of the TestScript | TestScript.description |
| identifier | token | External identifier | TestScript.identifier |
| name | string | Informal name for this TestScript | TestScript.name |
| publisher | string | Name of the publisher (Organization or individual) | TestScript.publisher |
| testscript-capability | string | TestScript required and validated capability | TestScript.metadata.capability.description |
| url | uri | Absolute URL used to reference this TestScript | TestScript.url |
| use-context | token | Content intends to support these contexts | TestScript.useContext |
| ValueSet | |||
| context | token | A use context assigned to the value set | ValueSet.useContext |
| date | date | The value set publication date | ValueSet.date |
| description | string | Text search in the description of the value set | ValueSet.description |
| expansion | uri | Uniquely identifies this expansion | ValueSet.expansion.identifier |
| identifier | token | The identifier for the value set | ValueSet.identifier |
| name | string | The 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 status of the value set | ValueSet.status |
| url | uri | The logical URL for the value set | ValueSet.url |
| version | token | The version identifier 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 |
© HL7.org 2011+. FHIR STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:07+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change