| Provenance: |
| _content | | Search on the entire content of the resource | |
| _filter | | This is the formal declaration for the _filter parameter, documented at [http://hl7.org/fhir/search_filter.html](http://hl7.org/fhir/search_filter.html) | |
| _id | | Logical id of this artifact | |
| _in | | Allows for the retrieval of resources that are active members of a CareTeam, Group, or List | |
| _language | | Language of the resource content | |
| _lastUpdated | | When the resource version last changed on given date (yyyy-mm-dd) | |
| (before) | | (before given date) | |
| (after) | | (after given date) | |
| _list | | Allows for the retrieval of resources that are referenced by a List resource or by one of the pre-defined functional lists | |
| _query | | A custom search profile that describes a specific defined query operation | |
| _security | | Security Labels applied to this resource | |
| _source | | Identifies where the resource comes from | |
| _tag | | Tags applied to this resource | |
| _text | | Text search against the narrative | |
| _type | | A resource type filter | |
| activity | | Activity that occurred | |
| agent-role | | What the agents role was | |
| agent-type | | How the agent participated | |
| recorded | | When the activity was recorded / updated on given date (yyyy-mm-dd) | |
| (before) | | (before given date) | |
| (after) | | (after given date) | |
| signature-type | | Indication of the reason the entity signed the object(s) | |
| when | | When the activity occurred on given date (yyyy-mm-dd) | |
| (before) | | (before given date) | |
| (after) | | (after given date) | |
| _text | | Search on the narrative of the resource | |
| _profile (StructureDefinition): |
| _content | | Search on the entire content of the resource | |
| _filter | | This is the formal declaration for the _filter parameter, documented at [http://hl7.org/fhir/search_filter.html](http://hl7.org/fhir/search_filter.html) | |
| _id | | Logical id of this artifact | |
| _in | | Allows for the retrieval of resources that are active members of a CareTeam, Group, or List | |
| _language | | Language of the resource content | |
| _lastUpdated (exact) | | When the resource version last changed | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| _list | | Allows for the retrieval of resources that are referenced by a List resource or by one of the pre-defined functional lists | |
| _profile | | Profiles this resource claims to conform to | |
| _query | | A custom search profile that describes a specific defined query operation | |
| _security | | Security Labels applied to this resource | |
| _source | | Identifies where the resource comes from | |
| _tag | | Tags applied to this resource | |
| _text | | Text search against the narrative | |
| _type | | A resource type filter | |
| abstract | | Whether the structure is abstract | |
| base | | Definition that this type is constrained/specialized from | |
| base-path | | Path that identifies the base element | |
| context | | ): A use context assigned to the structure definition | |
| context-quantity | | ): A quantity- or range-valued use context assigned to the structure definition | |
| context-type | | ): A type of use context assigned to the structure definition | |
| context-type-quantity | | ): A use context type and quantity- or range-based value assigned to the structure definition | |
| context-type-value | | ): A use context type and value assigned to the structure definition | |
| date (exact) | | ): The structure definition publication date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| derivation | | specialization | constraint - How relates to base definition | |
| description | | ): The description of the structure definition | |
| experimental | | For testing purposes, not real usage | |
| ext-context | | An extension context assigned to the structure definition | |
| ext-context-expression | | An expression of extension context assigned to the structure definition | |
| ext-context-type | | A type of extension context assigned to the structure definition | |
| identifier | | ): External identifier for the structure definition | |
| jurisdiction | | ): Intended jurisdiction for the structure definition | |
| keyword | | A code for the StructureDefinition | |
| kind | | primitive-type | complex-type | resource | logical | |
| name | | ): Computationally friendly name of the structure definition | |
| path | | A path that is constrained in the StructureDefinition | |
| publisher | | ): Name of the publisher of the structure definition | |
| status | | ): The current status of the structure definition | |
| title | | ): The human-friendly name of the structure definition | |
| type | | Type defined or constrained by this structure | |
| url | | ): The uri that identifies the structure definition | |
| valueset | | A vocabulary binding reference | |
| version | | ): The business version of the structure definition | |
| agent (Practitioner / Organization / CareTeam / Device / Patient / PractitionerRole / RelatedPerson): |
| _content | | Search on the entire content of the resource | |
| _filter | | This is the formal declaration for the _filter parameter, documented at [http://hl7.org/fhir/search_filter.html](http://hl7.org/fhir/search_filter.html) | |
| _id | | Logical id of this artifact | |
| _in | | Allows for the retrieval of resources that are active members of a CareTeam, Group, or List | |
| _language | | Language of the resource content | |
| _lastUpdated (exact) | | When the resource version last changed | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| _list | | Allows for the retrieval of resources that are referenced by a List resource or by one of the pre-defined functional lists | |
| _profile | | Profiles this resource claims to conform to | |
| _query | | A custom search profile that describes a specific defined query operation | |
| _security | | Security Labels applied to this resource | |
| _source | | Identifies where the resource comes from | |
| _tag | | Tags applied to this resource | |
| _text | | Text search against the narrative | |
| _type | | A resource type filter | |
| category | | Type of team | |
| date (exact) | | ): A date within the coverage time period. | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| identifier | | ): External Ids for this team | |
| name | | Name of the team, such as crisis assessment team | |
| participant | | Who is involved | |
| patient | | ): Who care team is for | |
| status | | proposed | active | suspended | inactive | entered-in-error | |
| subject | | Who care team is for | |
| biological-source-event | | The biological source for the device | |
| definition | | The definition / type of the device | |
| device-name | | A server defined search that may match any of the string fields in Device.deviceName or Device.type. | |
| din | | The donation identification number (DIN) | |
| expiration-date (exact) | | The expiration date of the device | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| location | | A location, where the resource is found | |
| lot-number | | The lot number of the device | |
| manufacture-date (exact) | | The manufacture date of the device | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| manufacturer | | The manufacturer of the device | |
| model | | The model of the device | |
| organization | | The organization responsible for the device | |
| parent | | The parent device | |
| serial-number | | The serial number of the device | |
| type | | The type of the device | |
| udi-carrier | | UDI Barcode (RFID or other technology) string in *HRF* format. | |
| udi-di | | The udi Device Identifier (DI) | |
| url | | Network address to contact device | |
| version | | The specific version of the device | |
| active | | Is the Organization record active | |
| address | | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text | |
| address-city | | A city specified in an address | |
| address-country | | A country specified in an address | |
| address-postalcode | | A postal code specified in an address | |
| address-state | | A state specified in an address | |
| address-use | | A use code specified in an address | |
| endpoint | | Technical endpoints providing access to services operated for the organization | |
| partof | | An organization of which this organization forms a part | |
| phonetic | | A portion of the organization's name using some kind of phonetic matching algorithm | |
| age | | Searches for patients based on age as calculated based on current date and date of birth. Deceased patients are excluded from the search. | |
| birthOrderBoolean | | Search based on whether a patient was part of a multiple birth or not. | |
| birthdate (exact) | | ): The patient's date of birth | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| death-date (exact) | | The date of death has been provided and satisfies this search value | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| deceased | | This patient has been marked as deceased, or has a death date entered | |
| email | | ): A value in an email contact | |
| family | | ): A portion of the family name of the patient | |
| gender | | ): Gender of the patient | |
| general-practitioner | | Patient's nominated general practitioner, not the organization that manages the record | |
| given | | ): A portion of the given name of the patient | |
| language | | Language code (irrespective of use value) | |
| link | | All patients/related persons linked to the given patient | |
| mothersMaidenName | | Search based on patient's mother's maiden name | |
| phone | | ): A value in a phone contact | |
| telecom | | ): The value in any kind of telecom details of the patient | |
| communication | | One of the languages that the practitioner can communicate with | |
| qualification-period (exact) | | The date(s) a qualification is valid for | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| practitioner | | Practitioner that is able to provide the defined services for the organization | |
| role | | The practitioner can perform this role at for the organization | |
| service | | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |
| specialty | | The practitioner has this specialty at an organization | |
| relationship | | The relationship between the patient and the relatedperson | |
| based-on (CarePlan / MedicationRequest / Task / NutritionOrder / DeviceRequest / ServiceRequest / ImmunizationRecommendation): |
| _content | | Search on the entire content of the resource | |
| _filter | | This is the formal declaration for the _filter parameter, documented at [http://hl7.org/fhir/search_filter.html](http://hl7.org/fhir/search_filter.html) | |
| _id | | Logical id of this artifact | |
| _in | | Allows for the retrieval of resources that are active members of a CareTeam, Group, or List | |
| _language | | Language of the resource content | |
| _lastUpdated (exact) | | When the resource version last changed | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| _list | | Allows for the retrieval of resources that are referenced by a List resource or by one of the pre-defined functional lists | |
| _profile | | Profiles this resource claims to conform to | |
| _query | | A custom search profile that describes a specific defined query operation | |
| _security | | Security Labels applied to this resource | |
| _source | | Identifies where the resource comes from | |
| _tag | | Tags applied to this resource | |
| _text | | Text search against the narrative | |
| _type | | A resource type filter | |
| activity-code | | Detail type of activity | |
| activity-reference | | Activity that is intended to be part of the care plan | |
| activity-scheduled-date (exact) | | Specified date occurs within period specified by CarePlan.activity.plannedActivityDetail.scheduled[x] | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| activity-scheduled-string | | When activity is to occur | |
| based-on | | Fulfills CarePlan | |
| care-team | | Who's involved in plan? | |
| category | | Type of plan | |
| condition | | Reference to a resource (by instance) | |
| custodian | | Who is the designated responsible party | |
| date (exact) | | ): Time period plan covers | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| encounter | | The Encounter during which this CarePlan was created | |
| goal | | Desired outcome of plan | |
| identifier | | ): External Ids for this plan | |
| instantiates-canonical | | Instantiates FHIR protocol or definition | |
| instantiates-uri | | Instantiates external protocol or definition | |
| intent | | proposal | plan | order | option | directive | |
| part-of | | Part of referenced CarePlan | |
| patient | | ): Who the care plan is for | |
| performer | | Matches if the practitioner is listed as a performer in any of the "simple" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.) | |
| replaces | | CarePlan replaced by this CarePlan | |
| status | | draft | active | on-hold | revoked | completed | entered-in-error | unknown | |
| subject | | Who the care plan is for | |
| authored-on (exact) | | When the request transitioned to being actionable | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| code | | ): Code for what is being requested/ordered | |
| device | | Reference to resource that is being requested/ordered | |
| event-date (exact) | | When service should occur | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| group-identifier | | Composite request this is part of | |
| insurance | | Associated insurance coverage | |
| prior-request | | Request takes the place of referenced completed or terminated requests | |
| requester | | Who/what is requesting service | |
| information | | Patient observations supporting recommendation | |
| support | | Past immunizations supporting recommendation | |
| target-disease | | Disease to be immunized against | |
| vaccine-type | | Vaccine or vaccine group recommendation applies to | |
| authoredon (exact) | | Return prescriptions written on this date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| combo-date (exact) | | Returns medication request to be administered on a specific date or within a date range | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| intended-dispenser | | Returns prescriptions intended to be dispensed by this Organization | |
| intended-performer | | Returns the intended performer of the administration of the medication request | |
| intended-performertype | | Returns requests for a specific type of performer | |
| medication | | ): Return prescriptions for this medication reference | |
| priority | | Returns prescriptions with different priorities | |
| additive | | Type of module component to add to the feeding | |
| datetime (exact) | | Return nutrition orders requested on this date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| formula | | Type of enteral or infant formula | |
| oraldiet | | Type of diet that can be consumed orally (i.e., take via the mouth). | |
| provider | | The identity of the provider who placed the nutrition order | |
| supplement | | Type of supplement product requested | |
| authored (exact) | | Date request signed | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| body-site | | Where procedure is going to be done | |
| body-structure | | Body structure Where procedure is going to be done | |
| code-concept | | What is being requested/ordered | |
| code-reference | | What is being requested/ordered | |
| occurrence (exact) | | When service should occur | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| performer-type | | Performer role | |
| requisition | | Composite Request ID | |
| specimen | | Specimen to be tested | |
| business-status | | Search by business status | |
| focus | | Search by task focus | |
| modified (exact) | | Search by last modification date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| output | | Search by task output | |
| owner | | Search by task owner | |
| period (exact) | | Search by period Task is/was underway | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| encounter (Encounter): |
| _content | | Search on the entire content of the resource | |
| _filter | | This is the formal declaration for the _filter parameter, documented at [http://hl7.org/fhir/search_filter.html](http://hl7.org/fhir/search_filter.html) | |
| _id | | Logical id of this artifact | |
| _in | | Allows for the retrieval of resources that are active members of a CareTeam, Group, or List | |
| _language | | Language of the resource content | |
| _lastUpdated (exact) | | When the resource version last changed | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| _list | | Allows for the retrieval of resources that are referenced by a List resource or by one of the pre-defined functional lists | |
| _profile | | Profiles this resource claims to conform to | |
| _query | | A custom search profile that describes a specific defined query operation | |
| _security | | Security Labels applied to this resource | |
| _source | | Identifies where the resource comes from | |
| _tag | | Tags applied to this resource | |
| _text | | Text search against the narrative | |
| _type | | A resource type filter | |
| account | | The set of accounts that may be used for billing for this Encounter | |
| appointment | | The appointment that scheduled this encounter | |
| based-on | | The ServiceRequest that initiated this encounter | |
| careteam | | Careteam allocated to participate in the encounter | |
| class | | Classification of patient encounter | |
| date (exact) | | ): A date within the actualPeriod the Encounter lasted | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| date-start (exact) | | The actual start date of the Encounter | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| diagnosis | | The diagnosis or procedure relevant to the encounter | |
| end-date (exact) | | The actual end date of the Encounter | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| episode-of-care | | Episode(s) of care that this encounter should be recorded against | |
| identifier | | ): Identifier(s) by which this encounter is known | |
| length | | Length of encounter in days | |
| location | | Location the encounter takes place | |
| location-period (exact) | | Time period during which the patient was present at the location | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| part-of | | Another Encounter this encounter is part of | |
| participant | | Persons involved in the encounter other than the patient | |
| participant-type | | Role of participant in encounter | |
| patient | | ): The patient present at the encounter | |
| practitioner | | Persons involved in the encounter other than the patient | |
| reason-code | | Reference to a concept (by class) | |
| reason-reference | | Reference to a resource (by instance) | |
| service-provider | | The organization (facility) responsible for this encounter | |
| special-arrangement | | Wheelchair, translator, stretcher, etc. | |
| status | | planned | in-progress | onhold | completed | cancelled | entered-in-error | unknown | |
| subject | | The patient or group present at the encounter | |
| subject-status | | The current status of the subject in relation to the Encounter | |
| type | | ): Specific type of encounter | |
| entity (--None-- / Account / ActivityDefinition / ActorDefinition / AdministrableProductDefinition / AdverseEvent / AllergyIntolerance / Appointment / AppointmentResponse / ArtifactAssessment / AuditEvent / Basic / Binary / BiologicallyDerivedProduct / BodyStructure / Bundle / CapabilityStatement / CarePlan / CareTeam / ChargeItem / ChargeItemDefinition / Citation / Claim / ClaimResponse / ClinicalImpression / ClinicalUseDefinition / CodeSystem / Communication / CommunicationRequest / CompartmentDefinition / Composition / ConceptMap / Condition / ConditionDefinition / Consent / Contract / Coverage / CoverageEligibilityRequest / CoverageEligibilityResponse / DetectedIssue / Device / DeviceDefinition / DeviceDispense / DeviceMetric / DeviceRequest / DeviceUsage / DiagnosticReport / DocumentManifest / DocumentReference / Encounter / Endpoint / EnrollmentRequest / EnrollmentResponse / EpisodeOfCare / EventDefinition / Evidence / EvidenceReport / EvidenceVariable / ExampleScenario / ExplanationOfBenefit / FamilyMemberHistory / Flag / FormularyItem / GenomicStudy / Goal / GraphDefinition / Group / GuidanceResponse / HealthcareService / ImagingSelection / ImagingStudy / Immunization / ImmunizationEvaluation / ImmunizationRecommendation / ImplementationGuide / Ingredient / InsurancePlan / InventoryReport / Invoice / Library / Linkage / List / Location / ManufacturedItemDefinition / Measure / MeasureReport / Medication / MedicationAdministration / MedicationDispense / MedicationKnowledge / MedicationRequest / MedicationUsage / MedicinalProductDefinition / MessageDefinition / MessageHeader / MolecularSequence / NamingSystem / NutritionIntake / NutritionOrder / NutritionProduct / Observation / ObservationDefinition / OperationDefinition / OperationOutcome / Organization / OrganizationAffiliation / PackagedProductDefinition / Parameters / Patient / PaymentNotice / PaymentReconciliation / Permission / Person / PlanDefinition / Practitioner / PractitionerRole / Procedure / Provenance / Questionnaire / QuestionnaireResponse / RegulatedAuthorization / RelatedPerson / RequestGroup / RequestOrchestration / Requirements / ResearchStudy / ResearchSubject / RiskAssessment / Schedule / SearchParameter / ServiceRequest / Slot / Specimen / SpecimenDefinition / StructureDefinition / StructureMap / Subscription / SubscriptionStatus / SubscriptionTopic / Substance / SubstanceDefinition / SubstanceNucleicAcid / SubstancePolymer / SubstanceProtein / SubstanceReferenceInformation / SubstanceSourceMaterial / SupplyDelivery / SupplyRequest / Task / TerminologyCapabilities / TestReport / TestScript / Transport / ValueSet / VerificationResult / VisionPrescription / Custom): |
| _content | | Search on the entire content of the resource | |
| _filter | | This is the formal declaration for the _filter parameter, documented at [http://hl7.org/fhir/search_filter.html](http://hl7.org/fhir/search_filter.html) | |
| _id | | Logical id of this artifact | |
| _in | | Allows for the retrieval of resources that are active members of a CareTeam, Group, or List | |
| _language | | Language of the resource content | |
| _lastUpdated (exact) | | When the resource version last changed | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| _list | | Allows for the retrieval of resources that are referenced by a List resource or by one of the pre-defined functional lists | |
| _profile | | Profiles this resource claims to conform to | |
| _query | | A custom search profile that describes a specific defined query operation | |
| _security | | Security Labels applied to this resource | |
| _source | | Identifies where the resource comes from | |
| _tag | | Tags applied to this resource | |
| _text | | Text search against the narrative | |
| _type | | A resource type filter | |
| guarantor | | The parties ultimately responsible for balancing the Account | |
| identifier | | Account number | |
| name | | Human-readable label | |
| owner | | Entity managing the Account | |
| patient | | The entity that caused the expenses | |
| period (exact) | | Transaction window | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| relatedaccount | | Parent and other related accounts | |
| status | | active | inactive | entered-in-error | on-hold | unknown | |
| subject | | The entity that caused the expenses | |
| type | | E.g. patient, expense, depreciation | |
| composed-of | | What resource is being referenced | |
| context | | A use context assigned to the activity definition | |
| context-quantity | | A quantity- or range-valued use context assigned to the activity definition | |
| context-type | | A type of use context assigned to the activity definition | |
| context-type-quantity | | A use context type and quantity- or range-based value assigned to the activity definition | |
| context-type-value | | A use context type and value assigned to the activity definition | |
| date (exact) | | The activity definition publication date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| depends-on | | What resource is being referenced | |
| derived-from | | What resource is being referenced | |
| description | | The description of the activity definition | |
| effective (exact) | | The time during which the activity definition is intended to be in use | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| jurisdiction | | Intended jurisdiction for the activity definition | |
| kind | | The kind of activity definition | |
| predecessor | | What resource is being referenced | |
| publisher | | Name of the publisher of the activity definition | |
| successor | | What resource is being referenced | |
| title | | The human-friendly name of the activity definition | |
| topic | | Topics associated with the module | |
| url | | The uri that identifies the activity definition | |
| version | | The business version of the activity definition | |
| device | | A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product. This is not intended for devices that are just co-packaged | |
| dose-form | | The administrable dose form, i.e. the dose form of the final product after necessary reconstitution or processing | |
| form-of | | The medicinal product that this is an administrable form of. This is not a reference to the item(s) that make up this administrable form - it is the whole product | |
| ingredient | | The ingredients of this administrable medicinal product | |
| manufactured-item | | The manufactured item(s) that this administrable product is produced from. Either a single item, or several that are mixed before administration (e.g. a power item and a solution item). Note that these are not raw ingredients | |
| route | | Coded expression for the route | |
| target-species | | Coded expression for the species | |
| actuality | | actual | potential | |
| category | | wrong-patient | procedure-mishap | medication-mishap | device | unsafe-physical-environment | hospital-aquired-infection | wrong-body-site | |
| code | | Event or incident that occurred or was averted | |
| location | | Location where adverse event occurred | |
| recorder | | Who recorded the adverse event | |
| resultingcondition | | Effect on the subject due to this event | |
| seriousness | | Seriousness or gravity of the event | |
| study | | Research study that the subject is enrolled in | |
| substance | | Refers to the specific entity that caused the adverse event | |
| clinical-status | | active | inactive | resolved | |
| criticality | | low | high | unable-to-assess | |
| last-date (exact) | | Date(/time) of last known occurrence of a reaction | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| manifestation-code | | Clinical symptoms/signs associated with the Event | |
| manifestation-reference | | Clinical symptoms/signs associated with the Event | |
| participant | | Who or what participated in the activities related to the allergy or intolerance | |
| severity | | mild | moderate | severe (of event as a whole) | |
| verification-status | | unconfirmed | presumed | confirmed | refuted | entered-in-error | |
| actor | | Any one of the individuals participating in the appointment | |
| appointment-type | | The style of appointment or patient that has been booked in the slot (not service type) | |
| based-on | | The service request this appointment is allocated to assess | |
| group | | One of the individuals of the appointment is this patient | |
| part-status | | The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests. | |
| practitioner | | One of the individuals of the appointment is this practitioner | |
| reason-code | | Reference to a concept (by class) | |
| reason-reference | | Reference to a resource (by instance) | |
| requested-period (exact) | | During what period was the Appointment requested to take place | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| service-category | | A broad categorization of the service that is to be performed during this appointment | |
| service-type | | The specific service (by coding) that is to be performed during this appointment | |
| service-type-reference | | The specific service (by HealthcareService) that is to be performed during this appointment | |
| slot | | The slots that this appointment is filling | |
| specialty | | The specialty of a practitioner that would be required to perform the service requested in this appointment | |
| supporting-info | | Additional information to support the appointment | |
| appointment | | The appointment that the response is attached to | |
| action | | Type of action performed during the event | |
| agent | | Identifier of who | |
| agent-role | | Agent role in the event | |
| encounter | | Encounter related to the activity recorded in the AuditEvent | |
| entity | | Specific instance of resource | |
| entity-role | | What role the entity played | |
| outcome | | Whether the event succeeded or failed | |
| policy | | Policy that authorized event | |
| purpose | | The authorization (purposeOfUse) of the event | |
| source | | The identity of source detecting the event | |
| author | | Who created | |
| created (exact) | | When created | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| biological-source-event | | The biological source for the biologically derived product | |
| collector | | Procedure request to obtain this biologically derived product. | |
| product-category | | Broad category of this product. | |
| product-code | | A code that identifies the kind of this biologically derived product (SNOMED CT code). | |
| product-status | | Whether the product is currently available. | |
| request | | Procedure request to obtain this biologically derived product. | |
| morphology | | Kind of Structure | |
| structure | | Body site excludedStructure structure | |
| composition | | The first resource in the bundle, if the bundle type is "document" - this is a composition, and this parameter provides access to search its contents | |
| message | | The first resource in the bundle, if the bundle type is "message" - this is a message header, and this parameter provides access to search its contents | |
| timestamp (exact) | | When the bundle was assembled | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| fhirversion | | The version of FHIR | |
| format | | formats supported (xml | json | ttl | mime type) | |
| guide | | Implementation guides supported | |
| mode | | Mode - restful (server/client) or messaging (sender/receiver) | |
| resource | | Name of a resource mentioned in a capability statement | |
| resource-profile | | A profile id invoked in a capability statement | |
| security-service | | OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates | |
| software | | Part of the name of a software application | |
| supported-profile | | Profiles for use cases supported | |
| activity-code | | Detail type of activity | |
| activity-reference | | Activity that is intended to be part of the care plan | |
| activity-scheduled-date (exact) | | Specified date occurs within period specified by CarePlan.activity.plannedActivityDetail.scheduled[x] | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| activity-scheduled-string | | When activity is to occur | |
| care-team | | Who's involved in plan? | |
| condition | | Reference to a resource (by instance) | |
| custodian | | Who is the designated responsible party | |
| goal | | Desired outcome of plan | |
| instantiates-canonical | | Instantiates FHIR protocol or definition | |
| instantiates-uri | | Instantiates external protocol or definition | |
| intent | | proposal | plan | order | option | directive | |
| part-of | | Part of referenced CarePlan | |
| performer | | Matches if the practitioner is listed as a performer in any of the "simple" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.) | |
| replaces | | CarePlan replaced by this CarePlan | |
| account | | Account to place this charge | |
| entered-date (exact) | | Date the charge item was entered | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| enterer | | Individual who was entering | |
| factor-override | | Factor overriding the associated rules | |
| occurrence (exact) | | When the charged service was applied | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| performer-actor | | Individual who was performing | |
| performer-function | | What type of performance was done | |
| performing-organization | | Organization providing the charged service | |
| price-override | | Price overriding the associated rules | |
| quantity | | Quantity of which the charge item has been serviced | |
| requesting-organization | | Organization requesting the charged service | |
| service | | Which rendered service is being charged? | |
| detail-udi | | UDI associated with a line item, detail product or service | |
| facility | | Facility where the products or services have been or will be provided | |
| insurer | | The target payor/insurer for the Claim | |
| item-udi | | UDI associated with a line item product or service | |
| payee | | The party receiving any payment for the Claim | |
| priority | | Processing priority requested | |
| procedure-udi | | UDI associated with a procedure | |
| provider | | Provider responsible for the Claim | |
| subdetail-udi | | UDI associated with a line item, detail, subdetail product or service | |
| use | | The kind of financial resource | |
| disposition | | The contents of the disposition message | |
| payment-date (exact) | | The expected payment date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| requestor | | The Provider of the claim | |
| finding-code | | Reference to a concept (by class) | |
| finding-ref | | Reference to a resource (by instance) | |
| previous | | Reference to last assessment | |
| problem | | Relevant impressions of patient state | |
| contraindication | | The situation that is being documented as contraindicating against this item, as a code | |
| contraindication-reference | | The situation that is being documented as contraindicating against this item, as a reference | |
| effect | | The situation in which the undesirable effect may manifest, as a code | |
| effect-reference | | The situation in which the undesirable effect may manifest, as a reference | |
| indication | | The situation that is being documented as an indicaton for this item, as a code | |
| indication-reference | | The situation that is being documented as an indicaton for this item, as a reference | |
| interaction | | The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction | |
| product | | The medicinal product for which this is a clinical usage issue | |
| content-mode | | not-present | example | fragment | complete | supplement | |
| end (exact) | | Optional Extensions Element | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| keyword | | Optional Extensions Element | |
| language | | A language in which a designation is provided | |
| supplements | | Find code system supplements for the referenced code system | |
| system | | The system for any codes defined by this code system (same as 'url') | |
| workflow | | Optional Extensions Element | |
| medium | | A channel of communication | |
| received (exact) | | When received | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| recipient | | Who the information is shared with | |
| sender | | Who shares the information | |
| sent (exact) | | When sent | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| authored (exact) | | When request transitioned to being actionable | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| group-identifier | | Composite request this is part of | |
| information-provider | | Who should share the information | |
| requester | | Who asks for the information to be shared | |
| attester | | Who attested the composition | |
| entry | | A reference to data that supports this section | |
| related | | Target of the relationship | |
| section | | Classification of section (recommended) | |
| section-code-text | | Search on the section narrative of the resource | |
| section-text | | Search on the section narrative of the resource | |
| dependson | | Other properties required for this mapping | |
| other-map | | canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped | |
| source-code | | Identifies elements being mapped | |
| source-group-system | | Source system where concepts to be mapped are defined | |
| source-scope | | The source value set that contains the concepts that are being mapped | |
| source-scope-uri | | The URI for the source value set that contains the concepts being mapped | |
| target-code | | Code that identifies the target element | |
| target-group-system | | Target system that the concepts are to be mapped to | |
| target-scope | | The target value set which provides context for the mappings | |
| target-scope-uri | | The URI for the target value set that contains the concepts being mapped. | |
| abatement-age | | Abatement as age or age range | |
| abatement-date (exact) | | Date-related abatements (dateTime and period) | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| abatement-string | | Abatement as a string | |
| body-site | | Anatomical location, if relevant | |
| evidence | | Manifestation/symptom | |
| evidence-detail | | Supporting information found elsewhere | |
| onset-age | | Onsets as age or age range | |
| onset-date (exact) | | Date related onsets (dateTime and Period) | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| onset-info | | Onsets as a string | |
| participant-actor | | Who or what participated in the activities related to the condition | |
| participant-function | | Type of involvement of the actor in the activities related to the condition | |
| recorded-date (exact) | | Date record was first recorded | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| stage | | Simple summary (disease specific) | |
| controller | | Consent Enforcer | |
| data | | The actual data reference | |
| grantee | | Who is agreeing to the policy and rules | |
| manager | | Consent workflow management | |
| security-label | | Security Labels that define affected resources | |
| source-reference | | Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse | |
| verified | | Has been verified | |
| verified-date (exact) | | When consent verified | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| authority | | The authority of the contract | |
| domain | | The domain of the contract | |
| instantiates | | A source definition of the contract | |
| issued (exact) | | The date/time the contract was issued | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| signer | | Contract Signatory Party | |
| beneficiary | | Covered party | |
| class-type | | Coverage class (eg. plan, group) | |
| class-value | | Value of the class (eg. Plan number, group number) | |
| dependent | | Dependent number | |
| paymentby-party | | Parties who will pay for services | |
| policy-holder | | Reference to the policyholder | |
| subscriber | | Reference to the subscriber | |
| subscriberid | | Identifier of the subscriber | |
| identified (exact) | | When identified | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| implicated | | Problem resource | |
| definition | | The definition / type of the device | |
| device-name | | A server defined search that may match any of the string fields in Device.deviceName or Device.type. | |
| din | | The donation identification number (DIN) | |
| expiration-date (exact) | | The expiration date of the device | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| lot-number | | The lot number of the device | |
| manufacture-date (exact) | | The manufacture date of the device | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| manufacturer | | The manufacturer of the device | |
| model | | The model of the device | |
| organization | | The organization responsible for the device | |
| parent | | The parent device | |
| serial-number | | The serial number of the device | |
| udi-carrier | | UDI Barcode (RFID or other technology) string in *HRF* format. | |
| udi-di | | The udi Device Identifier (DI) | |
| authored-on (exact) | | When the request transitioned to being actionable | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| event-date (exact) | | When service should occur | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| insurance | | Associated insurance coverage | |
| prior-request | | Request takes the place of referenced completed or terminated requests | |
| conclusion | | A coded conclusion (interpretation/impression) on the report | |
| media | | A reference to the image source. | |
| result | | Link to an atomic result (observation resource) | |
| results-interpreter | | Who was the source of the report | |
| specimen | | The specimen details | |
| item | | Items in manifest | |
| related-id | | Identifiers of things that are related | |
| related-ref | | Related Resource | |
| contenttype | | Mime type of the content, with charset etc. | |
| creation (exact) | | Date attachment was first created | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| doc-status | | preliminary | final | amended | entered-in-error | |
| event-code | | Main clinical acts documented | |
| event-reference | | Main clinical acts documented | |
| format-canonical | | Profile canonical content rules for the document | |
| format-code | | Format code content rules for the document | |
| format-uri | | Profile URI content rules for the document | |
| relatesto | | Target of the relationship | |
| relation | | replaces | transforms | signs | appends | |
| relationship | | Combination of relation and relatesTo | |
| setting | | Additional details about where the content was created (e.g. clinical specialty) | |
| careteam | | Careteam allocated to participate in the encounter | |
| class | | Classification of patient encounter | |
| date-start (exact) | | The actual start date of the Encounter | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| diagnosis | | The diagnosis or procedure relevant to the encounter | |
| end-date (exact) | | The actual end date of the Encounter | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| episode-of-care | | Episode(s) of care that this encounter should be recorded against | |
| length | | Length of encounter in days | |
| location-period (exact) | | Time period during which the patient was present at the location | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| participant-type | | Role of participant in encounter | |
| service-provider | | The organization (facility) responsible for this encounter | |
| special-arrangement | | Wheelchair, translator, stretcher, etc. | |
| subject-status | | The current status of the subject in relation to the Encounter | |
| connection-type | | Protocol/Profile/Standard to be used with this endpoint connection | |
| payload-type | | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) | |
| care-manager | | Care manager/care coordinator for the patient | |
| condition-concept | | Conditions/problems/diagnoses this episode of care is for (coded) | |
| condition-reference | | Conditions/problems/diagnoses this episode of care is for (resource reference) | |
| incoming-referral | | Incoming Referral Request | |
| claim | | The reference to the claim | |
| coverage | | The plan under which the claim was adjudicated | |
| sex | | A search by a sex code of a family member | |
| analysis-patient | | Who the analysis is about | |
| analysis-subject | | Who the analysis is about | |
| achievement-status | | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable | |
| addresses | | Issues addressed by this goal | |
| lifecycle-status | | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected | |
| start-date (exact) | | When goal pursuit begins | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| target-date (exact) | | Reach goal on or before | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| start | | Type of resource at which the graph starts | |
| characteristic | | Kind of characteristic | |
| characteristic-reference | | An entity referenced in a characteristic | |
| characteristic-value | | A composite of both characteristic and value | |
| exclude | | Group includes or excludes | |
| managing-entity | | Entity that is the custodian of the Group's definition | |
| member | | Reference to the group member | |
| membership | | Definitional or enumerated group | |
| value | | Value held by characteristic | |
| active | | The Healthcare Service is currently marked as active | |
| coverage-area | | Location(s) service is intended for/available to | |
| endpoint | | Technical endpoints providing access to electronic services operated for the healthcare service | |
| offered-in | | The service within which this service is offered | |
| program | | One of the Programs supported by this HealthcareService | |
| study-uid | | The DICOM Study Instance UID from which the images were selected | |
| basedon | | The order for the image, such as Accession Number associated with a ServiceRequest | |
| bodysite | | The body site studied | |
| dicom-class | | The type of the instance | |
| instance | | SOP Instance UID for an instance | |
| interpreter | | Who interpreted the images | |
| modality | | The modality of the series | |
| reason | | The reason for the study | |
| referrer | | The referring physician | |
| series | | DICOM Series Instance UID for a series | |
| started (exact) | | When the study was started | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| reaction | | Additional information on reaction | |
| reaction-date (exact) | | When reaction started | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| status-reason | | Reason why the vaccine was not administered | |
| target-disease | | The target disease the dose is being administered against | |
| vaccine-code | | Vaccine Product Administered | |
| dose-status | | The status of the dose relative to published recommendations | |
| immunization-event | | The vaccine administration event being evaluated | |
| information | | Patient observations supporting recommendation | |
| support | | Past immunizations supporting recommendation | |
| vaccine-type | | Vaccine or vaccine group recommendation applies to | |
| experimental | | For testing purposes, not real usage | |
| global | | Profile that all resources must conform to | |
| for | | The product which this ingredient is a constituent part of | |
| function | | A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent | |
| role | | A classification of the ingredient identifying its purpose within the product, e.g. active, inactive | |
| substance-code | | Reference to a concept (by class) | |
| substance-definition | | Reference to a resource (by instance) | |
| address | | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text | |
| address-city | | A city specified in an address | |
| address-country | | A country specified in an address | |
| address-postalcode | | A postal code specified in an address | |
| address-state | | A state specified in an address | |
| address-use | | A use code specified in an address | |
| administered-by | | Product administrator | |
| owned-by | | An organization of which this organization forms a part | |
| phonetic | | A portion of the organization's name using some kind of phonetic matching algorithm | |
| issuer | | Issuing Organization of Invoice | |
| participant-role | | Type of involvement in creation of this Invoice | |
| totalgross | | Gross total of this Invoice | |
| totalnet | | Net total of this Invoice | |
| content-type | | The type of content in the library (e.g. text/cql) | |
| empty-reason | | Why list is empty | |
| notes | | The annotation - text content (as markdown) | |
| contains | | Select locations that contain the specified co-ordinates | |
| near | | Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes). Servers which support the near parameter SHALL support the unit string 'km' for kilometers and SHOULD support '[mi_us]' for miles, support for other units is optional. If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant). If the server is unable to understand the units (and does support the near search parameter), it MIGHT return an OperationOutcome and fail the search with a http status 400 BadRequest. If the server does not support the near parameter, the parameter MIGHT report the unused parameter in a bundled OperationOutcome and still perform the search ignoring the near parameter. Note: The algorithm to determine the distance is not defined by the specification, and systems might have different engines that calculate things differently. They could consider geographic point to point, or path via road, or including current traffic conditions, or just simple neighboring postcodes/localities if that's all it had access to. | |
| operational-status | | Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping) | |
| partof | | A location of which this location is a part | |
| evaluated-resource | | An evaluated resource referenced by the measure report | |
| measure | | The measure to return measure report results for | |
| reporter | | The reporter to return measure report results for | |
| form | | Returns medications for a specific dose form | |
| ingredient-code | | Returns medications for this ingredient code | |
| marketingauthorizationholder | | Returns medications made or sold for this marketing authorization holder | |
| medication | | ): Return administrations of this medication reference | |
| reason-given | | Reference to a resource (by instance) | |
| reason-given-code | | Reasons for administering the medication | |
| reason-not-given | | Reasons for not administering the medication | |
| destination | | Returns dispenses that should be sent to a specific destination | |
| prescription | | ): The identity of a prescription to list dispenses from | |
| receiver | | The identity of a receiver to list dispenses for | |
| recorded (exact) | | Returns dispenses where dispensing activity began on this date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| responsibleparty | | Returns dispenses with the specified responsible party | |
| whenhandedover (exact) | | Returns dispenses handed over on this date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| whenprepared (exact) | | Returns dispenses prepared on this date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| classification | | Specific category assigned to the medication | |
| classification-type | | The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification) | |
| doseform | | powder | tablets | capsule + | |
| monitoring-program-name | | Name of the reviewing program | |
| monitoring-program-type | | Type of program under which the medication is monitored | |
| monograph | | Associated documentation about the medication | |
| monograph-type | | The category of medication document | |
| packaging-cost | | The cost of the packaged medication, if the cost is Money | |
| packaging-cost-concept | | The cost of the packaged medication, if the cost is a CodeableConcept | |
| product-type | | Category of the medication or product | |
| source-cost | | The source or owner for the price information | |
| authoredon (exact) | | Return prescriptions written on this date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| combo-date (exact) | | Returns medication request to be administered on a specific date or within a date range | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| intended-dispenser | | Returns prescriptions intended to be dispensed by this Organization | |
| intended-performer | | Returns the intended performer of the administration of the medication request | |
| intended-performertype | | Returns requests for a specific type of performer | |
| adherence | | Returns statements based on adherence or compliance | |
| characteristic-type | | A category for the characteristic | |
| contact | | A product specific contact, person (in a role), or an organization | |
| master-file | | A master file for to the medicinal product (e.g. Pharmacovigilance System Master File) | |
| name-language | | Language code for this name | |
| product-classification | | Allows the product to be classified by various systems | |
| event | | The event that triggers the message or link to the event definition. | |
| focus | | A resource that is a permitted focus of the message | |
| destination-uri | | Actual destination address or id | |
| response-id | | Id of original message | |
| responsible | | Final responsibility for event | |
| source-uri | | Actual message source address or id | |
| target | | Particular delivery destination within the destination | |
| id-type | | oid | uuid | uri | other | |
| telecom | | Contact details for individual or organization | |
| nutrition | | Return intakes for a specific consumed item | |
| additive | | Type of module component to add to the feeding | |
| datetime (exact) | | Return nutrition orders requested on this date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| formula | | Type of enteral or infant formula | |
| oraldiet | | Type of diet that can be consumed orally (i.e., take via the mouth). | |
| supplement | | Type of supplement product requested | |
| code-value-concept | | Code and coded value parameter pair | |
| code-value-date | | Code and date/time value parameter pair | |
| code-value-quantity | | Code and quantity value parameter pair | |
| code-value-string | | Code and string value parameter pair | |
| combo-code | | The code of the observation type or component type | |
| combo-code-value-concept | | Code and coded value parameter pair, including in components | |
| combo-code-value-quantity | | Code and quantity value parameter pair, including in components | |
| combo-data-absent-reason | | The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing. | |
| combo-value-concept | | The value or component value of the observation, if the value is a CodeableConcept | |
| combo-value-quantity | | The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) | |
| component-code | | The component code of the observation type | |
| component-code-value-concept | | Component code and component coded value parameter pair | |
| component-code-value-quantity | | Component code and component quantity value parameter pair | |
| component-data-absent-reason | | The reason why the expected value in the element Observation.component.value[x] is missing. | |
| component-value-concept | | The value of the component observation, if the value is a CodeableConcept | |
| component-value-quantity | | The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) | |
| data-absent-reason | | The reason why the expected value in the element Observation.value[x] is missing. | |
| has-member | | Related resource that belongs to the Observation group | |
| method | | The method used for the observation | |
| value-concept | | The value of the observation, if the value is a CodeableConcept | |
| value-date (exact) | | The value of the observation, if the value is a date or period of time | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| value-quantity | | The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) | |
| value-string | | The value of the observation, if the value is a string, and also searches in CodeableConcept.text | |
| base | | Marks this as a profile of the base | |
| input-profile | | Validation information for in parameters | |
| output-profile | | Validation information for out parameters | |
| email | | A value in an email contact | |
| network | | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) | |
| participating-organization | | The organization that provides services to the primary organization | |
| phone | | A value in a phone contact | |
| primary-organization | | The organization that receives the services from the participating organization | |
| biological | | A biologically derived product within this packaged product | |
| contained-item | | Any of the contained items within this packaged product | |
| package | | A complete packaged product within this packaged product | |
| package-for | | The product that this is a pack for | |
| age | | Searches for patients based on age as calculated based on current date and date of birth. Deceased patients are excluded from the search. | |
| birthOrderBoolean | | Search based on whether a patient was part of a multiple birth or not. | |
| birthdate (exact) | | ): The patient's date of birth | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| death-date (exact) | | The date of death has been provided and satisfies this search value | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| deceased | | This patient has been marked as deceased, or has a death date entered | |
| family | | ): A portion of the family name of the patient | |
| gender | | ): Gender of the patient | |
| general-practitioner | | Patient's nominated general practitioner, not the organization that manages the record | |
| given | | ): A portion of the given name of the patient | |
| link | | All patients/related persons linked to the given patient | |
| mothersMaidenName | | Search based on patient's mother's maiden name | |
| payment-status | | The type of payment notice | |
| response | | The ClaimResponse | |
| allocation-account | | The account to which payment or adjustment was applied. | |
| allocation-encounter | | The encounter to which payment or adjustment was applied. | |
| payment-issuer | | The organization which generated this resource | |
| relatedperson | | The Person links to this RelatedPerson | |
| communication | | One of the languages that the practitioner can communicate with | |
| qualification-period (exact) | | The date(s) a qualification is valid for | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| report | | Any report resulting from the procedure | |
| activity | | Activity that occurred | |
| agent-type | | How the agent participated | |
| signature-type | | Indication of the reason the entity signed the object(s) | |
| when (exact) | | When the activity occurred | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| item-code | | A code that corresponds to one of the items in the questionnaire | |
| questionnaire-code | | A code that matches one of the Questionnaire.code codings | |
| subject-type | | Resource that can be subject of QuestionnaireResponse | |
| item-subject | | Allows searching for QuestionnaireResponses by item value where the item has isSubject=true | |
| questionnaire | | The questionnaire the answers are provided for | |
| case | | The case or procedure number | |
| case-type | | The defining type of case | |
| holder | | The organization that holds the granted authorization | |
| region | | The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted | |
| protocol | | Steps followed in executing study | |
| recruitment_actual | | Actual number of participants enrolled in study across all groups | |
| recruitment_target | | Target number of participants enrolled in study across all groups | |
| site | | Facility where study activities are conducted | |
| subject_state | | candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn | |
| probability | | Likelihood of specified outcome | |
| risk | | Likelihood of specified outcome as a qualitative value | |
| component | | Defines how the part works | |
| body-structure | | Body structure Where procedure is going to be done | |
| code-concept | | What is being requested/ordered | |
| code-reference | | What is being requested/ordered | |
| performer-type | | Performer role | |
| requisition | | Composite Request ID | |
| schedule | | The Schedule Resource that we are seeking a slot within | |
| accession | | The accession number associated with the specimen | |
| collected (exact) | | The date the specimen was collected | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| container-device | | The unique identifier associated with the specimen container | |
| procedure | | The procedure that collected the specimen | |
| container | | The type of specimen conditioned in container expected by the lab | |
| is-derived | | Primary specimen (false) or derived specimen (true) | |
| type-tested | | The type of specimen conditioned for testing | |
| abstract | | Whether the structure is abstract | |
| base-path | | Path that identifies the base element | |
| derivation | | specialization | constraint - How relates to base definition | |
| ext-context | | An extension context assigned to the structure definition | |
| ext-context-expression | | An expression of extension context assigned to the structure definition | |
| ext-context-type | | A type of extension context assigned to the structure definition | |
| path | | A path that is constrained in the StructureDefinition | |
| valueset | | A vocabulary binding reference | |
| payload | | The mime-type of the notification payload | |
| derived-or-self | | A server defined search that matches either the url or derivedFrom | |
| trigger-description | | Text representation of the trigger | |
| expiry (exact) | | Expiry date of package or container of substance | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| substance-reference | | A component of the substance | |
| supplier | | Dispenser | |
| business-status | | Search by business status | |
| modified (exact) | | Search by last modification date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| output | | Search by task output | |
| tester | | The name of the testing organization | |
| testscript | | The test script executed to produce this report | |
| scope-artifact | | The artifact under test | |
| scope-artifact-conformance | | The artifact under test and conformance testing expectation | |
| scope-artifact-phase | | The artifact under test and phase of testing | |
| testscript-capability | | TestScript required and validated capability | |
| expansion | | Identifies the value set expansion (business identifier) | |
| reference | | A code system included or excluded in the value set or an imported value set | |
| datewritten (exact) | | Return prescriptions written on this date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| prescriber | | Who authorized the vision prescription | |
| familymemberhistorycondition | | Search for a history of a particular condition within a patient's family | |
| location (Location): |
| _content | | Search on the entire content of the resource | |
| _filter | | This is the formal declaration for the _filter parameter, documented at [http://hl7.org/fhir/search_filter.html](http://hl7.org/fhir/search_filter.html) | |
| _id | | Logical id of this artifact | |
| _in | | Allows for the retrieval of resources that are active members of a CareTeam, Group, or List | |
| _language | | Language of the resource content | |
| _lastUpdated (exact) | | When the resource version last changed | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| _list | | Allows for the retrieval of resources that are referenced by a List resource or by one of the pre-defined functional lists | |
| _profile | | Profiles this resource claims to conform to | |
| _query | | A custom search profile that describes a specific defined query operation | |
| _security | | Security Labels applied to this resource | |
| _source | | Identifies where the resource comes from | |
| _tag | | Tags applied to this resource | |
| _text | | Text search against the narrative | |
| _type | | A resource type filter | |
| address | | A (part of the) address of the location | |
| address-city | | A city specified in an address | |
| address-country | | A country specified in an address | |
| address-postalcode | | A postal code specified in an address | |
| address-state | | A state specified in an address | |
| address-use | | A use code specified in an address | |
| characteristic | | One of the Location's characteristics | |
| contains | | Select locations that contain the specified co-ordinates | |
| endpoint | | Technical endpoints providing access to services operated for the location | |
| identifier | | An identifier for the location | |
| name | | A portion of the location's name or alias | |
| near | | Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes). Servers which support the near parameter SHALL support the unit string 'km' for kilometers and SHOULD support '[mi_us]' for miles, support for other units is optional. If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant). If the server is unable to understand the units (and does support the near search parameter), it MIGHT return an OperationOutcome and fail the search with a http status 400 BadRequest. If the server does not support the near parameter, the parameter MIGHT report the unused parameter in a bundled OperationOutcome and still perform the search ignoring the near parameter. Note: The algorithm to determine the distance is not defined by the specification, and systems might have different engines that calculate things differently. They could consider geographic point to point, or path via road, or including current traffic conditions, or just simple neighboring postcodes/localities if that's all it had access to. | |
| operational-status | | Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping) | |
| organization | | Searches for locations that are managed by the provided organization | |
| partof | | A location of which this location is a part | |
| status | | Searches for locations with a specific kind of status | |
| type | | A code for the type of location | |
| patient (Patient): |
| _content | | Search on the entire content of the resource | |
| _filter | | This is the formal declaration for the _filter parameter, documented at [http://hl7.org/fhir/search_filter.html](http://hl7.org/fhir/search_filter.html) | |
| _id | | Logical id of this artifact | |
| _in | | Allows for the retrieval of resources that are active members of a CareTeam, Group, or List | |
| _language | | Language of the resource content | |
| _lastUpdated (exact) | | When the resource version last changed | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| _list | | Allows for the retrieval of resources that are referenced by a List resource or by one of the pre-defined functional lists | |
| _profile | | Profiles this resource claims to conform to | |
| _query | | A custom search profile that describes a specific defined query operation | |
| _security | | Security Labels applied to this resource | |
| _source | | Identifies where the resource comes from | |
| _tag | | Tags applied to this resource | |
| _text | | Text search against the narrative | |
| _type | | A resource type filter | |
| active | | Whether the patient record is active | |
| address | | ): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text | |
| address-city | | ): A city specified in an address | |
| address-country | | ): A country specified in an address | |
| address-postalcode | | ): A postalCode specified in an address | |
| address-state | | ): A state specified in an address | |
| address-use | | ): A use code specified in an address | |
| age | | Searches for patients based on age as calculated based on current date and date of birth. Deceased patients are excluded from the search. | |
| birthOrderBoolean | | Search based on whether a patient was part of a multiple birth or not. | |
| birthdate (exact) | | ): The patient's date of birth | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| death-date (exact) | | The date of death has been provided and satisfies this search value | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| deceased | | This patient has been marked as deceased, or has a death date entered | |
| email | | ): A value in an email contact | |
| family | | ): A portion of the family name of the patient | |
| gender | | ): Gender of the patient | |
| general-practitioner | | Patient's nominated general practitioner, not the organization that manages the record | |
| given | | ): A portion of the given name of the patient | |
| identifier | | A patient identifier | |
| language | | Language code (irrespective of use value) | |
| link | | All patients/related persons linked to the given patient | |
| mothersMaidenName | | Search based on patient's mother's maiden name | |
| name | | A server defined search that may match any of the string fields in the HumanName, including family, given, prefix, suffix, and/or text | |
| organization | | The organization that is the custodian of the patient record | |
| phone | | ): A value in a phone contact | |
| phonetic | | ): A portion of either family or given name using some kind of phonetic matching algorithm | |
| telecom | | ): The value in any kind of telecom details of the patient | |
| target (--None-- / Account / ActivityDefinition / ActorDefinition / AdministrableProductDefinition / AdverseEvent / AllergyIntolerance / Appointment / AppointmentResponse / ArtifactAssessment / AuditEvent / Basic / Binary / BiologicallyDerivedProduct / BodyStructure / Bundle / CapabilityStatement / CarePlan / CareTeam / ChargeItem / ChargeItemDefinition / Citation / Claim / ClaimResponse / ClinicalImpression / ClinicalUseDefinition / CodeSystem / Communication / CommunicationRequest / CompartmentDefinition / Composition / ConceptMap / Condition / ConditionDefinition / Consent / Contract / Coverage / CoverageEligibilityRequest / CoverageEligibilityResponse / DetectedIssue / Device / DeviceDefinition / DeviceDispense / DeviceMetric / DeviceRequest / DeviceUsage / DiagnosticReport / DocumentManifest / DocumentReference / Encounter / Endpoint / EnrollmentRequest / EnrollmentResponse / EpisodeOfCare / EventDefinition / Evidence / EvidenceReport / EvidenceVariable / ExampleScenario / ExplanationOfBenefit / FamilyMemberHistory / Flag / FormularyItem / GenomicStudy / Goal / GraphDefinition / Group / GuidanceResponse / HealthcareService / ImagingSelection / ImagingStudy / Immunization / ImmunizationEvaluation / ImmunizationRecommendation / ImplementationGuide / Ingredient / InsurancePlan / InventoryReport / Invoice / Library / Linkage / List / Location / ManufacturedItemDefinition / Measure / MeasureReport / Medication / MedicationAdministration / MedicationDispense / MedicationKnowledge / MedicationRequest / MedicationUsage / MedicinalProductDefinition / MessageDefinition / MessageHeader / MolecularSequence / NamingSystem / NutritionIntake / NutritionOrder / NutritionProduct / Observation / ObservationDefinition / OperationDefinition / OperationOutcome / Organization / OrganizationAffiliation / PackagedProductDefinition / Parameters / Patient / PaymentNotice / PaymentReconciliation / Permission / Person / PlanDefinition / Practitioner / PractitionerRole / Procedure / Provenance / Questionnaire / QuestionnaireResponse / RegulatedAuthorization / RelatedPerson / RequestGroup / RequestOrchestration / Requirements / ResearchStudy / ResearchSubject / RiskAssessment / Schedule / SearchParameter / ServiceRequest / Slot / Specimen / SpecimenDefinition / StructureDefinition / StructureMap / Subscription / SubscriptionStatus / SubscriptionTopic / Substance / SubstanceDefinition / SubstanceNucleicAcid / SubstancePolymer / SubstanceProtein / SubstanceReferenceInformation / SubstanceSourceMaterial / SupplyDelivery / SupplyRequest / Task / TerminologyCapabilities / TestReport / TestScript / Transport / ValueSet / VerificationResult / VisionPrescription / Custom): |
| _content | | Search on the entire content of the resource | |
| _filter | | This is the formal declaration for the _filter parameter, documented at [http://hl7.org/fhir/search_filter.html](http://hl7.org/fhir/search_filter.html) | |
| _id | | Logical id of this artifact | |
| _in | | Allows for the retrieval of resources that are active members of a CareTeam, Group, or List | |
| _language | | Language of the resource content | |
| _lastUpdated (exact) | | When the resource version last changed | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| _list | | Allows for the retrieval of resources that are referenced by a List resource or by one of the pre-defined functional lists | |
| _profile | | Profiles this resource claims to conform to | |
| _query | | A custom search profile that describes a specific defined query operation | |
| _security | | Security Labels applied to this resource | |
| _source | | Identifies where the resource comes from | |
| _tag | | Tags applied to this resource | |
| _text | | Text search against the narrative | |
| _type | | A resource type filter | |
| guarantor | | The parties ultimately responsible for balancing the Account | |
| identifier | | Account number | |
| name | | Human-readable label | |
| owner | | Entity managing the Account | |
| patient | | The entity that caused the expenses | |
| period (exact) | | Transaction window | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| relatedaccount | | Parent and other related accounts | |
| status | | active | inactive | entered-in-error | on-hold | unknown | |
| subject | | The entity that caused the expenses | |
| type | | E.g. patient, expense, depreciation | |
| composed-of | | What resource is being referenced | |
| context | | A use context assigned to the activity definition | |
| context-quantity | | A quantity- or range-valued use context assigned to the activity definition | |
| context-type | | A type of use context assigned to the activity definition | |
| context-type-quantity | | A use context type and quantity- or range-based value assigned to the activity definition | |
| context-type-value | | A use context type and value assigned to the activity definition | |
| date (exact) | | The activity definition publication date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| depends-on | | What resource is being referenced | |
| derived-from | | What resource is being referenced | |
| description | | The description of the activity definition | |
| effective (exact) | | The time during which the activity definition is intended to be in use | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| jurisdiction | | Intended jurisdiction for the activity definition | |
| kind | | The kind of activity definition | |
| predecessor | | What resource is being referenced | |
| publisher | | Name of the publisher of the activity definition | |
| successor | | What resource is being referenced | |
| title | | The human-friendly name of the activity definition | |
| topic | | Topics associated with the module | |
| url | | The uri that identifies the activity definition | |
| version | | The business version of the activity definition | |
| device | | A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product. This is not intended for devices that are just co-packaged | |
| dose-form | | The administrable dose form, i.e. the dose form of the final product after necessary reconstitution or processing | |
| form-of | | The medicinal product that this is an administrable form of. This is not a reference to the item(s) that make up this administrable form - it is the whole product | |
| ingredient | | The ingredients of this administrable medicinal product | |
| manufactured-item | | The manufactured item(s) that this administrable product is produced from. Either a single item, or several that are mixed before administration (e.g. a power item and a solution item). Note that these are not raw ingredients | |
| route | | Coded expression for the route | |
| target-species | | Coded expression for the species | |
| actuality | | actual | potential | |
| category | | wrong-patient | procedure-mishap | medication-mishap | device | unsafe-physical-environment | hospital-aquired-infection | wrong-body-site | |
| code | | Event or incident that occurred or was averted | |
| location | | Location where adverse event occurred | |
| recorder | | Who recorded the adverse event | |
| resultingcondition | | Effect on the subject due to this event | |
| seriousness | | Seriousness or gravity of the event | |
| study | | Research study that the subject is enrolled in | |
| substance | | Refers to the specific entity that caused the adverse event | |
| clinical-status | | active | inactive | resolved | |
| criticality | | low | high | unable-to-assess | |
| last-date (exact) | | Date(/time) of last known occurrence of a reaction | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| manifestation-code | | Clinical symptoms/signs associated with the Event | |
| manifestation-reference | | Clinical symptoms/signs associated with the Event | |
| participant | | Who or what participated in the activities related to the allergy or intolerance | |
| severity | | mild | moderate | severe (of event as a whole) | |
| verification-status | | unconfirmed | presumed | confirmed | refuted | entered-in-error | |
| actor | | Any one of the individuals participating in the appointment | |
| appointment-type | | The style of appointment or patient that has been booked in the slot (not service type) | |
| based-on | | The service request this appointment is allocated to assess | |
| group | | One of the individuals of the appointment is this patient | |
| part-status | | The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests. | |
| practitioner | | One of the individuals of the appointment is this practitioner | |
| reason-code | | Reference to a concept (by class) | |
| reason-reference | | Reference to a resource (by instance) | |
| requested-period (exact) | | During what period was the Appointment requested to take place | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| service-category | | A broad categorization of the service that is to be performed during this appointment | |
| service-type | | The specific service (by coding) that is to be performed during this appointment | |
| service-type-reference | | The specific service (by HealthcareService) that is to be performed during this appointment | |
| slot | | The slots that this appointment is filling | |
| specialty | | The specialty of a practitioner that would be required to perform the service requested in this appointment | |
| supporting-info | | Additional information to support the appointment | |
| appointment | | The appointment that the response is attached to | |
| action | | Type of action performed during the event | |
| agent | | Identifier of who | |
| agent-role | | Agent role in the event | |
| encounter | | Encounter related to the activity recorded in the AuditEvent | |
| entity | | Specific instance of resource | |
| entity-role | | What role the entity played | |
| outcome | | Whether the event succeeded or failed | |
| policy | | Policy that authorized event | |
| purpose | | The authorization (purposeOfUse) of the event | |
| source | | The identity of source detecting the event | |
| author | | Who created | |
| created (exact) | | When created | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| biological-source-event | | The biological source for the biologically derived product | |
| collector | | Procedure request to obtain this biologically derived product. | |
| product-category | | Broad category of this product. | |
| product-code | | A code that identifies the kind of this biologically derived product (SNOMED CT code). | |
| product-status | | Whether the product is currently available. | |
| request | | Procedure request to obtain this biologically derived product. | |
| morphology | | Kind of Structure | |
| structure | | Body site excludedStructure structure | |
| composition | | The first resource in the bundle, if the bundle type is "document" - this is a composition, and this parameter provides access to search its contents | |
| message | | The first resource in the bundle, if the bundle type is "message" - this is a message header, and this parameter provides access to search its contents | |
| timestamp (exact) | | When the bundle was assembled | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| fhirversion | | The version of FHIR | |
| format | | formats supported (xml | json | ttl | mime type) | |
| guide | | Implementation guides supported | |
| mode | | Mode - restful (server/client) or messaging (sender/receiver) | |
| resource | | Name of a resource mentioned in a capability statement | |
| resource-profile | | A profile id invoked in a capability statement | |
| security-service | | OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates | |
| software | | Part of the name of a software application | |
| supported-profile | | Profiles for use cases supported | |
| activity-code | | Detail type of activity | |
| activity-reference | | Activity that is intended to be part of the care plan | |
| activity-scheduled-date (exact) | | Specified date occurs within period specified by CarePlan.activity.plannedActivityDetail.scheduled[x] | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| activity-scheduled-string | | When activity is to occur | |
| care-team | | Who's involved in plan? | |
| condition | | Reference to a resource (by instance) | |
| custodian | | Who is the designated responsible party | |
| goal | | Desired outcome of plan | |
| instantiates-canonical | | Instantiates FHIR protocol or definition | |
| instantiates-uri | | Instantiates external protocol or definition | |
| intent | | proposal | plan | order | option | directive | |
| part-of | | Part of referenced CarePlan | |
| performer | | Matches if the practitioner is listed as a performer in any of the "simple" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.) | |
| replaces | | CarePlan replaced by this CarePlan | |
| account | | Account to place this charge | |
| entered-date (exact) | | Date the charge item was entered | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| enterer | | Individual who was entering | |
| factor-override | | Factor overriding the associated rules | |
| occurrence (exact) | | When the charged service was applied | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| performer-actor | | Individual who was performing | |
| performer-function | | What type of performance was done | |
| performing-organization | | Organization providing the charged service | |
| price-override | | Price overriding the associated rules | |
| quantity | | Quantity of which the charge item has been serviced | |
| requesting-organization | | Organization requesting the charged service | |
| service | | Which rendered service is being charged? | |
| detail-udi | | UDI associated with a line item, detail product or service | |
| facility | | Facility where the products or services have been or will be provided | |
| insurer | | The target payor/insurer for the Claim | |
| item-udi | | UDI associated with a line item product or service | |
| payee | | The party receiving any payment for the Claim | |
| priority | | Processing priority requested | |
| procedure-udi | | UDI associated with a procedure | |
| provider | | Provider responsible for the Claim | |
| subdetail-udi | | UDI associated with a line item, detail, subdetail product or service | |
| use | | The kind of financial resource | |
| disposition | | The contents of the disposition message | |
| payment-date (exact) | | The expected payment date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| requestor | | The Provider of the claim | |
| finding-code | | Reference to a concept (by class) | |
| finding-ref | | Reference to a resource (by instance) | |
| previous | | Reference to last assessment | |
| problem | | Relevant impressions of patient state | |
| contraindication | | The situation that is being documented as contraindicating against this item, as a code | |
| contraindication-reference | | The situation that is being documented as contraindicating against this item, as a reference | |
| effect | | The situation in which the undesirable effect may manifest, as a code | |
| effect-reference | | The situation in which the undesirable effect may manifest, as a reference | |
| indication | | The situation that is being documented as an indicaton for this item, as a code | |
| indication-reference | | The situation that is being documented as an indicaton for this item, as a reference | |
| interaction | | The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction | |
| product | | The medicinal product for which this is a clinical usage issue | |
| content-mode | | not-present | example | fragment | complete | supplement | |
| end (exact) | | Optional Extensions Element | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| keyword | | Optional Extensions Element | |
| language | | A language in which a designation is provided | |
| supplements | | Find code system supplements for the referenced code system | |
| system | | The system for any codes defined by this code system (same as 'url') | |
| workflow | | Optional Extensions Element | |
| medium | | A channel of communication | |
| received (exact) | | When received | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| recipient | | Who the information is shared with | |
| sender | | Who shares the information | |
| sent (exact) | | When sent | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| authored (exact) | | When request transitioned to being actionable | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| group-identifier | | Composite request this is part of | |
| information-provider | | Who should share the information | |
| requester | | Who asks for the information to be shared | |
| attester | | Who attested the composition | |
| entry | | A reference to data that supports this section | |
| related | | Target of the relationship | |
| section | | Classification of section (recommended) | |
| section-code-text | | Search on the section narrative of the resource | |
| section-text | | Search on the section narrative of the resource | |
| dependson | | Other properties required for this mapping | |
| other-map | | canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped | |
| source-code | | Identifies elements being mapped | |
| source-group-system | | Source system where concepts to be mapped are defined | |
| source-scope | | The source value set that contains the concepts that are being mapped | |
| source-scope-uri | | The URI for the source value set that contains the concepts being mapped | |
| target-code | | Code that identifies the target element | |
| target-group-system | | Target system that the concepts are to be mapped to | |
| target-scope | | The target value set which provides context for the mappings | |
| target-scope-uri | | The URI for the target value set that contains the concepts being mapped. | |
| abatement-age | | Abatement as age or age range | |
| abatement-date (exact) | | Date-related abatements (dateTime and period) | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| abatement-string | | Abatement as a string | |
| body-site | | Anatomical location, if relevant | |
| evidence | | Manifestation/symptom | |
| evidence-detail | | Supporting information found elsewhere | |
| onset-age | | Onsets as age or age range | |
| onset-date (exact) | | Date related onsets (dateTime and Period) | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| onset-info | | Onsets as a string | |
| participant-actor | | Who or what participated in the activities related to the condition | |
| participant-function | | Type of involvement of the actor in the activities related to the condition | |
| recorded-date (exact) | | Date record was first recorded | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| stage | | Simple summary (disease specific) | |
| controller | | Consent Enforcer | |
| data | | The actual data reference | |
| grantee | | Who is agreeing to the policy and rules | |
| manager | | Consent workflow management | |
| security-label | | Security Labels that define affected resources | |
| source-reference | | Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse | |
| verified | | Has been verified | |
| verified-date (exact) | | When consent verified | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| authority | | The authority of the contract | |
| domain | | The domain of the contract | |
| instantiates | | A source definition of the contract | |
| issued (exact) | | The date/time the contract was issued | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| signer | | Contract Signatory Party | |
| beneficiary | | Covered party | |
| class-type | | Coverage class (eg. plan, group) | |
| class-value | | Value of the class (eg. Plan number, group number) | |
| dependent | | Dependent number | |
| paymentby-party | | Parties who will pay for services | |
| policy-holder | | Reference to the policyholder | |
| subscriber | | Reference to the subscriber | |
| subscriberid | | Identifier of the subscriber | |
| identified (exact) | | When identified | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| implicated | | Problem resource | |
| definition | | The definition / type of the device | |
| device-name | | A server defined search that may match any of the string fields in Device.deviceName or Device.type. | |
| din | | The donation identification number (DIN) | |
| expiration-date (exact) | | The expiration date of the device | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| lot-number | | The lot number of the device | |
| manufacture-date (exact) | | The manufacture date of the device | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| manufacturer | | The manufacturer of the device | |
| model | | The model of the device | |
| organization | | The organization responsible for the device | |
| parent | | The parent device | |
| serial-number | | The serial number of the device | |
| udi-carrier | | UDI Barcode (RFID or other technology) string in *HRF* format. | |
| udi-di | | The udi Device Identifier (DI) | |
| authored-on (exact) | | When the request transitioned to being actionable | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| event-date (exact) | | When service should occur | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| insurance | | Associated insurance coverage | |
| prior-request | | Request takes the place of referenced completed or terminated requests | |
| conclusion | | A coded conclusion (interpretation/impression) on the report | |
| media | | A reference to the image source. | |
| result | | Link to an atomic result (observation resource) | |
| results-interpreter | | Who was the source of the report | |
| specimen | | The specimen details | |
| item | | Items in manifest | |
| related-id | | Identifiers of things that are related | |
| related-ref | | Related Resource | |
| contenttype | | Mime type of the content, with charset etc. | |
| creation (exact) | | Date attachment was first created | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| doc-status | | preliminary | final | amended | entered-in-error | |
| event-code | | Main clinical acts documented | |
| event-reference | | Main clinical acts documented | |
| format-canonical | | Profile canonical content rules for the document | |
| format-code | | Format code content rules for the document | |
| format-uri | | Profile URI content rules for the document | |
| relatesto | | Target of the relationship | |
| relation | | replaces | transforms | signs | appends | |
| relationship | | Combination of relation and relatesTo | |
| setting | | Additional details about where the content was created (e.g. clinical specialty) | |
| careteam | | Careteam allocated to participate in the encounter | |
| class | | Classification of patient encounter | |
| date-start (exact) | | The actual start date of the Encounter | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| diagnosis | | The diagnosis or procedure relevant to the encounter | |
| end-date (exact) | | The actual end date of the Encounter | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| episode-of-care | | Episode(s) of care that this encounter should be recorded against | |
| length | | Length of encounter in days | |
| location-period (exact) | | Time period during which the patient was present at the location | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| participant-type | | Role of participant in encounter | |
| service-provider | | The organization (facility) responsible for this encounter | |
| special-arrangement | | Wheelchair, translator, stretcher, etc. | |
| subject-status | | The current status of the subject in relation to the Encounter | |
| connection-type | | Protocol/Profile/Standard to be used with this endpoint connection | |
| payload-type | | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) | |
| care-manager | | Care manager/care coordinator for the patient | |
| condition-concept | | Conditions/problems/diagnoses this episode of care is for (coded) | |
| condition-reference | | Conditions/problems/diagnoses this episode of care is for (resource reference) | |
| incoming-referral | | Incoming Referral Request | |
| claim | | The reference to the claim | |
| coverage | | The plan under which the claim was adjudicated | |
| sex | | A search by a sex code of a family member | |
| analysis-patient | | Who the analysis is about | |
| analysis-subject | | Who the analysis is about | |
| achievement-status | | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable | |
| addresses | | Issues addressed by this goal | |
| lifecycle-status | | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected | |
| start-date (exact) | | When goal pursuit begins | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| target-date (exact) | | Reach goal on or before | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| start | | Type of resource at which the graph starts | |
| characteristic | | Kind of characteristic | |
| characteristic-reference | | An entity referenced in a characteristic | |
| characteristic-value | | A composite of both characteristic and value | |
| exclude | | Group includes or excludes | |
| managing-entity | | Entity that is the custodian of the Group's definition | |
| member | | Reference to the group member | |
| membership | | Definitional or enumerated group | |
| value | | Value held by characteristic | |
| active | | The Healthcare Service is currently marked as active | |
| coverage-area | | Location(s) service is intended for/available to | |
| endpoint | | Technical endpoints providing access to electronic services operated for the healthcare service | |
| offered-in | | The service within which this service is offered | |
| program | | One of the Programs supported by this HealthcareService | |
| study-uid | | The DICOM Study Instance UID from which the images were selected | |
| basedon | | The order for the image, such as Accession Number associated with a ServiceRequest | |
| bodysite | | The body site studied | |
| dicom-class | | The type of the instance | |
| instance | | SOP Instance UID for an instance | |
| interpreter | | Who interpreted the images | |
| modality | | The modality of the series | |
| reason | | The reason for the study | |
| referrer | | The referring physician | |
| series | | DICOM Series Instance UID for a series | |
| started (exact) | | When the study was started | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| reaction | | Additional information on reaction | |
| reaction-date (exact) | | When reaction started | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| status-reason | | Reason why the vaccine was not administered | |
| target-disease | | The target disease the dose is being administered against | |
| vaccine-code | | Vaccine Product Administered | |
| dose-status | | The status of the dose relative to published recommendations | |
| immunization-event | | The vaccine administration event being evaluated | |
| information | | Patient observations supporting recommendation | |
| support | | Past immunizations supporting recommendation | |
| vaccine-type | | Vaccine or vaccine group recommendation applies to | |
| experimental | | For testing purposes, not real usage | |
| global | | Profile that all resources must conform to | |
| for | | The product which this ingredient is a constituent part of | |
| function | | A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent | |
| role | | A classification of the ingredient identifying its purpose within the product, e.g. active, inactive | |
| substance-code | | Reference to a concept (by class) | |
| substance-definition | | Reference to a resource (by instance) | |
| address | | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text | |
| address-city | | A city specified in an address | |
| address-country | | A country specified in an address | |
| address-postalcode | | A postal code specified in an address | |
| address-state | | A state specified in an address | |
| address-use | | A use code specified in an address | |
| administered-by | | Product administrator | |
| owned-by | | An organization of which this organization forms a part | |
| phonetic | | A portion of the organization's name using some kind of phonetic matching algorithm | |
| issuer | | Issuing Organization of Invoice | |
| participant-role | | Type of involvement in creation of this Invoice | |
| totalgross | | Gross total of this Invoice | |
| totalnet | | Net total of this Invoice | |
| content-type | | The type of content in the library (e.g. text/cql) | |
| empty-reason | | Why list is empty | |
| notes | | The annotation - text content (as markdown) | |
| contains | | Select locations that contain the specified co-ordinates | |
| near | | Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes). Servers which support the near parameter SHALL support the unit string 'km' for kilometers and SHOULD support '[mi_us]' for miles, support for other units is optional. If the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant). If the server is unable to understand the units (and does support the near search parameter), it MIGHT return an OperationOutcome and fail the search with a http status 400 BadRequest. If the server does not support the near parameter, the parameter MIGHT report the unused parameter in a bundled OperationOutcome and still perform the search ignoring the near parameter. Note: The algorithm to determine the distance is not defined by the specification, and systems might have different engines that calculate things differently. They could consider geographic point to point, or path via road, or including current traffic conditions, or just simple neighboring postcodes/localities if that's all it had access to. | |
| operational-status | | Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping) | |
| partof | | A location of which this location is a part | |
| evaluated-resource | | An evaluated resource referenced by the measure report | |
| measure | | The measure to return measure report results for | |
| reporter | | The reporter to return measure report results for | |
| form | | Returns medications for a specific dose form | |
| ingredient-code | | Returns medications for this ingredient code | |
| marketingauthorizationholder | | Returns medications made or sold for this marketing authorization holder | |
| medication | | ): Return administrations of this medication reference | |
| reason-given | | Reference to a resource (by instance) | |
| reason-given-code | | Reasons for administering the medication | |
| reason-not-given | | Reasons for not administering the medication | |
| destination | | Returns dispenses that should be sent to a specific destination | |
| prescription | | ): The identity of a prescription to list dispenses from | |
| receiver | | The identity of a receiver to list dispenses for | |
| recorded (exact) | | Returns dispenses where dispensing activity began on this date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| responsibleparty | | Returns dispenses with the specified responsible party | |
| whenhandedover (exact) | | Returns dispenses handed over on this date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| whenprepared (exact) | | Returns dispenses prepared on this date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| classification | | Specific category assigned to the medication | |
| classification-type | | The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification) | |
| doseform | | powder | tablets | capsule + | |
| monitoring-program-name | | Name of the reviewing program | |
| monitoring-program-type | | Type of program under which the medication is monitored | |
| monograph | | Associated documentation about the medication | |
| monograph-type | | The category of medication document | |
| packaging-cost | | The cost of the packaged medication, if the cost is Money | |
| packaging-cost-concept | | The cost of the packaged medication, if the cost is a CodeableConcept | |
| product-type | | Category of the medication or product | |
| source-cost | | The source or owner for the price information | |
| authoredon (exact) | | Return prescriptions written on this date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| combo-date (exact) | | Returns medication request to be administered on a specific date or within a date range | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| intended-dispenser | | Returns prescriptions intended to be dispensed by this Organization | |
| intended-performer | | Returns the intended performer of the administration of the medication request | |
| intended-performertype | | Returns requests for a specific type of performer | |
| adherence | | Returns statements based on adherence or compliance | |
| characteristic-type | | A category for the characteristic | |
| contact | | A product specific contact, person (in a role), or an organization | |
| master-file | | A master file for to the medicinal product (e.g. Pharmacovigilance System Master File) | |
| name-language | | Language code for this name | |
| product-classification | | Allows the product to be classified by various systems | |
| event | | The event that triggers the message or link to the event definition. | |
| focus | | A resource that is a permitted focus of the message | |
| destination-uri | | Actual destination address or id | |
| response-id | | Id of original message | |
| responsible | | Final responsibility for event | |
| source-uri | | Actual message source address or id | |
| target | | Particular delivery destination within the destination | |
| id-type | | oid | uuid | uri | other | |
| telecom | | Contact details for individual or organization | |
| nutrition | | Return intakes for a specific consumed item | |
| additive | | Type of module component to add to the feeding | |
| datetime (exact) | | Return nutrition orders requested on this date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| formula | | Type of enteral or infant formula | |
| oraldiet | | Type of diet that can be consumed orally (i.e., take via the mouth). | |
| supplement | | Type of supplement product requested | |
| code-value-concept | | Code and coded value parameter pair | |
| code-value-date | | Code and date/time value parameter pair | |
| code-value-quantity | | Code and quantity value parameter pair | |
| code-value-string | | Code and string value parameter pair | |
| combo-code | | The code of the observation type or component type | |
| combo-code-value-concept | | Code and coded value parameter pair, including in components | |
| combo-code-value-quantity | | Code and quantity value parameter pair, including in components | |
| combo-data-absent-reason | | The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing. | |
| combo-value-concept | | The value or component value of the observation, if the value is a CodeableConcept | |
| combo-value-quantity | | The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) | |
| component-code | | The component code of the observation type | |
| component-code-value-concept | | Component code and component coded value parameter pair | |
| component-code-value-quantity | | Component code and component quantity value parameter pair | |
| component-data-absent-reason | | The reason why the expected value in the element Observation.component.value[x] is missing. | |
| component-value-concept | | The value of the component observation, if the value is a CodeableConcept | |
| component-value-quantity | | The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) | |
| data-absent-reason | | The reason why the expected value in the element Observation.value[x] is missing. | |
| has-member | | Related resource that belongs to the Observation group | |
| method | | The method used for the observation | |
| value-concept | | The value of the observation, if the value is a CodeableConcept | |
| value-date (exact) | | The value of the observation, if the value is a date or period of time | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| value-quantity | | The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) | |
| value-string | | The value of the observation, if the value is a string, and also searches in CodeableConcept.text | |
| base | | Marks this as a profile of the base | |
| input-profile | | Validation information for in parameters | |
| output-profile | | Validation information for out parameters | |
| email | | A value in an email contact | |
| network | | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) | |
| participating-organization | | The organization that provides services to the primary organization | |
| phone | | A value in a phone contact | |
| primary-organization | | The organization that receives the services from the participating organization | |
| biological | | A biologically derived product within this packaged product | |
| contained-item | | Any of the contained items within this packaged product | |
| package | | A complete packaged product within this packaged product | |
| package-for | | The product that this is a pack for | |
| age | | Searches for patients based on age as calculated based on current date and date of birth. Deceased patients are excluded from the search. | |
| birthOrderBoolean | | Search based on whether a patient was part of a multiple birth or not. | |
| birthdate (exact) | | ): The patient's date of birth | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| death-date (exact) | | The date of death has been provided and satisfies this search value | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| deceased | | This patient has been marked as deceased, or has a death date entered | |
| family | | ): A portion of the family name of the patient | |
| gender | | ): Gender of the patient | |
| general-practitioner | | Patient's nominated general practitioner, not the organization that manages the record | |
| given | | ): A portion of the given name of the patient | |
| link | | All patients/related persons linked to the given patient | |
| mothersMaidenName | | Search based on patient's mother's maiden name | |
| payment-status | | The type of payment notice | |
| response | | The ClaimResponse | |
| allocation-account | | The account to which payment or adjustment was applied. | |
| allocation-encounter | | The encounter to which payment or adjustment was applied. | |
| payment-issuer | | The organization which generated this resource | |
| relatedperson | | The Person links to this RelatedPerson | |
| communication | | One of the languages that the practitioner can communicate with | |
| qualification-period (exact) | | The date(s) a qualification is valid for | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| report | | Any report resulting from the procedure | |
| activity | | Activity that occurred | |
| agent-type | | How the agent participated | |
| signature-type | | Indication of the reason the entity signed the object(s) | |
| when (exact) | | When the activity occurred | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| item-code | | A code that corresponds to one of the items in the questionnaire | |
| questionnaire-code | | A code that matches one of the Questionnaire.code codings | |
| subject-type | | Resource that can be subject of QuestionnaireResponse | |
| item-subject | | Allows searching for QuestionnaireResponses by item value where the item has isSubject=true | |
| questionnaire | | The questionnaire the answers are provided for | |
| case | | The case or procedure number | |
| case-type | | The defining type of case | |
| holder | | The organization that holds the granted authorization | |
| region | | The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted | |
| protocol | | Steps followed in executing study | |
| recruitment_actual | | Actual number of participants enrolled in study across all groups | |
| recruitment_target | | Target number of participants enrolled in study across all groups | |
| site | | Facility where study activities are conducted | |
| subject_state | | candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn | |
| probability | | Likelihood of specified outcome | |
| risk | | Likelihood of specified outcome as a qualitative value | |
| component | | Defines how the part works | |
| body-structure | | Body structure Where procedure is going to be done | |
| code-concept | | What is being requested/ordered | |
| code-reference | | What is being requested/ordered | |
| performer-type | | Performer role | |
| requisition | | Composite Request ID | |
| schedule | | The Schedule Resource that we are seeking a slot within | |
| accession | | The accession number associated with the specimen | |
| collected (exact) | | The date the specimen was collected | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| container-device | | The unique identifier associated with the specimen container | |
| procedure | | The procedure that collected the specimen | |
| container | | The type of specimen conditioned in container expected by the lab | |
| is-derived | | Primary specimen (false) or derived specimen (true) | |
| type-tested | | The type of specimen conditioned for testing | |
| abstract | | Whether the structure is abstract | |
| base-path | | Path that identifies the base element | |
| derivation | | specialization | constraint - How relates to base definition | |
| ext-context | | An extension context assigned to the structure definition | |
| ext-context-expression | | An expression of extension context assigned to the structure definition | |
| ext-context-type | | A type of extension context assigned to the structure definition | |
| path | | A path that is constrained in the StructureDefinition | |
| valueset | | A vocabulary binding reference | |
| payload | | The mime-type of the notification payload | |
| derived-or-self | | A server defined search that matches either the url or derivedFrom | |
| trigger-description | | Text representation of the trigger | |
| expiry (exact) | | Expiry date of package or container of substance | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| substance-reference | | A component of the substance | |
| supplier | | Dispenser | |
| business-status | | Search by business status | |
| modified (exact) | | Search by last modification date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| output | | Search by task output | |
| tester | | The name of the testing organization | |
| testscript | | The test script executed to produce this report | |
| scope-artifact | | The artifact under test | |
| scope-artifact-conformance | | The artifact under test and conformance testing expectation | |
| scope-artifact-phase | | The artifact under test and phase of testing | |
| testscript-capability | | TestScript required and validated capability | |
| expansion | | Identifies the value set expansion (business identifier) | |
| reference | | A code system included or excluded in the value set or an imported value set | |
| datewritten (exact) | | Return prescriptions written on this date | |
| (before) | | (before given date) |
| (after) | | (after given date) |
| prescriber | | Who authorized the vision prescription | |
| familymemberhistorycondition | | Search for a history of a particular condition within a patient's family | |
|
| Text | | Search for these words in the narrative. See [[http://technet.microsoft.com/en-us/library/ms142571.aspx]] for details |
| First Record | | (empty = start at the start) |
| # Records to return | | (default value, which is also max allowed, is 1000. Values of <2 not allowed) |
| Sort By | | |
| Summary: | | Return just a summary for each resource (if applicable) |
FHIR
© HL7.org
|
Server Home |
Health Intersections FHIR Server v3.7.21-SNAPSHOT
|
FHIR Version 5.0.0
| User: Registered User (Unknown)