Get desktop application:
View/edit binary Protocol Buffers messages
A list of the base types defined by this version of the FHIR specification - types that are defined, but for which only specializations actually are created. See http://hl7.org/fhir/abstract-types
(message has no fields)
Auto-generated from StructureDefinition for Account. Tracks balance, charges, for patient or cost center. See http://hl7.org/fhir/StructureDefinition/Account
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Account number
E.g. patient, expense, depreciation
Human-readable label
The entity that caused the expenses
Transaction window
Entity managing the Account
Explanation of purpose/use
Reference to a parent Account
The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The party(s), such as insurances, that may contribute to the payment of this account
The priority of the coverage in the context of this account
The parties ultimately responsible for balancing the Account
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Responsible entity
Credit or other hold applied
Guarantee account during
active | inactive | entered-in-error | on-hold | unknown
Used in:
Indicates whether the account is available to be used. See http://hl7.org/fhir/account-status
(message has no fields)
Used in:
Defines behavior for an action or a group for how many times that item may be repeated. See http://hl7.org/fhir/action-cardinality-behavior
(message has no fields)
Used in: ,
Defines the kinds of conditions that can appear on actions. See http://hl7.org/fhir/action-condition-kind
(message has no fields)
Used in: ,
Defines organization behavior of a group. See http://hl7.org/fhir/action-grouping-behavior
(message has no fields)
Used in: ,
The type of participant for the action. See http://hl7.org/fhir/action-participant-type
(message has no fields)
Used in: ,
Defines selection frequency behavior for an action or group. See http://hl7.org/fhir/action-precheck-behavior
(message has no fields)
Used in: ,
Defines the types of relationships between actions. See http://hl7.org/fhir/action-relationship-type
(message has no fields)
Used in: , , ,
Defines expectations around whether an action or action group is required. See http://hl7.org/fhir/action-required-behavior
(message has no fields)
Used in: ,
Defines selection behavior of a group. See http://hl7.org/fhir/action-selection-behavior
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for ActivityDefinition. The definition of a specific activity to be taken, independent of any particular patient or context. See http://hl7.org/fhir/StructureDefinition/ActivityDefinition
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this activity definition, represented as a URI (globally unique)
Additional identifier for the activity definition
Business version of the activity definition
Name for this activity definition (computer friendly)
Name for this activity definition (human friendly)
Subordinate title of the activity definition
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the activity definition
The context that the content is intended to support
Intended jurisdiction for activity definition (if applicable)
Why this activity definition is defined
Describes the clinical usage of the activity definition
Use and/or publishing restrictions
When the activity definition was approved by publisher
When the activity definition was last reviewed
When the activity definition is expected to be used
E.g. Education, Treatment, Assessment, etc.
Who authored the content
Who edited the content
Who reviewed the content
Who endorsed the content
Additional documentation, citations, etc.
Logic used by the activity definition
What profile the resource needs to conform to
Detail type of activity
True if the activity should not be performed
Where it should happen
How much is administered/consumed/supplied
Detailed dosage instructions
What part of body to perform on
What specimens are required to perform this action
What observations are required to perform this action
What observations must be produced by this action
Transform to apply the template
Dynamic aspects of the definition
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The path to the element to be set dynamically
An expression that provides the dynamic value for the customization
proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Used in:
Kind of resource
Used in:
Who should participate in the action
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
E.g. Nurse, Surgeon, Parent, etc.
patient | practitioner | related-person | device
Used in:
routine | urgent | asap | stat
Used in:
What's administered/supplied
Used in:
draft | active | retired | unknown
Used in:
Type of individual the activity definition is intended for
Used in:
When activity is to occur
Used in:
Auto-generated from StructureDefinition for Address. An address expressed using postal conventions (as opposed to GPS or other location definition formats). See http://hl7.org/fhir/StructureDefinition/Address
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Text representation of the address
Street name, number, direction & P.O. Box etc.
Name of city, town etc.
District name (aka county)
Sub-unit of country (abbreviations ok)
Postal code for area
Country (e.g. can be ISO 3166 2 or 3 letter code)
Time period when address was/is in use
postal | physical | both
Used in:
home | work | temp | old | billing - purpose of this address
Used in:
Auto-generated from StructureDefinition for AD-use. BAD | CONF | HP | HV | DIR | PUB | PHYS | PST. See http://hl7.org/fhir/StructureDefinition/iso21090-AD-use
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for ADXP-additionalLocator. additionalLocator. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-buildingNumberSuffix. buildingNumberSuffix. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-careOf. careOf. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-censusTract. censusTract. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-censusTract
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-delimiter. delimiter. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-delimiter
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-deliveryAddressLine. deliveryAddressLine. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-deliveryAddressLine
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-deliveryInstallationArea. deliveryInstallationArea. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-deliveryInstallationArea
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-deliveryInstallationQualifier. deliveryInstallationQualifier. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-deliveryInstallationQualifier
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-deliveryInstallationType. deliveryInstallationType. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-deliveryInstallationType
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-deliveryMode. deliveryMode. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-deliveryMode
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-deliveryModeIdentifier. deliveryModeIdentifier. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-deliveryModeIdentifier
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-direction. direction. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-direction
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-houseNumber. houseNumber. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-houseNumberNumeric. houseNumberNumeric. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumberNumeric
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-postBox. postBox. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-precinct. precinct. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-streetAddressLine. streetAddressLine. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-streetName. streetName. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-streetNameBase. streetNameBase. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-streetNameType. streetNameType. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameType
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-unitID. unitID. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ADXP-unitType. unitType. See http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitType
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Geolocation. The absolute geographic location. See http://hl7.org/fhir/StructureDefinition/geolocation
Unique id for inter-element referencing
Additional content defined by implementations
Latitude with WGS84 datum
Longitude with WGS84 datum
The type of an address (physical / postal). See http://hl7.org/fhir/address-type
(message has no fields)
Used in:
The use of an address. See http://hl7.org/fhir/address-use
(message has no fields)
Used in:
The gender of a person used for administrative purposes. See http://hl7.org/fhir/administrative-gender
(message has no fields)
Used in: , , , , , , , ,
Auto-generated from StructureDefinition for AdverseEvent. Medical care, research study or other healthcare event causing physical injury. See http://hl7.org/fhir/StructureDefinition/AdverseEvent
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business identifier for the event
product-problem | product-quality | product-use-error | wrong-dose | incorrect-prescribing-information | wrong-technique | wrong-route-of-administration | wrong-rate | wrong-duration | wrong-time | expired-drug | medical-device-use-error | problem-different-manufacturer | unsafe-physical-environment
Type of the event itself in relation to the subject
Subject impacted by event
Encounter created as part of
When the event occurred
When the event was detected
When the event was recorded
Effect on the subject due to this event
Location where adverse event occurred
Seriousness of the event
mild | moderate | severe
resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown
Who recorded the adverse event
Who was involved in the adverse event or the potential adverse event
AdverseEvent.subjectMedicalHistory
AdverseEvent.referenceDocument
AdverseEvent.study
actual | potential
Used in:
The suspected agent causing the adverse event
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Refers to the specific entity that caused the adverse event
Information on the possible cause of the event
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Assessment of if the entity caused the event
AdverseEvent.suspectEntity.causalityProductRelatedness
AdverseEvent.suspectEntity.causalityAuthor
ProbabilityScale | Bayesian | Checklist
Overall nature of the adverse event, e.g. real or potential. See http://hl7.org/fhir/adverse-event-actuality
(message has no fields)
Used in:
TODO (and should this be required?). See http://terminology.hl7.org/CodeSystem/adverse-event-outcome
(message has no fields)
The severity of the adverse event itself, in direct relation to the subject. See http://terminology.hl7.org/CodeSystem/adverse-event-severity
(message has no fields)
Auto-generated from StructureDefinition for Age. A duration of time during which an organism (or a process) has existed. See http://hl7.org/fhir/StructureDefinition/Age
Used in: , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Numerical value (with implicit precision)
Unit representation
System that defines coded unit form
Coded form of the unit
< | <= | >= | > - how to understand the value
Used in:
How resource references can be aggregated. See http://hl7.org/fhir/resource-aggregation-mode
(message has no fields)
Used in:
Auto-generated from StructureDefinition for AllergyIntolerance. Allergy or Intolerance (generally: Risk of adverse reaction to a substance). See http://hl7.org/fhir/StructureDefinition/AllergyIntolerance
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External ids for this item
active | inactive | resolved
unconfirmed | confirmed | refuted | entered-in-error
Code that identifies the allergy or intolerance
Who the sensitivity is for
Encounter when the allergy or intolerance was asserted
Date first version of the resource instance was recorded
Who recorded the sensitivity
Source of the information about the allergy
Date(/time) of last known occurrence of a reaction
Additional text not captured in other fields
food | medication | environment | biologic
Used in:
low | high | unable-to-assess
Used in:
When allergy or intolerance was identified
Used in:
Adverse Reaction Events linked to exposure to substance
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Specific substance or pharmaceutical product considered to be responsible for event
Clinical symptoms/signs associated with the Event
Description of the event as a whole
Date(/time) when manifestations showed
How the subject was exposed to the substance
Text about event not captured in other fields
mild | moderate | severe (of event as a whole)
Used in:
allergy | intolerance - Underlying mechanism (if known)
Used in:
Auto-generated from StructureDefinition for administration. Actual medication record, if known. See http://hl7.org/fhir/StructureDefinition/openEHR-administration
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for assertedDate. Date the allergy or intolerance was first asserted. See http://hl7.org/fhir/StructureDefinition/allergyintolerance-assertedDate
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for careplan. Clinical Management Details. See http://hl7.org/fhir/StructureDefinition/openEHR-careplan
Unique id for inter-element referencing
Value of extension
Category of an identified substance associated with allergies or intolerances. See http://hl7.org/fhir/allergy-intolerance-category
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for certainty. Certainty that the substance was the cause of the manifestation. See http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty
Unique id for inter-element referencing
Value of extension
Preferred value set for AllergyIntolerance Clinical Status. See http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical
(message has no fields)
Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. See http://hl7.org/fhir/allergy-intolerance-criticality
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for duration. How long Manifestations persisted. See http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for exposureDate. Date(/time) of first exposure to Substance. See http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for exposureDescription. Text description about exposure to the Substance. See http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for exposureDuration. Amount of time individual was exposed to Substance. See http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for location. Body site of manifestations. See http://hl7.org/fhir/StructureDefinition/openEHR-location
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for management. Clinical Management Description. See http://hl7.org/fhir/StructureDefinition/openEHR-management
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for reasonRefuted. Explanation associated with refuted status. See http://hl7.org/fhir/StructureDefinition/allergyintolerance-reasonRefuted
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for resolutionAge. Age that the allergy or intolerance resolved. See http://hl7.org/fhir/StructureDefinition/allergyintolerance-resolutionAge
Unique id for inter-element referencing
Value of extension
Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. See http://hl7.org/fhir/reaction-event-severity
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for substanceExposureRisk. Exposure risk of adverse reaction (allergy or intolerance) to the specified substance/product. See http://hl7.org/fhir/StructureDefinition/allergyintolerance-substanceExposureRisk
Unique id for inter-element referencing
Additional content defined by implementations
Substance (or pharmaceutical product)
known-reaction-risk | no-known-reaction-risk
The risk of an adverse reaction (allergy or intolerance) for this patient upon exposure to the substance (including pharmaceutical products). See http://terminology.hl7.org/CodeSystem/allerg-intol-substance-exp-risk
(message has no fields)
Auto-generated from StructureDefinition for test. Observations that confirm or refute. See http://hl7.org/fhir/StructureDefinition/openEHR-test
Unique id for inter-element referencing
Value of extension
Identification of the underlying physiological mechanism for a Reaction Risk. See http://hl7.org/fhir/allergy-intolerance-type
(message has no fields)
Used in: ,
Preferred value set for AllergyIntolerance Verification Status. See http://terminology.hl7.org/CodeSystem/allergyintolerance-verification
(message has no fields)
Auto-generated from StructureDefinition for animalSpecies. The Species of the Service Animal. See http://hl7.org/fhir/StructureDefinition/practitioner-animalSpecies
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Annotation. Text node with attribution. See http://hl7.org/fhir/StructureDefinition/Annotation
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
When the annotation was made
The annotation - text content (as markdown)
Individual responsible for the annotation
Used in:
Auto-generated from StructureDefinition for Appointment. A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). See http://hl7.org/fhir/StructureDefinition/Appointment
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External Ids for this item
The coded reason for the appointment being cancelled
A broad categorization of the service that is to be performed during this appointment
The specific service that is to be performed during this appointment
The specialty of a practitioner that would be required to perform the service requested in this appointment
The style of appointment or patient that has been booked in the slot (not service type)
Coded reason this appointment is scheduled
Reason the appointment is to take place (resource)
Used to make informed decisions if needing to re-prioritize
Shown on a subject line in a meeting request, or appointment list
Additional information to support the appointment
When appointment is to take place
When appointment is to conclude
Can be less than start/end (e.g. estimate)
The slots that this appointment is filling
The date that this appointment was initially created
Additional comments
Detailed information and instructions for the patient
The service request this appointment is allocated to assess
Potential date/time interval(s) requested to allocate the appointment within
Participants involved in appointment
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Role of participant in the appointment
Person, Location/HealthcareService or Device
Participation period of the actor
required | optional | information-only
Used in:
accepted | declined | tentative | needs-action
Used in:
proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Used in:
Auto-generated from StructureDefinition for AppointmentResponse. A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection. See http://hl7.org/fhir/StructureDefinition/AppointmentResponse
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External Ids for this item
Appointment this response relates to
Time from appointment, or requested new start time
Time from appointment, or requested new end time
Role of participant in the appointment
Person, Location, HealthcareService, or Device
Additional comments
accepted | declined | tentative | needs-action
Used in:
The free/busy status of an appointment. See http://hl7.org/fhir/appointmentstatus
(message has no fields)
Used in:
Auto-generated from StructureDefinition for approachBodyStructure. The access point or points used for this procedure. See http://hl7.org/fhir/StructureDefinition/procedure-approachBodyStructure
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for approvalDate. When resource approved by publisher. See http://hl7.org/fhir/StructureDefinition/resource-approvalDate
Unique id for inter-element referencing
Value of extension
The type of direction to use for assertion. See http://hl7.org/fhir/assert-direction-codes
(message has no fields)
Used in:
The type of operator to use for assertion. See http://hl7.org/fhir/assert-operator-codes
(message has no fields)
Used in:
The type of response code to use for assertion. See http://hl7.org/fhir/assert-response-code-types
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Attachment. Content in a format defined elsewhere. See http://hl7.org/fhir/StructureDefinition/Attachment
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Human language of the content (BCP-47)
Data inline, base64ed
Uri where the data can be found
Number of bytes of content (if url provided)
Hash of the data (sha-1, base64ed)
Label to display in place of the data
Date attachment was first created
Mime type of the content, with charset etc.
Used in:
This valueset is not enumerable, and so is represented as a string.
Auto-generated from StructureDefinition for citation. Bibliographic citation for the resource. See http://hl7.org/fhir/StructureDefinition/cqf-citation
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for qualityOfEvidence. The quality of the evidence. See http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for strengthOfRecommendation. The strength of the recommendation. See http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for AuditEvent. Event record kept for security purposes. See http://hl7.org/fhir/StructureDefinition/AuditEvent
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Type/identifier of event
More specific type/id for the event
When the activity occurred
Time when the event was recorded
Description of the event outcome
The purposeOfUse of the event
Type of action performed during the event
Used in:
Actor involved in the event
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
How agent participated
Agent role in the event
Identifier of who
Alternative User identity
Human friendly name for the agent
Whether user is initiator
Where
Policy that authorized event
Type of media
Reason given for this user
Logical network location for application activity
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Identifier for the network access point of the user device
The type of network access point
Used in:
Data or objects used
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Specific instance of resource
Type of entity involved
What role the entity played
Life-cycle stage for the entity
Security labels on the entity
Descriptor for entity
Descriptive text
Query parameters
Additional Information about the entity
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Name of the property
Property value
Used in:
Whether the event succeeded or failed
Used in:
Audit Event Reporter
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Logical source location within the enterprise
The identity of source detecting the event
The type of source where event originated
Auto-generated from StructureDefinition for Accession. Accession Number. See http://hl7.org/fhir/StructureDefinition/auditevent-Accession
Unique id for inter-element referencing
Value of extension
Indicator for type of action performed during the event that generated the event. See http://hl7.org/fhir/audit-event-action
(message has no fields)
Used in:
The type of network access point of this agent in the audit event. See http://hl7.org/fhir/network-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Anonymized. Anonymized state. See http://hl7.org/fhir/StructureDefinition/auditevent-Anonymized
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Encrypted. Encrypted state. See http://hl7.org/fhir/StructureDefinition/auditevent-Encrypted
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Instance. SOP Instance UID value. See http://hl7.org/fhir/StructureDefinition/auditevent-Instance
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for MPPS. MPPS instance UID. See http://hl7.org/fhir/StructureDefinition/auditevent-MPPS
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for NumberOfInstances. Number of SOP Instances referred to by this entity. See http://hl7.org/fhir/StructureDefinition/auditevent-NumberOfInstances
Unique id for inter-element referencing
Value of extension
Indicates whether the event succeeded or failed. See http://hl7.org/fhir/audit-event-outcome
(message has no fields)
Used in:
Auto-generated from StructureDefinition for ParticipantObjectContainsStudy. Contains Study. See http://hl7.org/fhir/StructureDefinition/auditevent-ParticipantObjectContainsStudy
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for SOPClass. UIDs of SOP classes referred to. See http://hl7.org/fhir/StructureDefinition/auditevent-SOPClass
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for BackboneElement. Base for elements defined inside a resource. See http://hl7.org/fhir/StructureDefinition/BackboneElement
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Auto-generated from StructureDefinition for base64Binary. Primitive Type base64Binary. See http://hl7.org/fhir/StructureDefinition/base64Binary
Used in: , , , , , , , , , , , , , , , , ,
Primitive value for base64Binary
xml:id (or equivalent in JSON)
Additional content defined by implementations
Auto-generated from StructureDefinition for Basic. Resource for non-supported content. See http://hl7.org/fhir/StructureDefinition/Basic
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business identifier
Kind of Resource
Identifies the focus of this resource
When created
Who created
Auto-generated from StructureDefinition for encounterClass. Extension. See http://hl7.org/fhir/StructureDefinition/cqf-encounterClass
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for encounterType. Extension. See http://hl7.org/fhir/StructureDefinition/cqf-encounterType
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for initiatingOrganization. Extension. See http://hl7.org/fhir/StructureDefinition/cqf-initiatingOrganization
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for initiatingPerson. Extension. See http://hl7.org/fhir/StructureDefinition/cqf-initiatingPerson
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for receivingOrganization. Extension. See http://hl7.org/fhir/StructureDefinition/cqf-receivingOrganization
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for receivingPerson. Extension. See http://hl7.org/fhir/StructureDefinition/cqf-receivingPerson
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for recipientLanguage. Extension. See http://hl7.org/fhir/StructureDefinition/cqf-recipientLanguage
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for recipientType. Extension. See http://hl7.org/fhir/StructureDefinition/cqf-recipientType
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for systemUserLanguage. Extension. See http://hl7.org/fhir/StructureDefinition/cqf-systemUserLanguage
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for systemUserTaskContext. The task the system user is performing. See http://hl7.org/fhir/StructureDefinition/cqf-systemUserTaskContext
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for systemUserType. The type of user initiating the request. See http://hl7.org/fhir/StructureDefinition/cqf-systemUserType
Unique id for inter-element referencing
Value of extension
Whether the cost applies to in-network or out-of-network providers. See http://terminology.hl7.org/CodeSystem/applicability
(message has no fields)
Auto-generated from StructureDefinition for Binary. Pure binary content defined by a format other than FHIR. See http://hl7.org/fhir/StructureDefinition/Binary
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Identifies another resource to use as proxy when enforcing access control
The actual content
MimeType of the binary content
Used in:
This valueset is not enumerable, and so is represented as a string.
Indication of the degree of conformance expectations associated with a binding. See http://hl7.org/fhir/binding-strength
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for BiologicallyDerivedProduct. A material substance originating from a biological entity. See http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External ids for this item
What this biologically derived product is
Procedure request
The amount of this biologically derived product
BiologicallyDerivedProduct parent
How this product was collected
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Individual performing collection
Who is product from
Time of product collection
Used in:
Any manipulation of product post-collection
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Description of manipulation
Time of manipulation
Used in:
Any processing of the product during collection
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Description of of processing
Procesing code
Substance added during processing
Time of processing
Used in:
organ | tissue | fluid | cells | biologicalAgent
Used in:
available | unavailable
Used in:
Product storage
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Description of storage
Storage temperature
Storage timeperiod
farenheit | celsius | kelvin
Used in:
Biologically Derived Product Category. See http://hl7.org/fhir/product-category
(message has no fields)
Used in:
Biologically Derived Product Status. See http://hl7.org/fhir/product-status
(message has no fields)
Used in:
BiologicallyDerived Product Storage Scale. See http://hl7.org/fhir/product-storage-scale
(message has no fields)
Used in:
UCUM units for recording body length measures such as height and head circumference See http://hl7.org/fhir/ValueSet/ucum-bodylength
(message has no fields)
Auto-generated from StructureDefinition for bodyPosition. The body position during the observation. See http://hl7.org/fhir/StructureDefinition/observation-bodyPosition
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for BodyStructure. Specific and identified anatomical structure. See http://hl7.org/fhir/StructureDefinition/BodyStructure
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Bodystructure identifier
Whether this record is in active use
Kind of Structure
Body site
Body site modifier
Text description
Attached images
Who this is about
Auto-generated from StructureDefinition for BodyStructure Reference. Target anatomic location or structure. See http://hl7.org/fhir/StructureDefinition/bodySite
Unique id for inter-element referencing
Value of extension
UCUM units for recording Body Temperature See http://hl7.org/fhir/ValueSet/ucum-bodytemp
(message has no fields)
UCUM units for recording Body Weight See http://hl7.org/fhir/ValueSet/ucum-bodyweight
(message has no fields)
Auto-generated from StructureDefinition for boolean. Primitive Type boolean. See http://hl7.org/fhir/StructureDefinition/boolean
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Primitive value for boolean
xml:id (or equivalent in JSON)
Additional content defined by implementations
Auto-generated from StructureDefinition for Bundle. Contains a collection of resources. See http://hl7.org/fhir/StructureDefinition/Bundle
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Persistent identifier for the bundle
When the bundle was assembled
If search, the total number of matches
Digital Signature
Entry in the bundle - will have a resource or information
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Links related to this entry
URI for resource (Absolute URL server address or URI for UUID/OID)
A resource in the bundle
Additional execution information (transaction/batch/history)
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
URL for HTTP equivalent of this entry
For managing cache currency
For managing cache currency
For managing update contention
For conditional creates
GET | HEAD | POST | PUT | DELETE | PATCH
Used in:
Results of execution (transaction/batch/history)
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Status response code (text optional)
The location (if the operation returns a location)
The Etag for the resource (if relevant)
Server's date time modified
OperationOutcome with hints and warnings (for batch/transaction)
Search related information
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Search ranking (between 0 and 1)
match | include | outcome - why this is in the result set
Used in:
Links related to this Bundle
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Reference details for the link
document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Used in:
Auto-generated from StructureDefinition for http-response-header. HTTP header returned by the interaction. See http://hl7.org/fhir/StructureDefinition/http-response-header
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for location-distance. The distance this resource is from a provided location (geocode point). See http://hl7.org/fhir/StructureDefinition/location-distance
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for match-grade. How likely this resource is to be a match. See http://hl7.org/fhir/StructureDefinition/match-grade
Unique id for inter-element referencing
Value of extension
Used in:
Indicates the purpose of a bundle - how it is intended to be used. See http://hl7.org/fhir/bundle-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for calculatedValue. A calculated value. See http://hl7.org/fhir/StructureDefinition/cqf-calculatedValue
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for canonical. Primitive Type canonical. See http://hl7.org/fhir/StructureDefinition/canonical
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Primitive value for canonical
xml:id (or equivalent in JSON)
Additional content defined by implementations
Auto-generated from StructureDefinition for Display Name. Display name for canonical reference. See http://hl7.org/fhir/StructureDefinition/display
Unique id for inter-element referencing
Value of extension
The master set of status codes used throughout FHIR. All status codes are mapped to one of these codes. See http://hl7.org/fhir/resource-status
(message has no fields)
Auto-generated from StructureDefinition for CapabilityStatement. A statement of system capabilities. See http://hl7.org/fhir/StructureDefinition/CapabilityStatement
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this capability statement, represented as a URI (globally unique)
Business version of the capability statement
Name for this capability statement (computer friendly)
Name for this capability statement (human friendly)
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the capability statement
The context that the content is intended to support
Intended jurisdiction for capability statement (if applicable)
Why this capability statement is defined
Use and/or publishing restrictions
Canonical URL of another capability statement this implements
Canonical URL of another capability statement this adds to
Implementation guides supported
Document definition
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Description of document support
Constraint on the resources used in the document
producer | consumer
Used in:
FHIR Version the system supports
Used in:
formats supported (xml | json | ttl | mime type)
Used in:
This valueset is not enumerable, and so is represented as a string.
If this describes a specific instance
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Describes this specific instance
Base URL for the installation
Organization that manages the data
instance | capability | requirements
Used in:
If messaging is supported
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Reliable Message Cache Length (min)
Messaging interface behavior details
Where messages should be sent
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
http | ftp | mllp +
Network address or identifier of the end-point
Messages supported by this system
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Message supported by this system
sender | receiver
Used in:
Patch formats supported
Used in:
This valueset is not enumerable, and so is represented as a string.
If the endpoint is a RESTful one
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
General description of implementation
Search parameters for searching all resources
Definition of a system level operation
Compartments served/used by system
client | server
Used in:
Resource served on the REST interface
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Base System profile for all uses of resource
Profiles for use cases supported
Additional information about the use of the resource type
Whether vRead can return past versions
If update can commit to a new identity
If allows/uses conditional create
If allows/uses conditional update
_include values supported by the server
_revinclude values supported by the server
not-supported | single | multiple - how conditional delete is supported
Used in:
not-supported | modified-since | not-match | full-support
Used in:
Definition of a resource operation
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Name by which the operation/query is invoked
The defined operation/query
Specific details about operation behavior
literal | logical | resolves | enforced | local
Used in:
What operations are supported?
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Anything special about operation behavior
read | vread | update | patch | delete | history-instance | history-type | create | search-type
Used in:
Search parameters supported by implementation
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Name of search parameter
Source of definition for parameter
Server-specific usage
number | date | string | token | reference | composite | quantity | uri | special
Used in:
A resource type that is supported
Used in:
no-version | versioned | versioned-update
Used in:
Information about security of implementation
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Adds CORS Headers (http://enable-cors.org/)
OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
General description of how security works
What operations are supported?
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Anything special about operation behavior
transaction | batch | search-system | history-system
Used in:
Software that is covered by this capability statement
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
A name the software is known by
Version covered by this statement
Date this version was released
draft | active | retired | unknown
Used in:
Auto-generated from StructureDefinition for capabilities. Server Capabilities. See http://fhir-registry.smarthealthit.org/StructureDefinition/capabilities
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for expectation. SHALL | SHOULD | MAY |SHOULD-NOT. See http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
Unique id for inter-element referencing
Value of extension
Used in:
How a capability statement is intended to be used. See http://hl7.org/fhir/capability-statement-kind
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for oauth-uris. Automated discovery of OAuth2 endpoints. See http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris
Unique id for inter-element referencing
Additional content defined by implementations
OAuth2 "authorize" endpoint
OAuth2 "token" endpoint
OAuth2 dynamic registration endpoint
User-facing authorization management entry point
Auto-generated from StructureDefinition for prohibited. Functionality not allowed. See http://hl7.org/fhir/StructureDefinition/capabilitystatement-prohibited
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for search-parameter-combination. An allowable parameter combination. See http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
Unique id for inter-element referencing
Additional content defined by implementations
A required search parameter name
An optional search parameter name
Auto-generated from StructureDefinition for supported-system. Code system not defined in a value set. See http://hl7.org/fhir/StructureDefinition/capabilitystatement-supported-system
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for websocket. Where server websocket end point is found. See http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for CarePlan. Healthcare plan for patient or group. See http://hl7.org/fhir/StructureDefinition/CarePlan
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External Ids for this plan
Instantiates FHIR protocol or definition
Instantiates external protocol or definition
Fulfills CarePlan
CarePlan replaced by this CarePlan
Part of referenced CarePlan
Type of plan
Human-friendly name for the care plan
Summary of nature of plan
Who the care plan is for
Encounter created as part of
Time period plan covers
Date record was first recorded
Who is the designated responsible party
Who provided the content of the care plan
Who's involved in plan?
Health issues this plan addresses
Information considered as part of plan
Desired outcome of plan
Comments about the plan
Action to occur as part of plan
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Results of the activity
Appointment, Encounter, Procedure, etc.
Comments about the activity status/progress
Activity details defined in specific resource
In-line definition of activity
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Instantiates FHIR protocol or definition
Instantiates external protocol or definition
Detail type of activity
Why activity should be done or why activity was prohibited
Why activity is needed
Goals this activity relates to
Reason for current status
If true, activity is prohibiting action
Where it should happen
Who will be responsible?
How to consume/day?
How much to administer/supply/consume
Extra info describing activity to perform
Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Used in:
What is to be administered/supplied
Used in:
When activity is to occur
Used in:
not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Used in:
proposal | plan | order | option
Used in:
draft | active | on-hold | revoked | completed | entered-in-error | unknown
Used in:
Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. See http://hl7.org/fhir/ValueSet/care-plan-activity-kind
(message has no fields)
Used in: ,
Codes that reflect the current state of a care plan activity within its overall life cycle. See http://hl7.org/fhir/care-plan-activity-status
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for activity-title. Label for activity. See http://hl7.org/fhir/StructureDefinition/careplan-activity-title
Unique id for inter-element referencing
Value of extension
Codes indicating the degree of authority/intentionality associated with a care plan. See http://hl7.org/fhir/ValueSet/care-plan-intent
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for CareTeam. Planned participants in the coordination and delivery of care for a patient or group. See http://hl7.org/fhir/StructureDefinition/CareTeam
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External Ids for this team
Type of team
Name of the team, such as crisis assessment team
Who care team is for
Encounter created as part of
Time period team covers
Why the care team exists
Why the care team exists
Organization responsible for the care team
A contact detail for the care team (that applies to all members)
Comments made about the CareTeam
Members of the team
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of involvement
Who is involved
Organization of the practitioner
Time period of participant
proposed | active | suspended | inactive | entered-in-error
Used in:
Indicates the status of the care team. See http://hl7.org/fhir/care-team-status
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for CatalogEntry. An entry in a catalog. See http://hl7.org/fhir/StructureDefinition/CatalogEntry
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Unique identifier of the catalog item
The type of item - medication, device, service, protocol or other
Whether the entry represents an orderable item
The item that is being defined
Any additional identifier(s) for the catalog item, in the same granularity or concept
Classification (category or class) of the item entry
The time period in which this catalog entry is expected to be active
The date until which this catalog entry is expected to be active
When was this catalog last updated
Additional characteristics of the catalog entry
Additional classification of the catalog entry
An item that this catalog entry is related to
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The reference to the related item
triggers | is-replaced-by
Used in:
draft | active | retired | unknown
Used in:
The type of relations between entries. See http://hl7.org/fhir/relation-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for ChargeItem. Item containing charge code(s) associated with the provision of healthcare provider products. See http://hl7.org/fhir/StructureDefinition/ChargeItem
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier for item
Defining information about the code of this charge item
Resource defining the code of this ChargeItem
Part of referenced ChargeItem
A code that identifies the charge, like a billing code
Individual service was done for/to
Encounter / Episode associated with event
Organization providing the charged service
Organization requesting the charged service
Organization that has ownership of the (potential, future) revenue
Quantity of which the charge item has been serviced
Anatomical location, if relevant
Factor overriding the associated rules
Price overriding the associated rules
Reason for overriding the list price/factor
Individual who was entering
Date the charge item was entered
Why was the charged service rendered?
Which rendered service is being charged?
Account to place this charge
Comments made about the ChargeItem
Further information supporting this charge
When the charged service was applied
Used in:
Who performed charged service
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
What type of performance was done
Individual who was performing
Product charged
Used in:
planned | billable | not-billable | aborted | billed | entered-in-error | unknown
Used in:
Auto-generated from StructureDefinition for ChargeItemDefinition. Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined. See http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this charge item definition, represented as a URI (globally unique)
Additional identifier for the charge item definition
Business version of the charge item definition
Name for this charge item definition (human friendly)
Underlying externally-defined charge item definition
A larger definition of which this particular definition is a component or step
Completed or terminated request(s) whose function is taken by this new request
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the charge item definition
The context that the content is intended to support
Intended jurisdiction for charge item definition (if applicable)
Use and/or publishing restrictions
When the charge item definition was approved by publisher
When the charge item definition was last reviewed
When the charge item definition is expected to be used
Billing codes or product types this definition applies to
Instances this definition applies to
Whether or not the billing code is applicable
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Natural language description of the condition
Language of the expression
Boolean-valued expression
Group of properties which are applicable under the same conditions
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Conditions under which the priceComponent is applicable
Components of total line item price
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Code identifying the specific component
Factor used for calculating this component
Monetary amount associated with this component
base | surcharge | deduction | discount | tax | informational
Used in:
draft | active | retired | unknown
Used in:
Codes identifying the lifecycle stage of a ChargeItem. See http://hl7.org/fhir/chargeitem-status
(message has no fields)
Used in:
Direction in which lists of possible answers should be displayed. See http://terminology.hl7.org/CodeSystem/choice-list-orientation
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Claim. Claim, Pre-determination or Pre-authorization. See http://hl7.org/fhir/StructureDefinition/Claim
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier for claim
Category or discipline
More granular claim type
The recipient of the products and services
Relevant time frame for the claim
Resource creation date
Author of the claim
Target
Party responsible for the claim
Desired processing ugency
For whom to reserve funds
Prescription authorizing services and products
Original prescription if superseded by fulfiller
Treatment referral
Servicing facility
Total claim cost
Details of the event
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
When the incident occurred
The nature of the accident
Where the event occurred
Used in:
Members of the care team
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Order of care team
Practitioner or organization
Indicator of the lead practitioner
Function within the team
Practitioner credential or specialization
Pertinent diagnosis information
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Diagnosis instance identifier
Timing or nature of the diagnosis
Present on admission
Package billing code
Nature of illness or problem
Used in:
Patient insurance information
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Insurance instance identifier
Coverage to be used for adjudication
Pre-assigned Claim number
Insurance information
Additional provider contract number
Prior authorization reference number
Adjudication results
Product or service provided
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Item instance identifier
Applicable careTeam members
Applicable diagnoses
Applicable procedures
Applicable exception and supporting information
Revenue or cost center code
Benefit classification
Billing, service, product, or drug code
Product or service billing modifiers
Program the product or service is provided under
Count of products or services
Fee, charge or cost per item
Price scaling factor
Total item cost
Unique device identifier
Anatomical location
Anatomical sub-location
Encounters related to this billed item
Product or service provided
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Item instance identifier
Revenue or cost center code
Benefit classification
Billing, service, product, or drug code
Service/Product billing modifiers
Program the product or service is provided under
Count of products or services
Fee, charge or cost per item
Price scaling factor
Total item cost
Unique device identifier
Product or service provided
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Item instance identifier
Revenue or cost center code
Benefit classification
Billing, service, product, or drug code
Service/Product billing modifiers
Program the product or service is provided under
Count of products or services
Fee, charge or cost per item
Price scaling factor
Total item cost
Unique device identifier
Place of service or where product was supplied
Used in:
Date or dates of service or product delivery
Used in:
Recipient of benefits payable
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Category of recipient
Recipient reference
Clinical procedures performed
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Procedure instance identifier
Category of Procedure
When the procedure was performed
Unique device identifier
Specific clinical procedure
Used in:
Prior or corollary claims
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Reference to the related claim
How the reference claim is related
File or case reference
active | cancelled | draft | entered-in-error
Used in:
Supporting information
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Information instance identifier
Classification of the supplied information
Type of information
Explanation for the information
When it occurred
Used in:
Data to be provided
Used in:
claim | preauthorization | predetermination
Used in:
This value set includes Claim Processing Outcome codes. See http://hl7.org/fhir/remittance-outcome
(message has no fields)
Used in: , , , ,
Auto-generated from StructureDefinition for ClaimResponse. Response to a claim predetermination or preauthorization. See http://hl7.org/fhir/StructureDefinition/ClaimResponse
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier for a claim response
More granular claim type
More granular claim type
The recipient of the products and services
Response creation date
Party responsible for reimbursement
Party responsible for the claim
Id of resource triggering adjudication
Disposition Message
Preauthorization reference
Preauthorization reference effective period
Party to be paid any benefits payable
Header-level adjudication
Funds reserved status
Printed form identifier
Printed reference or actual form
Request for additional information
Insurer added line items
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Item sequence number
Detail sequence number
Subdetail sequence number
Authorized providers
Billing, service, product, or drug code
Service/Product billing modifiers
Program the product or service is provided under
Count of products or services
Fee, charge or cost per item
Price scaling factor
Total item cost
Anatomical location
Anatomical sub-location
Applicable note numbers
Added items adjudication
Insurer added line details
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Billing, service, product, or drug code
Service/Product billing modifiers
Count of products or services
Fee, charge or cost per item
Price scaling factor
Total item cost
Applicable note numbers
Added items detail adjudication
Insurer added line items
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Billing, service, product, or drug code
Service/Product billing modifiers
Count of products or services
Fee, charge or cost per item
Price scaling factor
Total item cost
Applicable note numbers
Added items detail adjudication
Place of service or where product was supplied
Used in:
Date or dates of service or product delivery
Used in:
Processing errors
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Item sequence number
Detail sequence number
Subdetail sequence number
Error code detailing processing issues
Patient insurance information
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Insurance instance identifier
Coverage to be used for adjudication
Insurance information
Additional provider contract number
Adjudication results
Adjudication for claim line items
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Claim item instance identifier
Applicable note numbers
Adjudication details
Used in: , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of adjudication information
Explanation of adjudication outcome
Monetary amount
Non-monetary value
Adjudication for claim details
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Claim detail instance identifier
Applicable note numbers
Detail level adjudication details
Adjudication for claim sub-details
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Claim sub-detail instance identifier
Applicable note numbers
Subdetail level adjudication details
Note concerning adjudication
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Note instance identifier
Note explanatory text
Language of the text
display | print | printoper
Used in:
queued | complete | error | partial
Used in:
Payment Details
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Partial or complete payment
Payment adjustment for non-claim issues
Explanation for the adjustment
Expected date of payment
Payable amount after adjustment
Business identifier for the payment
active | cancelled | draft | entered-in-error
Used in:
Adjudication totals
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of adjudication information
Financial total for the category
claim | preauthorization | predetermination
Used in:
Auto-generated from StructureDefinition for ClinicalImpression. A clinical assessment performed when planning treatments and management strategies for a patient. See http://hl7.org/fhir/StructureDefinition/ClinicalImpression
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business identifier
Reason for current status
Kind of assessment performed
Why/how the assessment was performed
Patient or group assessed
Encounter created as part of
When the assessment was documented
The clinician performing the assessment
Reference to last assessment
Relevant impressions of patient state
Clinical Protocol followed
Summary of the assessment
Estimate of likely outcome
RiskAssessment expressing likely outcome
Information supporting the clinical impression
Comments made about the ClinicalImpression
Time of assessment
Used in:
Possible or likely findings and diagnoses
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
What was found
What was found
Which investigations support finding
One or more sets of investigations (signs, symptoms, etc.)
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
A name/code for the set
Record of a specific investigation
in-progress | completed | entered-in-error
Used in:
Codes that reflect the current state of a clinical impression within its overall lifecycle. See http://hl7.org/fhir/ValueSet/clinicalimpression-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for code. Primitive Type code. See http://hl7.org/fhir/StructureDefinition/code
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Primitive value for code
xml:id (or equivalent in JSON)
Additional content defined by implementations
The degree to which the server supports the code search parameter on ValueSet, if it is supported. See http://hl7.org/fhir/code-search-support
(message has no fields)
Used in:
Auto-generated from StructureDefinition for CodeSystem. Declares the existence of and describes a code system or code system supplement. See http://hl7.org/fhir/StructureDefinition/CodeSystem
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
Additional identifier for the code system (business identifier)
Business version of the code system (Coding.version)
Name for this code system (computer friendly)
Name for this code system (human friendly)
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the code system
The context that the content is intended to support
Intended jurisdiction for code system (if applicable)
Why this code system is defined
Use and/or publishing restrictions
If code comparison is case sensitive
Canonical reference to the value set with entire code system
If code system defines a compositional grammar
If definitions are not stable
Canonical URL of Code System this adds designations and properties to
Total concepts in the code system
Concepts in the code system
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Code that identifies concept
Text to display to the user
Formal definition
Child Concepts (is-a/contains/categorizes)
Property value for the concept
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Reference to CodeSystem.property.code
Value of the property for this concept
Used in:
Additional representations for the concept
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Human language of the designation
Details how this designation would be used
The text value for this designation
not-present | example | fragment | complete | supplement
Used in:
Filter that can be used in a value set
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Code that identifies the filter
How or why the filter is used
What to use for the value
= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Used in:
grouped-by | is-a | part-of | classified-with
Used in:
Additional information supplied about each concept
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Identifies the property on the concepts, and when referred to in operations
Formal identifier for the property
Why the property is defined, and/or what it conveys
code | Coding | string | integer | boolean | dateTime | decimal
Used in:
draft | active | retired | unknown
Used in:
Auto-generated from StructureDefinition for alternate. Additional code for the concept. See http://hl7.org/fhir/StructureDefinition/codesystem-alternate
Unique id for inter-element referencing
Additional content defined by implementations
Code that represents the concept
Expected use of the code
Auto-generated from StructureDefinition for author. User or Org actually involved in creating the value set content. See http://hl7.org/fhir/StructureDefinition/codesystem-author
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for concept-comments. Comment about the use of this code in this context. See http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for conceptOrder. Appearance order for user selection. See http://hl7.org/fhir/StructureDefinition/codesystem-conceptOrder
Unique id for inter-element referencing
Value of extension
The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource. See http://hl7.org/fhir/codesystem-content-mode
(message has no fields)
Used in:
Auto-generated from StructureDefinition for effectiveDate. When the value set version becomes Active and is available for use. See http://hl7.org/fhir/StructureDefinition/codesystem-effectiveDate
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for expirationDate. When the value set version should no longer be used. See http://hl7.org/fhir/StructureDefinition/codesystem-expirationDate
Unique id for inter-element referencing
Value of extension
The meaning of the hierarchy of concepts in a code system. See http://hl7.org/fhir/codesystem-hierarchy-meaning
(message has no fields)
Used in:
Auto-generated from StructureDefinition for history. What has happened over time. See http://hl7.org/fhir/StructureDefinition/codesystem-history
Unique id for inter-element referencing
Additional content defined by implementations
The name of this set of history entries
Audit of all changes for a history entry
Used in:
Unique id for inter-element referencing
Date the change was made
Version marker after the change was made
Who made the change
Information about the change
Auto-generated from StructureDefinition for keyWord. Descriptors and key terms for search. See http://hl7.org/fhir/StructureDefinition/codesystem-keyWord
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for label. E.g. "(a)", "1.", etc. See http://hl7.org/fhir/StructureDefinition/codesystem-label
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for map. A concept map relevant to interpret this value set. See http://hl7.org/fhir/StructureDefinition/codesystem-map
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for otherName. Alternative names. See http://hl7.org/fhir/StructureDefinition/codesystem-otherName
Unique id for inter-element referencing
Additional content defined by implementations
Human readable, short and specific
Which name is preferred for this language
Auto-generated from StructureDefinition for replacedby. A code that replaces this. See http://hl7.org/fhir/StructureDefinition/codesystem-replacedby
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for sourceReference. Where did this content come from. See http://hl7.org/fhir/StructureDefinition/codesystem-sourceReference
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for trusted-expansion. Reference to a trusted expansion. See http://hl7.org/fhir/StructureDefinition/codesystem-trusted-expansion
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for usage. Who has used and how?. See http://hl7.org/fhir/StructureDefinition/codesystem-usage
Unique id for inter-element referencing
Additional content defined by implementations
A consumer of or client for the value set
Implementation/project/standard that uses value set
Auto-generated from StructureDefinition for warning. Extra warning about the correct use of the value set. See http://hl7.org/fhir/StructureDefinition/codesystem-warning
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for workflowStatus. Indicates the state of development of the value set. See http://hl7.org/fhir/StructureDefinition/codesystem-workflowStatus
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for CodeableConcept. Concept - reference to a terminology or just text. See http://hl7.org/fhir/StructureDefinition/CodeableConcept
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Code defined by a terminology system
Plain text representation of the concept
Auto-generated from StructureDefinition for Coding. A reference to a code defined by a terminology system. See http://hl7.org/fhir/StructureDefinition/Coding
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Identity of the terminology system
Version of the system - if relevant
Symbol in syntax defined by the system
Representation defined by the system
If this coding was chosen directly by the user
Auto-generated from StructureDefinition for sctdescid. SNOMED CT Description ID. See http://hl7.org/fhir/StructureDefinition/coding-sctdescid
Unique id for inter-element referencing
Value of extension
Specialization of Coding that drops the system and code fields. Fields that use this message must be annotated with fhir_inlined_coding_system and fhir_inlined_coding_code. TODO(b/244184211): autogenerate this.
Used in:
xml:id (or equivalent in JSON)
Additional Content defined by implementations
Version of the system - if relevant
Representation defined by the system
If this coding was chosen directly by the user
Auto-generated from StructureDefinition for Communication. A record of information transmitted from a sender to a receiver. See http://hl7.org/fhir/StructureDefinition/Communication
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Unique identifier
Instantiates FHIR protocol or definition
Instantiates external protocol or definition
Request fulfilled by this communication
Part of this action
Reply to
Reason for current status
Message category
A channel of communication
Focus of message
Description of the purpose/content
Resources that pertain to this communication
Encounter created as part of
When sent
When received
Message recipient
Message sender
Indication for message
Why was communication done?
Comments made about the communication
Message payload
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Message part content
Used in:
routine | urgent | asap | stat
Used in:
preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Used in:
Auto-generated from StructureDefinition for media. Attached media. See http://hl7.org/fhir/StructureDefinition/communication-media
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for CommunicationRequest. A request for information to be sent to a receiver. See http://hl7.org/fhir/StructureDefinition/CommunicationRequest
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Unique identifier
Fulfills plan or proposal
Request(s) replaced by this request
Composite request this is part of
Reason for current status
Message category
True if request is prohibiting action
A channel of communication
Focus of message
Resources that pertain to this communication request
Encounter created as part of
When request transitioned to being actionable
Who/what is requesting service
Message recipient
Message sender
Why is communication needed?
Why is communication needed?
Comments made about communication request
When scheduled
Used in:
Message payload
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Message part content
Used in:
routine | urgent | asap | stat
Used in:
draft | active | on-hold | revoked | completed | entered-in-error | unknown
Used in:
Auto-generated from StructureDefinition for initiatingLocation. Location where the CommunicationRequest was initiated. See http://hl7.org/fhir/StructureDefinition/communicationrequest-initiatingLocation
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for CompartmentDefinition. Compartment Definition for a resource. See http://hl7.org/fhir/StructureDefinition/CompartmentDefinition
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this compartment definition, represented as a URI (globally unique)
Business version of the compartment definition
Name for this compartment definition (computer friendly)
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the compartment definition
The context that the content is intended to support
Why this compartment definition is defined
Whether the search syntax is supported
Patient | Encounter | RelatedPerson | Practitioner | Device
Used in:
How a resource is related to the compartment
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Search Parameter Name, or chained parameters
Additional documentation about the resource and compartment
Name of resource type
Used in:
draft | active | retired | unknown
Used in:
Which type a compartment definition describes. See http://hl7.org/fhir/compartment-type
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for Composition. A set of resources composed into a single coherent clinical statement with clinical attestation. See http://hl7.org/fhir/StructureDefinition/Composition
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Version-independent identifier for the Composition
Kind of composition (LOINC if possible)
Categorization of Composition
Who and/or what the composition is about
Context of the Composition
Composition editing time
Who and/or what authored the composition
Human Readable name/title
Organization which maintains the composition
Attests to accuracy of composition
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
When the composition was attested
Who attested the composition
personal | professional | legal | official
Used in:
As defined by affinity domain
Used in:
The clinical service(s) being documented
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Code(s) that apply to the event being documented
The period covered by the documentation
The event(s) being documented
Relationships to other compositions/documents
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
replaces | transforms | signs | appends
Used in:
Target of the relationship
Used in:
Composition is broken into sections
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Label for section (e.g. for ToC)
Classification of section (recommended)
Who and/or what authored the section
Who/what the section is about, when it is not about the subject of composition
Text summary of the section, for human interpretation
Order of section entries
A reference to data that supports this section
Why the section is empty
Nested Section
working | snapshot | changes
Used in:
preliminary | final | amended | entered-in-error
Used in:
The way in which a person authenticated a composition. See http://hl7.org/fhir/composition-attestation-mode
(message has no fields)
Used in:
Auto-generated from StructureDefinition for otherConfidentiality. Additional confidentiality codes. See http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-otherConfidentiality
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for section-subject. Section has a different subject that it's container. See http://hl7.org/fhir/StructureDefinition/composition-section-subject
Unique id for inter-element referencing
Value of extension
The workflow/clinical status of the composition. See http://hl7.org/fhir/composition-status
(message has no fields)
Used in: , ,
Auto-generated from StructureDefinition for ValidityPeriod. Validity Period. See http://hl7.org/fhir/StructureDefinition/cqm-ValidityPeriod
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for versionNumber. Version-specific identifier for composition. See http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ConceptMap. A map from one set of concepts to one or more other concepts. See http://hl7.org/fhir/StructureDefinition/ConceptMap
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this concept map, represented as a URI (globally unique)
Additional identifier for the concept map
Business version of the concept map
Name for this concept map (computer friendly)
Name for this concept map (human friendly)
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the concept map
The context that the content is intended to support
Intended jurisdiction for concept map (if applicable)
Why this concept map is defined
Use and/or publishing restrictions
Same source and target systems
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Source system where concepts to be mapped are defined
Specific version of the code system
Target system that the concepts are to be mapped to
Specific version of the code system
Mappings for a concept from the source set
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Identifies element being mapped
Display for the code
Concept in target system for element
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Code that identifies the target element
Display for the code
Description of status/issues in mapping
Other concepts that this mapping also produces
relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
Used in:
Other elements required for this mapping (from context)
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Reference to property mapping depends on
Code System (if necessary)
Value of the referenced element
Display for the code (if value is a code)
What to do when there is no mapping for the source concept
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Fixed code when mode = fixed
Display for the code
canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped
provided | fixed | other-map
Used in:
The source value set that contains the concepts that are being mapped
Used in:
draft | active | retired | unknown
Used in:
The target value set which provides context for the mappings
Used in:
Auto-generated from StructureDefinition for bidirectional. Whether the map can be interpreted in reverse. See http://hl7.org/fhir/StructureDefinition/concept-bidirectional
Unique id for inter-element referencing
Value of extension
The degree of equivalence between concepts. See http://hl7.org/fhir/concept-map-equivalence
(message has no fields)
Used in: ,
Defines which action to take if there is no match in the group. See http://hl7.org/fhir/conceptmap-unmapped-mode
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Condition. Detailed information about conditions, problems or diagnoses. See http://hl7.org/fhir/StructureDefinition/Condition
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External Ids for this condition
active | recurrence | relapse | inactive | remission | resolved
unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
problem-list-item | encounter-diagnosis
Subjective severity of condition
Identification of the condition, problem or diagnosis
Anatomical location, if relevant
Who has the condition?
Encounter created as part of
Date record was first recorded
Who recorded the condition
Person who asserts this condition
Additional information about the Condition
When in resolution/remission
Used in:
Supporting evidence
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Manifestation/symptom
Supporting information found elsewhere
Estimated or actual date, date-time, or age
Used in:
Stage/grade, usually assessed formally
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Simple summary (disease specific)
Formal record of assessment
Kind of staging
Auto-generated from StructureDefinition for assertedDate. Date the condition was first asserted. See http://hl7.org/fhir/StructureDefinition/condition-assertedDate
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for basedOn. Fulfills plan, proposal or order. See http://hl7.org/fhir/StructureDefinition/event-basedOn
Unique id for inter-element referencing
Value of extension
Preferred value set for Condition Clinical Status. See http://terminology.hl7.org/CodeSystem/condition-clinical
(message has no fields)
Auto-generated from StructureDefinition for dueTo. Causes for this Condition. See http://hl7.org/fhir/StructureDefinition/condition-dueTo
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for occurredFollowing. Precedent for this Condition. See http://hl7.org/fhir/StructureDefinition/condition-occurredFollowing
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for outcome. A consequence of the Condition. See http://hl7.org/fhir/StructureDefinition/condition-outcome
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for related. Conditions associated with this condition. See http://hl7.org/fhir/StructureDefinition/condition-related
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ruledOut. Conditions ruled out for this condition. See http://hl7.org/fhir/StructureDefinition/condition-ruledOut
Unique id for inter-element referencing
Value of extension
The verification status to support or decline the clinical status of the condition or diagnosis. See http://terminology.hl7.org/CodeSystem/condition-ver-status
(message has no fields)
A code that indicates how the server supports conditional delete. See http://hl7.org/fhir/conditional-delete-status
(message has no fields)
Used in:
A code that indicates how the server supports conditional read. See http://hl7.org/fhir/conditional-read-status
(message has no fields)
Used in:
Indicates the degree of adherence to a specified behavior or capability expected for a system to be deemed conformant with a specification. See http://terminology.hl7.org/CodeSystem/conformance-expectation
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Consent. A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time. See http://hl7.org/fhir/StructureDefinition/Consent
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Identifier for this record (external references)
Which of the four areas this resource covers (extensible)
Classification of the consent statement - for indexing/retrieval
Who the consent applies to
When this Consent was created or indexed
Who is agreeing to the policy and rules
Custodian of the consent
Regulation that this consents to
Policies covered by this consent
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Enforcement source for policy
Specific policy covered by this consent
Constraints to the base Consent.policyRule
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Timeframe for this rule
Actions controlled by this rule
Security Labels that define affected resources
Context of activities covered by this rule
e.g. Resource Type, Profile, CDA, etc.
e.g. LOINC or SNOMED CT code, etc. in the content
Timeframe for data controlled by this rule
Nested Exception Rules
Who|what controlled by this rule (or group, by role)
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
How the actor is involved
Resource for the actor (or group, by role)
Data controlled by this rule
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The actual data reference
instance | related | dependents | authoredby
Used in:
deny | permit
Used in:
Source from which this consent is taken
Used in:
draft | proposed | active | rejected | inactive | entered-in-error
Used in:
Consent Verified by patient or family
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Has been verified
Person who verified
When consent verified
How a resource reference is interpreted when testing consent restrictions. See http://hl7.org/fhir/consent-data-meaning
(message has no fields)
Used in:
Auto-generated from StructureDefinition for location. A location specific constraint. See http://hl7.org/fhir/StructureDefinition/consent-location
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for NotificationEndpoint. Notification Endpoint. See http://hl7.org/fhir/StructureDefinition/consent-NotificationEndpoint
Unique id for inter-element referencing
Value of extension
How a rule statement is applied, such as adding additional consent or removing consent. See http://hl7.org/fhir/consent-provision-type
(message has no fields)
Used in:
Indicates the state of the consent. See http://hl7.org/fhir/consent-state-codes
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Transcriber. Transcribed consent. See http://hl7.org/fhir/StructureDefinition/consent-Transcriber
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Witness. Witness to Consent. See http://hl7.org/fhir/StructureDefinition/consent-Witness
Unique id for inter-element referencing
Value of extension
SHALL applications comply with this constraint? See http://hl7.org/fhir/constraint-severity
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for ContactDetail. Contact information. See http://hl7.org/fhir/StructureDefinition/ContactDetail
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Name of an individual to contact
Contact details for individual or organization
Auto-generated from StructureDefinition for ContactPoint. Details of a Technology mediated contact point (phone, fax, email, etc.). See http://hl7.org/fhir/StructureDefinition/ContactPoint
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
The actual contact point details
Specify preferred order of use (1 = highest)
Time period when the contact point was/is in use
phone | fax | email | pager | url | sms | other
Used in:
home | work | temp | old | mobile - purpose of this contact point
Used in:
Auto-generated from StructureDefinition for area. Area/zone/city code. See http://hl7.org/fhir/StructureDefinition/contactpoint-area
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for country. Country code as defined by the ITU. See http://hl7.org/fhir/StructureDefinition/contactpoint-country
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for extension. Number within private network. See http://hl7.org/fhir/StructureDefinition/contactpoint-extension
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for local. Local number that must always be dialled. See http://hl7.org/fhir/StructureDefinition/contactpoint-local
Unique id for inter-element referencing
Value of extension
Telecommunications form for contact point. See http://hl7.org/fhir/contact-point-system
(message has no fields)
Used in:
Auto-generated from StructureDefinition for TEL-address. RFC 3966 compliant telephone or fax number. See http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address
Unique id for inter-element referencing
Value of extension
Use of contact point. See http://hl7.org/fhir/contact-point-use
(message has no fields)
Used in:
Used in: ,
Auto-generated from StructureDefinition for Contract. Legal Agreement. See http://hl7.org/fhir/StructureDefinition/Contract
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Contract number
Basal definition
Business edition
Negotiation status
Source Contract Definition
External Contract Definition
Content derived from the basal information
When this Contract was issued
Effective time
Contract cessation cause
Contract Target Entity
Authority under which this Contract has standing
A sphere of control governed by an authoritative jurisdiction, organization, or person
Specific Location
Computer friendly designation
Human Friendly name
Subordinate Friendly name
Acronym or short name
Source of Contract
Range of Legal Concerns
Legal instrument category
Subtype within the context of type
Extra Information
Key event in Contract History
Computable Contract Language
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Computable Contract Rules
Used in:
Contract precursor content
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Content structure and use
Detailed Content Type Definition
Publisher Entity
When published
Publication Ownership
amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
Used in:
Contract Friendly Language
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Easily comprehended representation of this Contract
Used in:
Contract Legal Language
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Contract Legal Text
Used in:
Binding Contract
Used in:
Contract Signatory
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Contract Signatory Role
Contract Signatory Party
Contract Documentation Signature
amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
Used in:
Contract Term List
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Contract Term Number
Contract Term Issue Date Time
Contract Term Effective Time
Contract Term Type or Form
Contract Term Type specific classification
Term Statement
Nested Contract Term Group
Entity being ascribed responsibility
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
True if the term prohibits the action
Type or form of the action
Purpose for the Contract Term Action
Pointer to specific item
State of the action
Episode associated with action
Pointer to specific item
Who asked for action
Pointer to specific item
Kind of service performer
Competency of the performer
Actor that wil execute (or not) the action
Pointer to specific item
Why is action (not) needed?
Why is action (not) needed?
Why action is to be performed
Pointer to specific item
Comments about the action
Action restriction numbers
Entity of the action
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Entity of the action
Role type of the agent
When action happens
Used in:
Contract Term Asset List
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Range of asset
Asset category
Associated entities
Asset sub-category
Kinship of the asset
Quality desctiption of asset
Asset availability types
Time period of the asset
Time period
Asset clause or question text
Pointer to asset text
Response to assets
Asset restriction numbers
Circumstance of the asset
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Creator,custodian or owner
Codeable asset context
Context description
Contract Valued Item List
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Contract Valued Item Number
Contract Valued Item Effective Tiem
Count of Contract Valued Items
Contract Valued Item fee, charge, or cost
Contract Valued Item Price Scaling Factor
Contract Valued Item Difficulty Scaling Factor
Total Contract Valued Item Value
Terms of valuation
When payment is due
Who will make payment
Who will receive payment
Pointer to specific item
Security Labels that define affected terms
Contract Valued Item Type
Used in:
Context of the Contract term
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Offer business ID
Negotiable offer asset
Contract Offer Type or Form
Accepting party choice
How decision is conveyed
Human readable offer text
Pointer to text
Offer restriction numbers
Response to offer text
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The actual answer response
Used in:
Offer Recipient
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Referenced entity
Participant engagement type
Protection for the Term
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Link to Security Labels
Confidentiality Protection
Applicable Policy
Handling Instructions
Term Concern
Used in:
Focus of contract interest
Used in:
This value set contract specific codes for status. See http://hl7.org/fhir/contract-publicationstatus
(message has no fields)
Used in:
This value set contract specific codes for status. See http://hl7.org/fhir/contract-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Contributor. Contributor information. See http://hl7.org/fhir/StructureDefinition/Contributor
Used in: , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Who contributed the content
Contact details of the contributor
author | editor | reviewer | endorser
Used in:
The type of contributor. See http://hl7.org/fhir/contributor-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Count. A measured or measurable amount. See http://hl7.org/fhir/StructureDefinition/Count
Used in: , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Numerical value (with implicit precision)
Unit representation
System that defines coded unit form
Coded form of the unit
< | <= | >= | > - how to understand the value
Used in:
Auto-generated from StructureDefinition for Coverage. Insurance or medical plan or a payment agreement. See http://hl7.org/fhir/StructureDefinition/Coverage
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier for the coverage
Coverage category such as medical or accident
Owner of the policy
Subscriber to the policy
ID assigned to the subscriber
Plan beneficiary
Dependent number
Beneficiary relationship to the subscriber
Coverage start and end dates
Issuer of the policy
Relative order of the coverage
Insurer network
Reimbursement to insurer
Contract details
Additional coverage classifications
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of class such as 'group' or 'plan'
Value associated with the type
Human readable description of the type and value
Patient payments for services/products
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Cost category
Exceptions for patient payments
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Exception category
The effective period of the exception
The amount or percentage due from the beneficiary
Used in:
active | cancelled | draft | entered-in-error
Used in:
Auto-generated from StructureDefinition for CoverageEligibilityRequest. CoverageEligibilityRequest resource. See http://hl7.org/fhir/StructureDefinition/CoverageEligibilityRequest
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier for coverage eligiblity request
Desired processing priority
Intended recipient of products and services
Creation date
Author
Party responsible for the request
Coverage issuer
Servicing facility
Item to be evaluated for eligibiity
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Applicable exception or supporting information
Benefit classification
Billing, service, product, or drug code
Product or service billing modifiers
Perfoming practitioner
Count of products or services
Fee, charge or cost per item
Servicing facility
Product or service details
Applicable diagnosis
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Nature of illness or problem
Used in:
Patient insurance information
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Applicable coverage
Insurance information
Additional provider contract number
auth-requirements | benefits | discovery | validation
Used in:
Estimated date or dates of service
Used in:
active | cancelled | draft | entered-in-error
Used in:
Supporting information
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Information instance identifier
Data to be provided
Applies to all items
Auto-generated from StructureDefinition for CoverageEligibilityResponse. CoverageEligibilityResponse resource. See http://hl7.org/fhir/StructureDefinition/CoverageEligibilityResponse
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier for coverage eligiblity request
Intended recipient of products and services
Response creation date
Party responsible for the request
Eligibility request reference
Disposition Message
Coverage issuer
Preauthorization reference
Printed form identifier
Processing errors
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Error code detailing processing issues
Patient insurance information
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Insurance information
Coverage inforce indicator
When the benefits are applicable
Benefits and authorization details
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Benefit classification
Billing, service, product, or drug code
Product or service billing modifiers
Performing practitioner
Excluded from the plan
Short name for the benefit
Description of the benefit or services covered
In or out of network
Individual or family
Annual or lifetime
Authorization required flag
Type of required supporting materials
Preauthorization requirements endpoint
Benefit Summary
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Benefit classification
Benefits allowed
Used in:
Benefits used
Used in:
queued | complete | error | partial
Used in:
auth-requirements | benefits | discovery | validation
Used in:
Estimated date or dates of service
Used in:
active | cancelled | draft | entered-in-error
Used in:
Auto-generated from StructureDefinition for expression. An dynamic expression. See http://hl7.org/fhir/StructureDefinition/cqf-expression
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for library. A library containing logic used by the artifact. See http://hl7.org/fhir/StructureDefinition/cqf-library
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Data Absent Reason. unknown | asked | temp | notasked | masked | unsupported | astext | error. See http://hl7.org/fhir/StructureDefinition/data-absent-reason
Unique id for inter-element referencing
Value of extension
Used in:
Used to specify why the normally expected content of the data element is missing. See http://terminology.hl7.org/CodeSystem/data-absent-reason
(message has no fields)
Used in:
Auto-generated from StructureDefinition for DataRequirement. Describes a required data item. See http://hl7.org/fhir/StructureDefinition/DataRequirement
Used in: , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
The profile of the required data
Indicates specific structure elements that are referenced by the knowledge module
Number of results
What codes are expected
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
A code-valued attribute to filter on
A coded (token) parameter to search on
Valueset for the filter
What code is expected
What dates/date ranges are expected
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
A date-valued attribute to filter on
A date valued parameter to search on
The value of the filter, as a Period, DateTime, or Duration value
Used in:
Order of the results
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
The name of the attribute to perform the sort
ascending | descending
Used in:
E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Used in:
The type of the required data
Used in:
A version specific list of the data types defined by the FHIR specification for use as an element type (any of the FHIR defined data types). See http://hl7.org/fhir/data-types
(message has no fields)
Used in:
Auto-generated from StructureDefinition for date. Primitive Type date. See http://hl7.org/fhir/StructureDefinition/date
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
The absolute time of the event as a Unix epoch in microseconds.
The local timezone in which the event was recorded.
xml:id (or equivalent in JSON)
Additional content defined by implementations
Used in:
Auto-generated from StructureDefinition for dateTime. Primitive Type dateTime. See http://hl7.org/fhir/StructureDefinition/dateTime
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
The absolute time of the event as a Unix epoch in microseconds.
The local timezone in which the event was recorded.
xml:id (or equivalent in JSON)
Additional content defined by implementations
Used in:
Auto-generated from StructureDefinition for Timezone Offset. Timezone offset, for dates (no timezone in date). See http://hl7.org/fhir/StructureDefinition/tz-offset
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for daysOfCycle. Days on which the action should be performed. See http://hl7.org/fhir/StructureDefinition/timing-daysOfCycle
Unique id for inter-element referencing
Additional content defined by implementations
What day to perform
The days of the week. See http://hl7.org/fhir/days-of-week
(message has no fields)
Used in: , , , , ,
Auto-generated from StructureDefinition for decimal. Primitive Type decimal. See http://hl7.org/fhir/StructureDefinition/decimal
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Primitive value for decimal
xml:id (or equivalent in JSON)
Additional content defined by implementations
Auto-generated from StructureDefinition for precision. Explicit precision (number of significant decimal places). See http://hl7.org/fhir/StructureDefinition/quantity-precision
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Design Note. Design comments. See http://hl7.org/fhir/StructureDefinition/designNote
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for DetectedIssue. Clinical issue with action. See http://hl7.org/fhir/StructureDefinition/DetectedIssue
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Unique id for the detected issue
Issue Category, e.g. drug-drug, duplicate therapy, etc.
Associated patient
The provider or device that identified the issue
Problem resource
Description and context
Authority for issue
Supporting evidence
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Manifestation
Supporting information
When identified
Used in:
Step taken to address
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
What mitigation?
Date committed
Who is committing?
high | moderate | low
Used in:
registered | preliminary | final | amended +
Used in:
Indicates the potential degree of impact of the identified issue on the patient. See http://hl7.org/fhir/detectedissue-severity
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Device. Item used in healthcare. See http://hl7.org/fhir/StructureDefinition/Device
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Instance identifier
The reference to the definition for the device
online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
The distinct identification string
Name of device manufacturer
Date when the device was made
Date and time of expiry of this device (if applicable)
Lot number of manufacture
Serial number assigned by the manufacturer
The model number for the device
The part number of the device
The kind or type of device
Patient to whom Device is affixed
Organization responsible for device
Details for human/organization for support
Where the device is found
Network address to contact device
Device notes and comments
Safety Characteristics of Device
The parent device
The name of the device as given by the manufacturer
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The name of the device
udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Used in:
The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
Property value as a quantity
Property value as a code, e.g., NTP4 (synced to NTP)
The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The standard that is used to operate and communicate
The version of the standard that is used to operate and communicate
active | inactive | entered-in-error | unknown
Used in:
Unique Device Identifier (UDI) Barcode string
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Mandatory fixed portion of UDI
UDI Issuing Organization
Regional UDI authority
UDI Machine Readable Barcode String
UDI Human Readable Barcode String
barcode | rfid | manual +
Used in:
The actual design of the device or software version running on the device
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The type of the device version
A single component of the device version
The version text
Auto-generated from StructureDefinition for DeviceDefinition. An instance of a medical-related component of a medical device. See http://hl7.org/fhir/StructureDefinition/DeviceDefinition
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Instance identifier
The model number for the device
What kind of device or device system this is
Available versions
Safety characteristics of the device
Shelf Life and storage information
Dimensions, color etc.
Language code for the human-readable text strings produced by the device (all supported)
Organization responsible for device
Details for human/organization for support
Network address to contact device
Access to on-line information
Device notes and comments
The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product)
The parent device it can be part of
Device capabilities
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of capability
Description of capability
A name given to the device to identify it
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The name of the device
udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
Used in:
Name of device manufacturer
Used in:
A substance used to create the material(s) of which the device is made
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The substance
Indicates an alternative material of the device
Whether the substance is a known or suspected allergen
The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
Property value as a quantity
Property value as a code, e.g., NTP4 (synced to NTP)
The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The standard that is used to operate and communicate
The version of the standard that is used to operate and communicate
Unique Device Identifier (UDI) Barcode string
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
The organization that assigns the identifier algorithm
The jurisdiction to which the deviceIdentifier applies
Auto-generated from StructureDefinition for implantStatus. Implant Status. See http://hl7.org/fhir/StructureDefinition/device-implantStatus
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for DeviceMetric. Measurement, calculation or setting capability of a medical device. See http://hl7.org/fhir/StructureDefinition/DeviceMetric
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Instance identifier
Identity of metric, for example Heart Rate or PEEP Setting
Unit of Measure for the Metric
Describes the link to the source Device
Describes the link to the parent Device
Describes the measurement repetition time
Describes the calibrations that have been performed or that are required to be performed
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Describes the time last calibration has been performed
not-calibrated | calibration-required | calibrated | unspecified
Used in:
unspecified | offset | gain | two-point
Used in:
measurement | setting | calculation | unspecified
Used in:
black | red | green | yellow | blue | magenta | cyan | white
Used in:
on | off | standby | entered-in-error
Used in:
Describes the state of a metric calibration. See http://hl7.org/fhir/metric-calibration-state
(message has no fields)
Used in:
Describes the type of a metric calibration. See http://hl7.org/fhir/metric-calibration-type
(message has no fields)
Used in:
Describes the category of the metric. See http://hl7.org/fhir/metric-category
(message has no fields)
Used in:
Describes the typical color of representation. See http://hl7.org/fhir/metric-color
(message has no fields)
Used in:
Describes the operational status of the DeviceMetric. See http://hl7.org/fhir/metric-operational-status
(message has no fields)
Used in:
The type of name the device is referred by. See http://hl7.org/fhir/device-nametype
(message has no fields)
Used in: , ,
Auto-generated from StructureDefinition for DeviceRequest. Medical device request. See http://hl7.org/fhir/StructureDefinition/DeviceRequest
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External Request identifier
Instantiates FHIR protocol or definition
Instantiates external protocol or definition
What request fulfills
What request replaces
Identifier of composite request
Focus of request
Encounter motivating request
When recorded
Who/what is requesting diagnostics
Filler role
Requested Filler
Coded Reason for request
Linked Reason for request
Associated insurance coverage
Additional clinical information
Notes or comments
Request provenance
Device requested
Used in:
proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Used in:
Desired time or schedule for use
Used in:
Device details
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Device detail
Value of detail
Used in:
routine | urgent | asap | stat
Used in:
draft | active | on-hold | revoked | completed | entered-in-error | unknown
Used in:
Auto-generated from StructureDefinition for patientInstruction. Patient Friendly Insructions. See http://hl7.org/fhir/StructureDefinition/devicerequest-patientInstruction
Unique id for inter-element referencing
Additional content defined by implementations
Language
Text
Auto-generated from StructureDefinition for DeviceUseStatement. Record of use of a device. See http://hl7.org/fhir/StructureDefinition/DeviceUseStatement
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External identifier for this record
Fulfills plan, proposal or order
Patient using device
Supporting information
When statement was recorded
Who made the statement
Reference to device used
Why device was used
Why was DeviceUseStatement performed?
Target body site
Addition details (comments, instructions)
active | completed | entered-in-error +
Used in:
How often the device was used
Used in:
A coded concept indicating the current status of the Device Usage. See http://hl7.org/fhir/device-statement-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for DiagnosticReport. A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports. See http://hl7.org/fhir/StructureDefinition/DiagnosticReport
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business identifier for report
What was requested
Service category
Name/Code for this diagnostic report
The subject of the report - usually, but not always, the patient
Health care event when test ordered
DateTime this version was made
Responsible Diagnostic Service
Primary result interpreter
Specimens this report is based on
Observations
Reference to full details of imaging associated with the diagnostic report
Clinical conclusion (interpretation) of test results
Codes for the clinical conclusion of test results
Entire report as issued
Clinically relevant time/time-period for report
Used in:
Key images associated with this report
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Comment about the image (e.g. explanation)
Reference to the image source
registered | partial | preliminary | final +
Used in:
Auto-generated from StructureDefinition for addendumOf. Additional or Supplement Content. See http://hl7.org/fhir/StructureDefinition/diagnosticReport-addendumOf
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for allele-database. Allele Database. See http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-allele-database
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Analysis. Analysis. See http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsAnalysis
Unique id for inter-element referencing
Additional content defined by implementations
Analysis type
Analysis interpretation
Auto-generated from StructureDefinition for AssessedCondition. AssessedCondition. See http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsAssessedCondition
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for extends. Related reports. See http://hl7.org/fhir/StructureDefinition/diagnosticReport-extends
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for FamilyMemberHistory. FamilyHistory. See http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsFamilyMemberHistory
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for glstring. glstring. See http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-glstring
Unique id for inter-element referencing
Additional content defined by implementations
glstring.url
glstring.text
Auto-generated from StructureDefinition for haploid. haploid. See http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-haploid
Unique id for inter-element referencing
Additional content defined by implementations
haploid-locus
haploid-type
haploid-method
Auto-generated from StructureDefinition for Item. The items the orderer requested. See http://hl7.org/fhir/StructureDefinition/servicerequest-geneticsItem
Unique id for inter-element referencing
Additional content defined by implementations
Code to indicate the item (test, panel or sequence variant) being ordered
Indicate the genetic variant ordered to be tested
If this item relates to specific specimens
proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed
Auto-generated from StructureDefinition for locationPerformed. Location Performed. See http://hl7.org/fhir/StructureDefinition/diagnosticReport-locationPerformed
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for method. The platform, methodology and software applied at the time of the genotyping. See http://hl7.org/fhir/StructureDefinition/hla-genotyping-results-method
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for References. Additional bibliographic reference information. See http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsReferences
Unique id for inter-element referencing
Additional content defined by implementations
Reference description
Reference URI
Reference type
Auto-generated from StructureDefinition for replaces. Replacement for another report. See http://hl7.org/fhir/StructureDefinition/diagnosticReport-replaces
Unique id for inter-element referencing
Value of extension
The status of the diagnostic report. See http://hl7.org/fhir/diagnostic-report-status
(message has no fields)
Used in: , ,
Auto-generated from StructureDefinition for summaryOf. Summary Of Other Reports. See http://hl7.org/fhir/StructureDefinition/diagnosticReport-summaryOf
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for directedBy. Who has decision-making authority. See http://hl7.org/fhir/StructureDefinition/procedure-directedBy
Unique id for inter-element referencing
Value of extension
Used in:
How an element value is interpreted when discrimination is evaluated. See http://hl7.org/fhir/discriminator-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Distance. A length - a value with a unit that is a physical distance. See http://hl7.org/fhir/StructureDefinition/Distance
Used in: , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Numerical value (with implicit precision)
Unit representation
System that defines coded unit form
Coded form of the unit
< | <= | >= | > - how to understand the value
Used in:
Auto-generated from StructureDefinition for DocumentManifest. A list that defines a set of documents. See http://hl7.org/fhir/StructureDefinition/DocumentManifest
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Unique Identifier for the set of documents
Other identifiers for the manifest
Kind of document set
The subject of the set of documents
When this document manifest created
Who and/or what authored the DocumentManifest
Intended to get notified about this set of documents
The source system/application/software
Human-readable description (title)
Items in manifest
Related things
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Identifiers of things that are related
Related Resource
current | superseded | entered-in-error
Used in:
Whether the application produces or consumes documents. See http://hl7.org/fhir/document-mode
(message has no fields)
Used in:
Auto-generated from StructureDefinition for DocumentReference. A reference to a document. See http://hl7.org/fhir/StructureDefinition/DocumentReference
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Master Version Specific Identifier
Other identifiers for the document
Kind of document (LOINC if possible)
Categorization of document
Who/what is the subject of the document
When this document reference was created
Who and/or what authored the document
Who/what authenticated the document
Organization which maintains the document
Human-readable description
Document security-tags
Document referenced
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Where to access the document
Format/content rules for the document
Clinical context of document
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Context of the document content
Main clinical acts documented
Time of service that is being documented
Kind of facility where patient was seen
Additional details about where the content was created (e.g. clinical specialty)
Patient demographics from source
Related identifiers or resources
preliminary | final | amended | entered-in-error
Used in:
Relationships to other documents
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Target of the relationship
replaces | transforms | signs | appends
Used in:
current | superseded | entered-in-error
Used in:
The status of the document reference. See http://hl7.org/fhir/document-reference-status
(message has no fields)
Used in: , ,
The type of relationship between documents. See http://hl7.org/fhir/document-relationship-type
(message has no fields)
Used in: , ,
Auto-generated from StructureDefinition for DomainResource. A resource with narrative, extensions, and contained resources. See http://hl7.org/fhir/StructureDefinition/DomainResource
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Auto-generated from StructureDefinition for Dosage. How the medication is/was taken or should be taken. See http://hl7.org/fhir/StructureDefinition/Dosage
Used in: , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The order of the dosage instructions
Free text dosage instructions e.g. SIG
Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Patient or consumer oriented instructions
When medication should be administered
Body site to administer to
How drug should enter body
Technique for administering medication
Upper limit on medication per unit of time
Upper limit on medication per administration
Upper limit on medication per lifetime of the patient
Take "as needed" (for x)
Used in:
Amount of medication administered
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
The kind of dose or rate specified
Amount of medication per dose
Used in:
Amount of medication per unit of time
Used in:
Auto-generated from StructureDefinition for Duration. A length of time. See http://hl7.org/fhir/StructureDefinition/Duration
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Numerical value (with implicit precision)
Unit representation
System that defines coded unit form
Coded form of the unit
< | <= | >= | > - how to understand the value
Used in:
Auto-generated from StructureDefinition for EffectEvidenceSynthesis. A quantified estimate of effect based on a body of evidence. See http://hl7.org/fhir/StructureDefinition/EffectEvidenceSynthesis
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this effect evidence synthesis, represented as a URI (globally unique)
Additional identifier for the effect evidence synthesis
Business version of the effect evidence synthesis
Name for this effect evidence synthesis (computer friendly)
Name for this effect evidence synthesis (human friendly)
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the effect evidence synthesis
Used for footnotes or explanatory notes
The context that the content is intended to support
Intended jurisdiction for effect evidence synthesis (if applicable)
Use and/or publishing restrictions
When the effect evidence synthesis was approved by publisher
When the effect evidence synthesis was last reviewed
When the effect evidence synthesis is expected to be used
The category of the EffectEvidenceSynthesis, such as Education, Treatment, Assessment, etc.
Who authored the content
Who edited the content
Who reviewed the content
Who endorsed the content
Additional documentation, citations, etc.
Type of synthesis
Type of study
What population?
What exposure?
What comparison exposure?
What outcome?
How certain is the effect
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Certainty rating
Used for footnotes or explanatory notes
A component that contributes to the overall certainty
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of subcomponent of certainty rating
Subcomponent certainty rating
Used for footnotes or explanatory notes
What was the estimated effect
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Description of effect estimate
Type of efffect estimate
Variant exposure states
Point estimate
What unit is the outcome described in?
How precise the estimate is
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of precision estimate
Level of confidence interval
Lower bound
Upper bound
What was the result per exposure?
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Description of results by exposure
Variant exposure states
Risk evidence synthesis
exposure | exposure-alternative
Used in:
What sample size was involved?
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Description of sample size
How many studies?
How many participants?
draft | active | retired | unknown
Used in:
Auto-generated from StructureDefinition for effectivePeriod. The effective date range for the resource. See http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Element. Base for all elements. See http://hl7.org/fhir/StructureDefinition/Element
Unique id for inter-element referencing
Additional content defined by implementations
Auto-generated from StructureDefinition for ElementDefinition. Definition of an element in a resource or extension. See http://hl7.org/fhir/StructureDefinition/ElementDefinition
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Path of the element in the hierarchy of elements
Name for this particular element (in a set of slices)
If this slice definition constrains an inherited slice definition (or not)
Name for element to display with or prompt for element
Corresponding codes in terminologies
Concise definition for space-constrained presentation
Full formal definition as narrative text
Comments about the use of this element
Why this resource has been created
Other names
Minimum Cardinality
Maximum Cardinality (a number or *)
Reference to definition of content for the element
Implicit meaning when this element is missing
What the order of the elements means
Max length for strings
Reference to invariant about presence
If the element must be supported
If this modifies the meaning of other elements
Reason that this element is marked as a modifier
Include when _summary = true?
Base definition information for tools
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Path that identifies the base element
Min cardinality of the base element
Max cardinality of the base element
Condition that must evaluate to true
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Target of 'condition' reference above
Why this constraint is necessary or appropriate
Human description of constraint
FHIRPath expression of constraint
XPath expression of constraint
Reference to original source of constraint
error | warning
Used in:
Specified value if missing from instance
Used in:
ValueSet details if this is coded
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Human explanation of the value set
Source of value set
required | extensible | preferred | example
Used in:
Example value (as defined for type)
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Describes the purpose of this example
Value of Example (one of allowed types)
Used in:
Value must be exactly this
Used in:
Map element to another set of definitions
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Reference to mapping declaration
Details of the mapping
Comments about the mapping or its use
Computable language of mapping
Used in:
This valueset is not enumerable, and so is represented as a string.
Maximum Allowed Value (for some types)
Used in:
Minimum Allowed Value (for some types)
Used in:
Value must have at least these property values
Used in:
xmlAttr | xmlText | typeAttr | cdaText | xhtml
Used in:
This element is sliced - slices follow
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Text description of how slicing works (or not)
If elements must be in same order as slices
Element values that are used to distinguish the slices
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Path to element value
value | exists | pattern | type | profile
Used in:
closed | open | openAtEnd
Used in:
Data type and Profile for this element
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Data type or Resource (reference to definition)
Profiles (StructureDefinition or IG) - one must apply
Profile (StructureDefinition or IG) on the Reference/canonical target - one must apply
contained | referenced | bundled - how aggregated
Used in:
either | independent | specific
Used in:
Auto-generated from StructureDefinition for allowedUnits. Units to use for measured value. See http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for bestpractice. Mark a warning invariant as 'best practice'. See http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for bestpractice-explanation. Explains why an invariant is labelled as best practice. See http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for bindingName. Suggested Name for code generation. See http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for display-hint. Hinting information for the narrative generator. See http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for equivalence. equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint. See http://hl7.org/fhir/StructureDefinition/elementdefinition-equivalence
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for explicit-type-name. Advisory - name of Type for implementations. See http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for fhir-type. FHIR type for value property - when a simple system type. See http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for hierarchy. Whether a circular reference is allowed to (transitively) point back to the same instance. See http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for identifier. External Identifier associated with this element. See http://hl7.org/fhir/StructureDefinition/elementdefinition-identifier
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for inheritedExtensibleValueSet. An extensible Value Set specified in a parent profile. See http://hl7.org/fhir/StructureDefinition/elementdefinition-inheritedExtensibleValueSet
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for isCommonBinding. Whether used on multiple resources. See http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for maxValueSet. Maximum Value Set (when strength = extensible). See http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for minValueSet. Minimum Value Set (what system must support). See http://hl7.org/fhir/StructureDefinition/elementdefinition-minValueSet
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for objectClass. Object Class. See http://hl7.org/fhir/StructureDefinition/11179-objectClass
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for objectClassProperty. Object Class Property. See http://hl7.org/fhir/StructureDefinition/11179-objectClassProperty
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for profile-element. Specific element for profile (for backbone elements). See http://hl7.org/fhir/StructureDefinition/elementdefinition-profile-element
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for question. Prompt for element phrased as question. See http://hl7.org/fhir/StructureDefinition/elementdefinition-question
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for selector. FHIRPath that defines the selection criteria for a slice. See http://hl7.org/fhir/StructureDefinition/elementdefinition-selector
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for translatable. Whether translations apply to this element. See http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable
Unique id for inter-element referencing
Value of extension
A code specifying the types of information being requested. See http://hl7.org/fhir/eligibilityrequest-purpose
(message has no fields)
Used in:
A code specifying the types of information being requested. See http://hl7.org/fhir/eligibilityresponse-purpose
(message has no fields)
Used in:
Controls how multiple enableWhen values are interpreted - whether all or any must be true. See http://hl7.org/fhir/questionnaire-enable-behavior
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Encounter. An interaction during which services are provided to the patient. See http://hl7.org/fhir/StructureDefinition/Encounter
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Identifier(s) by which this encounter is known
Classification of patient encounter
Specific type of encounter
Specific type of service
Indicates the urgency of the encounter
The patient or group present at the encounter
Episode(s) of care that this encounter should be recorded against
The ServiceRequest that initiated this encounter
The appointment that scheduled this encounter
The start and end time of the encounter
Quantity of time the encounter lasted (less time absent)
Coded reason the encounter takes place
Reason the encounter takes place (reference)
The set of accounts that may be used for billing for this Encounter
The organization (facility) responsible for this encounter
Another Encounter this encounter is part of
List of past encounter classes
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
inpatient | outpatient | ambulatory | emergency +
The time that the episode was in the specified class
The list of diagnosis relevant to this encounter
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The diagnosis or procedure relevant to the encounter
Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Ranking of the diagnosis (for each role type)
Details about the admission to a healthcare service
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Pre-admission identifier
The location/organization from which the patient came before admission
From where patient was admitted (physician referral, transfer)
The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Diet preferences reported by the patient
Special courtesies (VIP, board member)
Wheelchair, translator, stretcher, etc.
Location/organization to which the patient is discharged
Category or kind of location after discharge
List of locations where the patient has been
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Location the encounter takes place
The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Time period during which the patient was present at the location
planned | active | reserved | completed
Used in:
List of participants involved in the encounter
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Role of participant in encounter
Period of time during the encounter that the participant participated
Persons involved in the encounter other than the patient
planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Used in:
List of past encounter statuses
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The time that the episode was in the specified status
planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Used in:
Auto-generated from StructureDefinition for associatedEncounter. Associated Encounter. See http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
Unique id for inter-element referencing
Value of extension
The status of the location. See http://hl7.org/fhir/encounter-location-status
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for modeOfArrival. The method of arrival of the patient into the facility. See http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for reasonCancelled. Explanation for cancellation. See http://hl7.org/fhir/StructureDefinition/encounter-reasonCancelled
Unique id for inter-element referencing
Value of extension
Current state of the encounter. See http://hl7.org/fhir/encounter-status
(message has no fields)
Used in: , , ,
Auto-generated from StructureDefinition for Endpoint. The technical details of an endpoint that can be used for electronic services. See http://hl7.org/fhir/StructureDefinition/Endpoint
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Identifies this endpoint across multiple systems
Protocol/Profile/Standard to be used with this endpoint connection
A name that this endpoint can be identified by
Organization that manages this endpoint (might not be the organization that exposes the endpoint)
Contact details for source (e.g. troubleshooting)
Interval the endpoint is expected to be operational
The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
The technical base address for connecting to this endpoint
Usage depends on the channel type
Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Used in:
This valueset is not enumerable, and so is represented as a string.
active | suspended | error | off | entered-in-error | test
Used in:
The status of the endpoint. See http://hl7.org/fhir/endpoint-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for EnrollmentRequest. Enroll in coverage. See http://hl7.org/fhir/StructureDefinition/EnrollmentRequest
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier
Creation date
Target
Responsible practitioner
The subject to be enrolled
Insurance information
active | cancelled | draft | entered-in-error
Used in:
Auto-generated from StructureDefinition for EnrollmentResponse. EnrollmentResponse resource. See http://hl7.org/fhir/StructureDefinition/EnrollmentResponse
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier
Claim reference
Disposition Message
Creation date
Insurer
Responsible practitioner
queued | complete | error | partial
Used in:
active | cancelled | draft | entered-in-error
Used in:
A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. See http://hl7.org/fhir/ValueSet/name-part-qualifier
(message has no fields)
Used in:
Auto-generated from StructureDefinition for entryFormat. User prompt for format. See http://hl7.org/fhir/StructureDefinition/entryFormat
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for EpisodeOfCare. An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility. See http://hl7.org/fhir/StructureDefinition/EpisodeOfCare
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier(s) relevant for this EpisodeOfCare
Type/class - e.g. specialist referral, disease management
The patient who is the focus of this episode of care
Organization that assumes care
Interval during responsibility is assumed
Originating Referral Request(s)
Care manager/care coordinator for the patient
Other practitioners facilitating this episode of care
The set of accounts that may be used for billing for this EpisodeOfCare
The list of diagnosis relevant to this episode of care
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Conditions/problems/diagnoses this episode of care is for
Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …)
Ranking of the diagnosis (for each role type)
planned | waitlist | active | onhold | finished | cancelled | entered-in-error
Used in:
Past list of status codes (the current status may be included to cover the start date of the status)
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Duration the EpisodeOfCare was in the specified status
planned | waitlist | active | onhold | finished | cancelled | entered-in-error
Used in:
Auto-generated from StructureDefinition for episodeOfCare. Associated Encounter episode of care. See http://hl7.org/fhir/StructureDefinition/workflow-episodeOfCare
Unique id for inter-element referencing
Value of extension
The status of the episode of care. See http://hl7.org/fhir/episode-of-care-status
(message has no fields)
Used in: ,
The mode of a message capability statement. See http://hl7.org/fhir/event-capability-mode
(message has no fields)
Used in:
Auto-generated from StructureDefinition for EventDefinition. A description of when an event can occur. See http://hl7.org/fhir/StructureDefinition/EventDefinition
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this event definition, represented as a URI (globally unique)
Additional identifier for the event definition
Business version of the event definition
Name for this event definition (computer friendly)
Name for this event definition (human friendly)
Subordinate title of the event definition
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the event definition
The context that the content is intended to support
Intended jurisdiction for event definition (if applicable)
Why this event definition is defined
Describes the clinical usage of the event definition
Use and/or publishing restrictions
When the event definition was approved by publisher
When the event definition was last reviewed
When the event definition is expected to be used
E.g. Education, Treatment, Assessment, etc.
Who authored the content
Who edited the content
Who reviewed the content
Who endorsed the content
Additional documentation, citations, etc.
"when" the event occurs (multiple = 'or')
draft | active | retired | unknown
Used in:
Type of individual the event definition is focused on
Used in:
Auto-generated from StructureDefinition for eventHistory. Events of interest in the resource lifecycle. See http://hl7.org/fhir/StructureDefinition/event-eventHistory
Unique id for inter-element referencing
Value of extension
Codes identifying the lifecycle stage of an event. See http://hl7.org/fhir/event-status
(message has no fields)
Used in: , , ,
Real world event relating to the schedule. See http://hl7.org/fhir/event-timing
(message has no fields)
Real world event relating to the schedule. See http://hl7.org/fhir/ValueSet/event-timing
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Evidence. A research context or question. See http://hl7.org/fhir/StructureDefinition/Evidence
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this evidence, represented as a URI (globally unique)
Additional identifier for the evidence
Business version of the evidence
Name for this evidence (computer friendly)
Name for this evidence (human friendly)
Title for use in informal contexts
Subordinate title of the Evidence
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the evidence
Used for footnotes or explanatory notes
The context that the content is intended to support
Intended jurisdiction for evidence (if applicable)
Use and/or publishing restrictions
When the evidence was approved by publisher
When the evidence was last reviewed
When the evidence is expected to be used
The category of the Evidence, such as Education, Treatment, Assessment, etc.
Who authored the content
Who edited the content
Who reviewed the content
Who endorsed the content
Additional documentation, citations, etc.
What population?
What exposure?
What outcome?
draft | active | retired | unknown
Used in:
Auto-generated from StructureDefinition for EvidenceVariable. A population, intervention, or exposure definition. See http://hl7.org/fhir/StructureDefinition/EvidenceVariable
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this evidence variable, represented as a URI (globally unique)
Additional identifier for the evidence variable
Business version of the evidence variable
Name for this evidence variable (computer friendly)
Name for this evidence variable (human friendly)
Title for use in informal contexts
Subordinate title of the EvidenceVariable
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the evidence variable
Used for footnotes or explanatory notes
The context that the content is intended to support
Intended jurisdiction for evidence variable (if applicable)
Use and/or publishing restrictions
When the evidence variable was approved by publisher
When the evidence variable was last reviewed
When the evidence variable is expected to be used
The category of the EvidenceVariable, such as Education, Treatment, Assessment, etc.
Who authored the content
Who edited the content
Who reviewed the content
Who endorsed the content
Additional documentation, citations, etc.
What defines the members of the evidence element
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Natural language description of the characteristic
What code/value pairs define members?
Whether the characteristic includes or excludes members
Observation time from study start
What code or expression defines members?
Used in:
mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
Used in:
What time period do participants cover
Used in:
draft | active | retired | unknown
Used in:
dichotomous | continuous | descriptive
Used in:
The possible types of variables for exposures or outcomes (E.g. Dichotomous, Continuous, Descriptive). See http://hl7.org/fhir/variable-type
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for ExampleScenario. Example of workflow instance. See http://hl7.org/fhir/StructureDefinition/ExampleScenario
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this example scenario, represented as a URI (globally unique)
Additional identifier for the example scenario
Business version of the example scenario
Name for this example scenario (computer friendly)
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
The context that the content is intended to support
Intended jurisdiction for example scenario (if applicable)
Use and/or publishing restrictions
The purpose of the example, e.g. to illustrate a scenario
Another nested workflow
Actor participating in the resource
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
ID or acronym of the actor
The name of the actor as shown in the page
The description of the actor
person | entity
Used in:
Each resource and each version that is present in the workflow
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The id of the resource for referencing
A short name for the resource instance
Human-friendly description of the resource instance
Resources contained in the instance
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Each resource contained in the instance
A specific version of a resource contained in the instance
The type of the resource
Used in:
A specific version of the resource
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The identifier of a specific version of a resource
The description of the resource version
Each major process - a group of operations
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The diagram title of the group of operations
A longer description of the group of operations
Description of initial status before the process starts
Description of final status after the process ends
Each step of the process
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Nested process
If there is a pause in the flow
Alternate non-typical step action
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Label for alternative
A human-readable description of each option
What happens in each alternative option
Each interaction or action
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The sequential number of the interaction
The type of operation - CRUD
The human-friendly name of the interaction
Who starts the transaction
Who receives the transaction
A comment to be inserted in the diagram
Whether the initiator is deactivated right after the transaction
Whether the receiver is deactivated right after the transaction
Each resource instance used by the initiator
Each resource instance used by the responder
draft | active | retired | unknown
Used in:
The type of actor - system or human. See http://hl7.org/fhir/examplescenario-actor-type
(message has no fields)
Used in:
Declares what the source of a parameter is. See http://terminology.hl7.org/CodeSystem/expansion-parameter-source
(message has no fields)
Used in:
Defines how concepts are processed into the expansion when it's for UI presentation. See http://terminology.hl7.org/CodeSystem/expansion-processing-rule
(message has no fields)
Used in:
Auto-generated from StructureDefinition for ExplanationOfBenefit. Explanation of Benefit resource. See http://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier for the resource
Category or discipline
More granular claim type
The recipient of the products and services
Relevant time frame for the claim
Response creation date
Author of the claim
Party responsible for reimbursement
Party responsible for the claim
Desired processing urgency
For whom to reserve funds
Funds reserved status
Prescription authorizing services or products
Original prescription if superceded by fulfiller
Treatment Referral
Servicing Facility
Claim reference
Claim response reference
Disposition Message
Preauthorization reference
Preauthorization in-effect period
Precedence (primary, secondary, etc.)
Header-level adjudication
Printed form identifier
Printed reference or actual form
When the benefits are applicable
Details of the event
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
When the incident occurred
The nature of the accident
Where the event occurred
Used in:
Insurer added line items
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Item sequence number
Detail sequence number
Subdetail sequence number
Authorized providers
Billing, service, product, or drug code
Service/Product billing modifiers
Program the product or service is provided under
Count of products or services
Fee, charge or cost per item
Price scaling factor
Total item cost
Anatomical location
Anatomical sub-location
Applicable note numbers
Added items adjudication
Insurer added line items
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Billing, service, product, or drug code
Service/Product billing modifiers
Count of products or services
Fee, charge or cost per item
Price scaling factor
Total item cost
Applicable note numbers
Added items adjudication
Insurer added line items
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Billing, service, product, or drug code
Service/Product billing modifiers
Count of products or services
Fee, charge or cost per item
Price scaling factor
Total item cost
Applicable note numbers
Added items adjudication
Place of service or where product was supplied
Used in:
Date or dates of service or product delivery
Used in:
Balance by Benefit Category
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Benefit classification
Excluded from the plan
Short name for the benefit
Description of the benefit or services covered
In or out of network
Individual or family
Annual or lifetime
Benefit Summary
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Benefit classification
Benefits allowed
Used in:
Benefits used
Used in:
Care Team members
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Order of care team
Practitioner or organization
Indicator of the lead practitioner
Function within the team
Practitioner credential or specialization
Pertinent diagnosis information
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Diagnosis instance identifier
Timing or nature of the diagnosis
Present on admission
Package billing code
Nature of illness or problem
Used in:
Patient insurance information
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Coverage to be used for adjudication
Insurance information
Prior authorization reference number
Product or service provided
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Item instance identifier
Applicable care team members
Applicable diagnoses
Applicable procedures
Applicable exception and supporting information
Revenue or cost center code
Benefit classification
Billing, service, product, or drug code
Product or service billing modifiers
Program the product or service is provided under
Count of products or services
Fee, charge or cost per item
Price scaling factor
Total item cost
Unique device identifier
Anatomical location
Anatomical sub-location
Encounters related to this billed item
Applicable note numbers
Adjudication details
Used in: , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of adjudication information
Explanation of adjudication outcome
Monetary amount
Non-monitary value
Additional items
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Product or service provided
Revenue or cost center code
Benefit classification
Billing, service, product, or drug code
Service/Product billing modifiers
Program the product or service is provided under
Count of products or services
Fee, charge or cost per item
Price scaling factor
Total item cost
Unique device identifier
Applicable note numbers
Detail level adjudication details
Additional items
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Product or service provided
Revenue or cost center code
Benefit classification
Billing, service, product, or drug code
Service/Product billing modifiers
Program the product or service is provided under
Count of products or services
Fee, charge or cost per item
Price scaling factor
Total item cost
Unique device identifier
Applicable note numbers
Subdetail level adjudication details
Place of service or where product was supplied
Used in:
Date or dates of service or product delivery
Used in:
Note concerning adjudication
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Note instance identifier
Note explanatory text
Language of the text
display | print | printoper
Used in:
queued | complete | error | partial
Used in:
Recipient of benefits payable
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Category of recipient
Recipient reference
Payment Details
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Partial or complete payment
Payment adjustment for non-claim issues
Explanation for the variance
Expected date of payment
Payable amount after adjustment
Business identifier for the payment
Clinical procedures performed
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Procedure instance identifier
Category of Procedure
When the procedure was performed
Unique device identifier
Specific clinical procedure
Used in:
Prior or corollary claims
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Reference to the related claim
How the reference claim is related
File or case reference
active | cancelled | draft | entered-in-error
Used in:
Supporting information
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Information instance identifier
Classification of the supplied information
Type of information
Explanation for the information
When it occurred
Used in:
Data to be provided
Used in:
Adjudication totals
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of adjudication information
Financial total for the category
claim | preauthorization | predetermination
Used in:
A code specifying the state of the resource instance. See http://hl7.org/fhir/explanationofbenefit-status
(message has no fields)
Used in:
Whether the results by exposure is describing the results for the primary exposure of interest (exposure) or the alternative state (exposureAlternative). See http://hl7.org/fhir/exposure-state
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Expression. An expression that can be used to generate a value. See http://hl7.org/fhir/StructureDefinition/Expression
Used in: , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Natural language description of the condition
Short name assigned to expression for reuse
text/cql | text/fhirpath | application/x-fhir-query | etc.
Expression in specified language
Where the expression is found
Auto-generated from StructureDefinition for Extension. Optional Extensions Element. See http://hl7.org/fhir/StructureDefinition/Extension
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
identifies the meaning of the extension
Value of extension
Used in:
How an extension context is interpreted. See http://hl7.org/fhir/extension-context-type
(message has no fields)
Used in:
A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. See http://hl7.org/fhir/ValueSet/all-types
(message has no fields)
Used in: , ,
A list of all the concrete types defined in this version of the FHIR specification - Data Types and Resource Types. See http://hl7.org/fhir/ValueSet/defined-types
(message has no fields)
Used in: ,
The availability status of the device. See http://hl7.org/fhir/device-status
(message has no fields)
Used in: ,
The set of interactions defined by the RESTful part of the FHIR specification. See http://hl7.org/fhir/restful-interaction
(message has no fields)
A code to indicate if the substance is actively used. See http://hl7.org/fhir/substance-status
(message has no fields)
Used in:
All published FHIR Versions. See http://hl7.org/fhir/FHIR-version
(message has no fields)
Used in: , , , , ,
A code that identifies the status of the family history record. See http://hl7.org/fhir/history-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for FamilyMemberHistory. Information about patient's relatives, relevant for patient. See http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External Id(s) for this record
Instantiates FHIR protocol or definition
Instantiates external protocol or definition
subject-unknown | withheld | unable-to-obtain | deferred
Patient history is about
When history was recorded or last updated
The family member described
Relationship to the subject
male | female | other | unknown
Age is estimated?
Why was family member history performed?
Why was family member history performed?
General note about related person
(approximate) age
Used in:
(approximate) date of birth
Used in:
Condition that the related person had
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Condition suffered by relation
deceased | permanent disability | etc.
Whether the condition contributed to the cause of death
Extra information about condition
When condition first manifested
Used in:
Dead? How old/when?
Used in:
partial | completed | entered-in-error | health-unknown
Used in:
Auto-generated from StructureDefinition for abatement. When (or if) the family member's condition resolved. See http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for observation. Genetic markers, ethnicity, etc. See http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-observation
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for parent. Mother(s) & Father(s) - genetic & other. See http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-parent
Unique id for inter-element referencing
Additional content defined by implementations
mother | father | adoptive mother | etc.
Link to parent relative(s)
Auto-generated from StructureDefinition for patient-record. Link to patient record. See http://hl7.org/fhir/StructureDefinition/familymemberhistory-patient-record
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for severity. The seriousness of the family member condition. See http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for sibling. natural brother(s) & natural sister(s) - genetic & other. See http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-sibling
Unique id for inter-element referencing
Additional content defined by implementations
sibling | brother | sister | etc.
Link to sibling relative(s)
Auto-generated from StructureDefinition for type. Purpose of the family member history. See http://hl7.org/fhir/StructureDefinition/familymemberhistory-type
Unique id for inter-element referencing
Value of extension
The kind of operation to perform as a part of a property based filter. See http://hl7.org/fhir/filter-operator
(message has no fields)
Used in: ,
This value set includes Status codes. See http://hl7.org/fhir/fm-status
(message has no fields)
Used in: , , , , , , , , ,
Auto-generated from StructureDefinition for Flag. Key information to flag to healthcare providers. See http://hl7.org/fhir/StructureDefinition/Flag
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business identifier
Clinical, administrative, etc.
Coded or textual message to display to user
Who/What is flag about?
Time period when flag is active
Alert relevant during encounter
Flag creator
active | inactive | entered-in-error
Used in:
Auto-generated from StructureDefinition for detail. Resource with details for flag. See http://hl7.org/fhir/StructureDefinition/flag-detail
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for priority. An alarm code. See http://hl7.org/fhir/StructureDefinition/flag-priority
Unique id for inter-element referencing
Value of extension
Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error. See http://hl7.org/fhir/flag-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for fmm. FMM Level. See http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Goal. Describes the intended objective(s) for a patient, group or organization. See http://hl7.org/fhir/StructureDefinition/Goal
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External Ids for this goal
in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
E.g. Treatment, dietary, behavioral, etc.
high-priority | medium-priority | low-priority
Code or text describing goal
Who this goal is intended for
When goal status took effect
Reason for current status
Who's responsible for creating Goal?
Issues addressed by this goal
Comments about the goal
What result was achieved regarding the goal?
Observation that resulted from goal
proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Used in:
When goal pursuit begins
Used in:
Target outcome for the goal
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The parameter whose value is being tracked
The target value to be achieved
Used in:
Reach goal on or before
Used in:
Auto-generated from StructureDefinition for acceptance. Individual acceptance of goal. See http://hl7.org/fhir/StructureDefinition/goal-acceptance
Unique id for inter-element referencing
Additional content defined by implementations
Individual whose acceptance is reflected
Priority of goal for individual
agree | disagree | pending
Used in:
Codes indicating whether the goal has been accepted by a stakeholder. See http://terminology.hl7.org/CodeSystem/goal-acceptance-status
(message has no fields)
Used in:
Codes that reflect the current state of a goal and whether the goal is still being targeted. See http://hl7.org/fhir/goal-status
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for reasonRejected. The reason the goal was not accepted. See http://hl7.org/fhir/StructureDefinition/goal-reasonRejected
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for relationship. Goals related to this Goal. See http://hl7.org/fhir/StructureDefinition/goal-relationship
Unique id for inter-element referencing
Additional content defined by implementations
predecessor | successor | replacement | other
Related goal
How a compartment must be linked. See http://hl7.org/fhir/graph-compartment-rule
(message has no fields)
Used in:
Defines how a compartment rule is used. See http://hl7.org/fhir/graph-compartment-use
(message has no fields)
Used in:
Auto-generated from StructureDefinition for GraphDefinition. Definition of a graph of resources. See http://hl7.org/fhir/StructureDefinition/GraphDefinition
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this graph definition, represented as a URI (globally unique)
Business version of the graph definition
Name for this graph definition (computer friendly)
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the graph definition
The context that the content is intended to support
Intended jurisdiction for graph definition (if applicable)
Why this graph definition is defined
Profile on base resource
Links this graph makes rules about
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Path in the resource that contains the link
Which slice (if profiled)
Minimum occurrences for this link
Maximum occurrences for this link
Why this link is specified
Potential target for the link
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Criteria for reverse lookup
Profile for the target resource
Additional links from target resource
Compartment Consistency Rules
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Custom rule, as a FHIRPath expression
Documentation for FHIRPath expression
Patient | Encounter | RelatedPerson | Practitioner | Device
Used in:
identical | matching | different | custom
Used in:
condition | requirement
Used in:
Type of resource this link refers to
Used in:
Type of resource at which the graph starts
Used in:
draft | active | retired | unknown
Used in:
Auto-generated from StructureDefinition for Group. Group of multiple entities. See http://hl7.org/fhir/StructureDefinition/Group
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Unique id
Whether this group's record is in active use
Descriptive or actual
Kind of Group members
Label for Group
Number of members
Entity that is the custodian of the Group's definition
Include / Exclude group members by Trait
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Kind of characteristic
Group includes or excludes
Period over which characteristic is tested
Value held by characteristic
Used in:
Who or what is in group
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Reference to the group member
Period member belonged to the group
If member is no longer in group
person | animal | practitioner | device | medication | substance
Used in:
Possible group measure aggregates (E.g. Mean, Median). See http://hl7.org/fhir/group-measure
(message has no fields)
Used in: , ,
Types of resources that are part of group. See http://hl7.org/fhir/group-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for GuidanceResponse. The formal response to a guidance request. See http://hl7.org/fhir/StructureDefinition/GuidanceResponse
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
The identifier of the request associated with this response, if any
Business identifier
Patient the request was performed for
Encounter during which the response was returned
When the guidance response was processed
Device returning the guidance
Why guidance is needed
Why guidance is needed
Additional notes about the response
Messages resulting from the evaluation of the artifact or artifacts
The output parameters of the evaluation, if any
Proposed actions, if any
Additional required data
What guidance was requested
Used in:
success | data-requested | data-required | in-progress | failure | entered-in-error
Used in:
The status of a guidance response. See http://hl7.org/fhir/guidance-response-status
(message has no fields)
Used in:
A code that indicates how the page is generated. See http://hl7.org/fhir/guide-page-generation
(message has no fields)
Used in:
Code of parameter that is input to the guide. See http://hl7.org/fhir/guide-parameter-code
(message has no fields)
Used in:
An HL7 administrative unit that owns artifacts in the FHIR specification. See http://terminology.hl7.org/CodeSystem/hl7-work-group
(message has no fields)
Used in:
HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details. See http://hl7.org/fhir/http-verb
(message has no fields)
Used in:
Auto-generated from StructureDefinition for HealthcareService. The details of a healthcare service available at a location. See http://hl7.org/fhir/StructureDefinition/HealthcareService
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External identifiers for this item
Whether this HealthcareService record is in active use
Organization that provides this service
Broad category of service being performed or delivered
Type of service that may be delivered or performed
Specialties handled by the HealthcareService
Location(s) where service may be provided
Description of service as presented to a consumer while searching
Additional description and/or any specific issues not covered elsewhere
Extra details about the service that can't be placed in the other fields
Facilitates quick identification of the service
Contacts related to the healthcare service
Location(s) service is intended for/available to
Conditions under which service is available/offered
Programs that this service is applicable to
Collection of characteristics (attributes)
The language that this service is offered in
Ways that the service accepts referrals
If an appointment is required for access to this service
Description of availability exceptions
Technical endpoints providing access to electronic services operated for the healthcare service
Times the Service Site is available
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Always available? e.g. 24 hour service
Opening time of day (ignored if allDay = true)
Closing time of day (ignored if allDay = true)
mon | tue | wed | thu | fri | sat | sun
Used in:
Specific eligibility requirements required to use the service
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Coded value for the eligibility
Describes the eligibility conditions for the service
Not available during this time due to provided reason
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Reason presented to the user explaining why time not available
Service not available from this date
Auto-generated from StructureDefinition for Human Language. Human Language for the item. See http://hl7.org/fhir/StructureDefinition/language
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for HumanName. Name of a human - parts and usage. See http://hl7.org/fhir/StructureDefinition/HumanName
Used in: , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Text representation of the full name
Family name (often called 'Surname')
Given names (not always 'first'). Includes middle names
Parts that come before the name
Parts that come after the name
Time period when name was/is in use
usual | official | temp | nickname | anonymous | old | maiden
Used in:
Auto-generated from StructureDefinition for assembly-order. Preferred display order of name parts. See http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Unique id for inter-element referencing
Value of extension
Used in:
A code that represents the preferred display order of the components of a human name. See http://terminology.hl7.org/CodeSystem/name-assembly-order
(message has no fields)
A code that represents the preferred display order of the components of a human name. See http://hl7.org/fhir/ValueSet/name-assembly-order
(message has no fields)
Used in:
Auto-generated from StructureDefinition for EN-qualifier. LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV. See http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for EN-representation. ABC | IDE | SYL. See http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for EN-use. A | ANON | I | P | R | C | M | ABC | IDE | SYL | OLD | DN | OR | PHON | SRCH | T. See http://hl7.org/fhir/StructureDefinition/iso21090-EN-use
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for fathers-family. Portion of family name derived from father. See http://hl7.org/fhir/StructureDefinition/humanname-fathers-family
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for mothers-family. Portion of family name derived from mother. See http://hl7.org/fhir/StructureDefinition/humanname-mothers-family
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for own-name. Portion derived from person's own surname. See http://hl7.org/fhir/StructureDefinition/humanname-own-name
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for own-prefix. Voorvoegsel derived from person's own surname. See http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for partner-name. Portion derived from person's partner's surname. See http://hl7.org/fhir/StructureDefinition/humanname-partner-name
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for partner-prefix. Voorvoegsel derived from person's partner's surname. See http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for id. Primitive Type id. See http://hl7.org/fhir/StructureDefinition/id
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Primitive value for id
xml:id (or equivalent in JSON)
Additional content defined by implementations
Auto-generated from StructureDefinition for Identifier. An identifier intended for computation. See http://hl7.org/fhir/StructureDefinition/Identifier
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Description of identifier
The namespace for the identifier value
The value that is unique
Time period when id is/was valid for use
Organization that issued id (may be just text)
usual | official | temp | secondary | old (If known)
Used in:
Identifies the purpose for this identifier, if known . See http://hl7.org/fhir/identifier-use
(message has no fields)
Used in:
Auto-generated from StructureDefinition for validDate. External Identifier associated with this element. See http://hl7.org/fhir/StructureDefinition/identifier-validDate
Unique id for inter-element referencing
Value of extension
The level of confidence that this link represents the same actual person, based on NIST Authentication Levels. See http://hl7.org/fhir/identity-assuranceLevel
(message has no fields)
Used in:
Auto-generated from StructureDefinition for ImagingStudy. A set of images produced in single study (one or more series of references images). See http://hl7.org/fhir/StructureDefinition/ImagingStudy
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Identifiers for the whole study
All series modality if actual acquisition modalities
Who or what is the subject of the study
Encounter with which this imaging study is associated
When the study was started
Request fulfilled
Referring physician
Who interpreted images
Study access endpoint
Number of Study Related Series
Number of Study Related Instances
The performed Procedure reference
The performed procedure code
Where ImagingStudy occurred
Why the study was requested
Why was study performed
User-defined comments
Institution-generated description
Each study has one or more series of instances
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
DICOM Series Instance UID for the series
Numeric identifier of this series
The modality of the instances in the series
A short human readable summary of the series
Number of Series Related Instances
Series access endpoint
Body part examined
Body part laterality
Specimen imaged
When the series started
A single SOP instance from the series
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
DICOM SOP Instance UID
DICOM class type
The number of this instance in the series
Description of instance
Who performed the series
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of performance
Who performed the series
registered | available | cancelled | entered-in-error | unknown
Used in:
The status of the ImagingStudy. See http://hl7.org/fhir/imagingstudy-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Immunization. Immunization event information. See http://hl7.org/fhir/StructureDefinition/Immunization
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business identifier
Reason not done
Vaccine product administered
Who was immunized
Encounter immunization was part of
When the immunization was first captured in the subject's record
Indicates context the data was recorded in
Indicates the source of a secondarily reported record
Where immunization occurred
Vaccine manufacturer
Vaccine lot number
Vaccine expiration date
Body site vaccine was administered
How vaccine entered body
Amount of vaccine administered
Additional immunization notes
Why immunization occurred
Why immunization occurred
Dose potency
Reason for being subpotent
Patient eligibility for a vaccination program
Funding source for the vaccine
Educational material presented to patient
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Educational material document identifier
Educational material reference pointer
Educational material publication date
Educational material presentation date
Vaccine administration date
Used in:
Who performed event
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
What type of performance was done
Individual or organization who was performing
Protocol followed by the provider
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Name of vaccine series
Who is responsible for publishing the recommendations
Vaccine preventatable disease being targetted
Dose number within series
Used in:
Recommended number of doses for immunity
Used in:
Details of a reaction that follows immunization
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
When reaction started
Additional information on reaction
Indicates self-reported reaction
completed | entered-in-error | not-done
Used in:
Auto-generated from StructureDefinition for ImmunizationEvaluation. Immunization evaluation information. See http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business identifier
Who this evaluation is for
Date evaluation was performed
Who is responsible for publishing the recommendations
Evaluation target disease
Immunization being evaluated
Status of the dose relative to published recommendations
Reason for the dose status
Evaluation notes
Name of vaccine series
Dose number within series
Used in:
Recommended number of doses for immunity
Used in:
completed | entered-in-error
Used in:
The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the current status of the evaluation for vaccine administration event. See http://hl7.org/fhir/ValueSet/immunization-evaluation-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for ImmunizationRecommendation. Guidance or advice relating to an immunization. See http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business identifier
Who this profile is for
Date recommendation(s) created
Who is responsible for protocol
Vaccine administration recommendations
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Vaccine or vaccine group recommendation applies to
Disease to be immunized against
Vaccine which is contraindicated to fulfill the recommendation
Vaccine recommendation status
Vaccine administration status reason
Protocol details
Name of vaccination series
Past immunizations supporting recommendation
Patient observations supporting recommendation
Dates governing proposed immunization
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of date
Recommended date
Recommended dose number within series
Used in:
Recommended number of doses for immunity
Used in:
The value set to instantiate this attribute should be drawn from a terminologically robust code system that consists of or contains concepts to support describing the current status of the administered dose of vaccine. See http://hl7.org/fhir/ValueSet/immunization-status
(message has no fields)
Used in: ,
A set codes that define the functional status of an implanted device. See http://terminology.hl7.org/CodeSystem/implantStatus
(message has no fields)
Used in:
Auto-generated from StructureDefinition for ImplementationGuide. A set of rules about how FHIR is used. See http://hl7.org/fhir/StructureDefinition/ImplementationGuide
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this implementation guide, represented as a URI (globally unique)
Business version of the implementation guide
Name for this implementation guide (computer friendly)
Name for this implementation guide (human friendly)
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the implementation guide
The context that the content is intended to support
Intended jurisdiction for implementation guide (if applicable)
Use and/or publishing restrictions
NPM Package name for IG
Information needed to build the IG
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Grouping used to present related resources in the IG
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Descriptive name for the package
Human readable text describing the package
Page/Section in the Guide
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Short title shown for navigational assistance
Nested Pages / Sections
html | markdown | xml | generated
Used in:
Where to find that page
Used in:
Defines how IG is built by tools
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Value for named type
apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template
Used in:
Resource in the implementation guide
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Location of the resource
Human Name for the resource
Reason why included in guide
Grouping this is part of
Is an example/What is this an example of?
Used in:
Versions this applies to (if different to IG)
Used in:
A template for building resources
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of template specified
The source location for the template
The scope in which the template applies
Another Implementation guide this depends on
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Identity of the IG that this depends on
NPM Package name for IG this depends on
Version of the IG
FHIR Version(s) this Implementation Guide targets
Used in:
Profiles that apply globally
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Profile that all resources must conform to
Type this profile applies to
Used in:
SPDX license code for this IG (or not-open-source)
Used in:
Information about an assembled IG
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Location of rendered implementation guide
Image within the IG
Additional linkable file in IG
HTML page within the parent IG
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
HTML page name
Title of the page, for references
Anchor available on the page
Resource in the implementation guide
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Location of the resource
Relative path for page in IG
Is an example/What is this an example of?
Used in:
draft | active | retired | unknown
Used in:
Auto-generated from StructureDefinition for initialValue. An initial value expression. See http://hl7.org/fhir/StructureDefinition/cqf-initialValue
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for instant. Primitive Type instant. See http://hl7.org/fhir/StructureDefinition/instant
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
The absolute time of the event as a Unix epoch in microseconds.
The local timezone in which the event was recorded.
xml:id (or equivalent in JSON)
Additional content defined by implementations
Used in:
Auto-generated from StructureDefinition for instantiatesCanonical. FHIR protocol or definition. See http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for instantiatesUri. External protocol or definition. See http://hl7.org/fhir/StructureDefinition/workflow-instantiatesUri
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for InsurancePlan. Details of a Health Insurance product/plan provided by an organization. See http://hl7.org/fhir/StructureDefinition/InsurancePlan
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier for Product
Kind of product
Official name
Alternate names
When the product is available
Plan issuer
Product administrator
Where product applies
Technical endpoint
What networks are Included
Contact for the product
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The type of contact
A name associated with the contact
Contact details (telephone, email, etc.) for a contact
Visiting or postal addresses for the contact
Coverage details
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of coverage
What networks provide coverage
List of benefits
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of benefit
Referral requirements
Benefit limits
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Maximum value allowed
Benefit limit details
Plan details
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Business Identifier for Product
Type of plan
Where product applies
What networks provide coverage
Overall costs
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of cost
Number of enrollees
Cost value
Additional cost information
Specific costs
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
General category of benefit
Benefits list
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of specific benefit
List of the costs
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of cost
in-network | out-of-network | other
Additional information about the cost
The actual cost value
draft | active | retired | unknown
Used in:
Auto-generated from StructureDefinition for integer. Primitive Type integer. See http://hl7.org/fhir/StructureDefinition/integer
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Primitive value for integer
xml:id (or equivalent in JSON)
Additional content defined by implementations
Auto-generated from StructureDefinition for Invoice. Invoice containing ChargeItems from an Account. See http://hl7.org/fhir/StructureDefinition/Invoice
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier for item
Reason for cancellation of this Invoice
Type of Invoice
Recipient(s) of goods and services
Recipient of this invoice
Invoice date / posting date
Issuing Organization of Invoice
Account that is being balanced
Components of Invoice total
Net total of this Invoice
Gross total of this Invoice
Payment details
Comments made about the invoice
Line items of this Invoice
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Sequence number of line item
Reference to ChargeItem containing details of this line item or an inline billing code
Used in:
Components of total line item price
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Code identifying the specific component
Factor used for calculating this component
Monetary amount associated with this component
base | surcharge | deduction | discount | tax | informational
Used in:
Participant in creation of this Invoice
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of involvement in creation of this Invoice
Individual who was involved
draft | issued | balanced | cancelled | entered-in-error
Used in:
Codes indicating the kind of the price component. See http://hl7.org/fhir/invoice-priceComponentType
(message has no fields)
Used in: ,
Codes identifying the lifecycle stage of an Invoice. See http://hl7.org/fhir/invoice-status
(message has no fields)
Used in:
How the issue affects the success of the action. See http://hl7.org/fhir/issue-severity
(message has no fields)
Used in: ,
A code that describes the type of issue. See http://hl7.org/fhir/issue-type
(message has no fields)
Used in: ,
LDL Cholesterol codes - measured or calculated See http://hl7.org/fhir/ValueSet/ldlcholesterol-codes
(message has no fields)
Auto-generated from StructureDefinition for lastReviewDate. Last review date for the resource. See http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Library. Represents a library of quality improvement components. See http://hl7.org/fhir/StructureDefinition/Library
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this library, represented as a URI (globally unique)
Additional identifier for the library
Business version of the library
Name for this library (computer friendly)
Name for this library (human friendly)
Subordinate title of the library
For testing purposes, not real usage
logic-library | model-definition | asset-collection | module-definition
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the library
The context that the content is intended to support
Intended jurisdiction for library (if applicable)
Why this library is defined
Describes the clinical usage of the library
Use and/or publishing restrictions
When the library was approved by publisher
When the library was last reviewed
When the library is expected to be used
E.g. Education, Treatment, Assessment, etc.
Who authored the content
Who edited the content
Who reviewed the content
Who endorsed the content
Additional documentation, citations, etc.
Parameters defined by the library
What data is referenced by this library
Contents of the library, either embedded or referenced
draft | active | retired | unknown
Used in:
Type of individual the library content is focused on
Used in:
The type of link between this patient resource and another patient resource. See http://hl7.org/fhir/link-type
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for Linkage. Links records for 'same' item. See http://hl7.org/fhir/StructureDefinition/Linkage
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Whether this linkage assertion is active or not
Who is responsible for linkages
Item to be linked
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Resource being linked
source | alternate | historical
Used in:
Used to distinguish different roles a resource can play within a set of linked resources. See http://hl7.org/fhir/linkage-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for List. A list is a curated collection of resources. See http://hl7.org/fhir/StructureDefinition/List
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business identifier
Descriptive name for the list
What the purpose of this list is
If all resources have the same subject
Context in which list created
When the list was prepared
Who and/or what defined the list contents (aka Author)
What order the list has
Comments about the list
Why list is empty
Entries in the list
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Status/Workflow information about this item
If this item is actually marked as deleted
When item added to list
Actual entry
working | snapshot | changes
Used in:
current | retired | entered-in-error
Used in:
Auto-generated from StructureDefinition for changeBase. Base List for changes. See http://hl7.org/fhir/StructureDefinition/list-changeBase
Unique id for inter-element referencing
Value of extension
The processing mode that applies to this list. See http://hl7.org/fhir/list-mode
(message has no fields)
Used in: ,
The current state of the list. See http://hl7.org/fhir/list-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Location. Details and position information for a physical place. See http://hl7.org/fhir/StructureDefinition/Location
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Unique code or number identifying the location to its users
The operational status of the location (typically only for a bed/room)
Name of the location as used by humans
A list of alternate names that the location is known as, or was known as, in the past
Additional details about the location that could be displayed as further information to identify the location beyond its name
Type of function performed
Contact details of the location
Physical location
Physical form of the location
Organization responsible for provisioning and upkeep
Another Location this one is physically a part of
Description of availability exceptions
Technical endpoints providing access to services operated for the location
What days/times during a week is this location usually open
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The Location is open all day
Time that the Location opens
Time that the Location closes
mon | tue | wed | thu | fri | sat | sun
Used in:
instance | kind
Used in:
The absolute geographic location
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Longitude with WGS84 datum
Latitude with WGS84 datum
Altitude with WGS84 datum
active | suspended | inactive
Used in:
Auto-generated from StructureDefinition for boundary-geojson. A boundary shape that represents the outside edge of the location (in GeoJSON format). See http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for location. Where event occurred. See http://hl7.org/fhir/StructureDefinition/event-location
Unique id for inter-element referencing
Value of extension
Indicates whether a resource instance represents a specific location or a class of locations. See http://hl7.org/fhir/location-mode
(message has no fields)
Used in: ,
Indicates whether the location is still in use. See http://hl7.org/fhir/location-status
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for markdown. Primitive Type markdown. See http://hl7.org/fhir/StructureDefinition/markdown
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Primitive value for markdown
xml:id (or equivalent in JSON)
Additional content defined by implementations
Auto-generated from StructureDefinition for MarketingStatus. The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available. See http://hl7.org/fhir/StructureDefinition/MarketingStatus
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The country in which the marketing authorisation has been granted shall be specified It should be specified using the ISO 3166 ‑ 1 alpha-2 code elements
Where a Medicines Regulatory Agency has granted a marketing authorisation for which specific provisions within a jurisdiction apply, the jurisdiction can be specified using an appropriate controlled terminology The controlled term and the controlled term identifier shall be specified
This attribute provides information on the status of the marketing of the medicinal product See ISO/TS 20443 for more information and examples
The date when the Medicinal Product is placed on the market by the Marketing Authorisation Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain
The date when the Medicinal Product is placed on the market by the Marketing Authorisation Holder (or where applicable, the manufacturer/distributor) in a country and/or jurisdiction shall be provided A complete date consisting of day, month and year shall be specified using the ISO 8601 date format NOTE “Placed on the market” refers to the release of the Medicinal Product into the distribution chain
A Master Patient Index (MPI) assessment of whether a candidate patient record is a match or not. See http://terminology.hl7.org/CodeSystem/match-grade
(message has no fields)
Used in:
Auto-generated from StructureDefinition for maxDecimalPlaces. Maximum digits after decimal. See http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for maxSize. Max size in MB. See http://hl7.org/fhir/StructureDefinition/maxSize
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Measure. A quality measure definition. See http://hl7.org/fhir/StructureDefinition/Measure
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this measure, represented as a URI (globally unique)
Additional identifier for the measure
Business version of the measure
Name for this measure (computer friendly)
Name for this measure (human friendly)
Subordinate title of the measure
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the measure
The context that the content is intended to support
Intended jurisdiction for measure (if applicable)
Why this measure is defined
Describes the clinical usage of the measure
Use and/or publishing restrictions
When the measure was approved by publisher
When the measure was last reviewed
When the measure is expected to be used
The category of the measure, such as Education, Treatment, Assessment, etc.
Who authored the content
Who edited the content
Who reviewed the content
Who endorsed the content
Additional documentation, citations, etc.
Logic used by the measure
Disclaimer for use of the measure or its referenced content
proportion | ratio | continuous-variable | cohort
opportunity | all-or-nothing | linear | weighted
process | outcome | structure | patient-reported-outcome | composite
How risk adjustment is applied for this measure
How is rate aggregation performed for this measure
Detailed description of why the measure exists
Summary of clinical guidelines
increase | decrease
Defined terms used in the measure documentation
Additional guidance for implementers
Population criteria group
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Meaning of the group
Summary description
Population criteria
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
The human readable description of this population criteria
The criteria that defines this population
Stratifier criteria for the measure
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Meaning of the stratifier
The human readable description of this stratifier
How the measure should be stratified
Stratifier criteria component for the measure
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Meaning of the stratifier component
The human readable description of this stratifier component
Component of how the measure should be stratified
draft | active | retired | unknown
Used in:
E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Used in:
What other data should be reported with the measure
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Meaning of the supplemental data
supplemental-data | risk-adjustment-factor
The human readable description of this supplemental data
Expression describing additional data to be reported
Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue. See http://terminology.hl7.org/CodeSystem/measure-improvement-notation
(message has no fields)
Auto-generated from StructureDefinition for measureInfo. Measure criteria for the resource. See http://hl7.org/fhir/StructureDefinition/cqf-measureInfo
Unique id for inter-element referencing
Additional content defined by implementations
The measure being calculated
The group identifier
The population identifier
Auto-generated from StructureDefinition for MeasureReport. Results of a measure evaluation. See http://hl7.org/fhir/StructureDefinition/MeasureReport
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Additional identifier for the MeasureReport
What measure was calculated
What individual(s) the report is for
When the report was generated
Who is reporting the data
What period the report covers
increase | decrease
What data was used to calculate the measure score
Measure results for each group
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Meaning of the group
What score this group achieved
The populations in the group
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
Size of the population
For subject-list reports, the subject results in this population
Stratification results
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
What stratifier of the group
Stratum results, one for each unique value, or set of values, in the stratifier, or stratifier components
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The stratum value, e.g. male
What score this stratum achieved
Stratifier component values
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
What stratifier component of the group
The stratum component value, e.g. male
Population results in this stratum
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
Size of the population
For subject-list reports, the subject results in this population
complete | pending | error
Used in:
individual | subject-list | summary | data-collection
Used in:
The status of the measure report. See http://hl7.org/fhir/measure-report-status
(message has no fields)
Used in:
The type of the measure report. See http://hl7.org/fhir/measure-report-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Media. A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference. See http://hl7.org/fhir/StructureDefinition/Media
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Identifier(s) for the image
Procedure that caused this media to be created
Part of referenced event
Classification of media as image, video, or audio
The type of acquisition equipment/process
Imaging view, e.g. Lateral or Antero-posterior
Who/What this Media is a record of
Encounter associated with media
Date/Time this version was made available
The person who generated the image
Why was event performed?
Observed body part
Name of the device/manufacturer
Observing Device
Height of the image in pixels (photo/video)
Width of the image in pixels (photo/video)
Number of frames if > 1 (photo)
Length in seconds (audio / video)
Actual Media - reference or data
Comments made about the media
When Media was collected
Used in:
preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Used in:
Auto-generated from StructureDefinition for Medication. Definition of a Medication. See http://hl7.org/fhir/StructureDefinition/Medication
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business identifier for this medication
Codes that identify this medication
Manufacturer of the item
powder | tablets | capsule +
Amount of drug in package
Details about packaged medications
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Identifier assigned to batch
When batch will expire
Active or inactive ingredient
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Active ingredient indicator
Quantity of ingredient present
The actual ingredient or content
Used in:
active | inactive | entered-in-error
Used in:
Auto-generated from StructureDefinition for MedicationAdministration. Administration of medication to a patient. See http://hl7.org/fhir/StructureDefinition/MedicationAdministration
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External identifier
Instantiates protocol or definition
Part of referenced event
Reason administration not performed
Type of medication usage
Who received medication
Encounter or Episode of Care administered as part of
Additional information to support administration
Reason administration performed
Condition or observation that supports why the medication was administered
Request administration performed against
Device used to administer
Information about the administration
A list of events of interest in the lifecycle
Details of how medication was taken
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Free text dosage instructions e.g. SIG
Body site administered to
Path of substance into body
How drug was administered
Amount of medication per dose
Dose quantity per unit of time
Used in:
Start and end time of administration
Used in:
What was administered
Used in:
Who performed the medication administration and what they did
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of performance
Who performed the medication administration
in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown
Used in:
MedicationAdministration Status Codes See http://terminology.hl7.org/CodeSystem/medication-admin-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for MedicationDispense. Dispensing a medication to a named patient. See http://hl7.org/fhir/StructureDefinition/MedicationDispense
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External identifier
Event that dispense is part of
Type of medication dispense
Who the dispense is for
Encounter / Episode associated with event
Information that supports the dispensing of the medication
Where the dispense occurred
Medication order that authorizes the dispense
Trial fill, partial fill, emergency fill, etc.
Amount dispensed
Amount of medication expressed as a timing amount
When product was packaged and reviewed
When product was given out
Where the medication was sent
Who collected the medication
Information about the dispense
How the medication is to be used by the patient or administered by the caregiver
Clinical issue with action
A list of relevant lifecycle events
What medication was supplied
Used in:
Who performed event
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Who performed the dispense and what they did
Individual who was performing
preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
Used in:
Why a dispense was not performed
Used in:
Whether a substitution was performed on the dispense
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Whether a substitution was or was not performed on the dispense
Code signifying whether a different drug was dispensed from what was prescribed
Why was substitution made
Who is responsible for the substitution
MedicationDispense Status Codes See http://terminology.hl7.org/CodeSystem/medicationdispense-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for MedicationKnowledge. Definition of Medication Knowledge. See http://hl7.org/fhir/StructureDefinition/MedicationKnowledge
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Code that identifies this medication
Manufacturer of the item
powder | tablets | capsule +
Amount of drug in package
Additional names for a medication
A medication resource that is associated with this medication
Category of the medication or product
The instructions for preparing the medication
The intended or approved route of administration
Potential clinical issue with or between medication(s)
Guidelines for administration of the medication
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Dosage for the medication for the specific guidelines
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of dosage
Dosage for the medication for the specific guidelines
Indication for use that apply to the specific administration guidelines
Used in:
Characteristics of the patient that are relevant to the administration guidelines
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The specific characteristic
Specific characteristic that is relevant to the administration guideline
Used in:
The pricing of the medication
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The category of the cost information
The source or owner for the price information
The price of the medication
Specifies descriptive properties of the medicine
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Code specifying the type of characteristic of medication
Description of the characteristic
Used in:
Active or inactive ingredient
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Active ingredient indicator
Quantity of ingredient present
Medication(s) or substance(s) contained in the medication
Used in:
The time course of drug absorption, distribution, metabolism and excretion of a medication from the body
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The drug concentration measured at certain discrete points in time
The median lethal dose of a drug
Time required for concentration in the body to decrease by half
Categorization of the medication within a formulary or classification system
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
Specific category assigned to the medication
Program under which a medication is reviewed
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of program under which the medication is monitored
Name of the reviewing program
Associated documentation about the medication
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The category of medication document
Associated documentation about the medication
Details about packaged medications
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
A code that defines the specific type of packaging that the medication can be found in
The number of product units the package would contain if fully loaded
Regulatory information about a medication
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Specifies the authority of the regulation
The maximum number of units of the medication that can be dispensed in a period
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The maximum number of units of the medication that can be dispensed
The period that applies to the maximum number of units
Specifies the schedule of a medication in jurisdiction
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Specifies the specific drug schedule
Specifies if changes are allowed when dispensing a medication from a regulatory perspective
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Specifies the type of substitution allowed
Specifies if regulation allows for changes in the medication when dispensing
Associated or related medication information
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Category of medicationKnowledge
Associated documentation about the associated medication knowledge
active | inactive | entered-in-error
Used in:
MedicationKnowledge Status Codes See http://terminology.hl7.org/CodeSystem/medicationknowledge-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for MedicationRequest. Ordering of medication for patient or group. See http://hl7.org/fhir/StructureDefinition/MedicationRequest
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External ids for this request
Reason for current status
Type of medication usage
True if request is prohibiting action
Who or group medication request is for
Encounter created as part of encounter/admission/stay
Information to support ordering of the medication
When request was initially authored
Who/What requested the Request
Intended performer of administration
Desired kind of performer of the medication administration
Person who entered the request
Reason or indication for ordering or not ordering the medication
Condition or observation that supports why the prescription is being written
Instantiates FHIR protocol or definition
Instantiates external protocol or definition
What request fulfills
Composite request this is part of
Overall pattern of medication administration
Associated insurance coverage
Information about the prescription
How the medication should be taken
An order/prescription that is being replaced
Clinical Issue with action
A list of events of interest in the lifecycle
Medication supply authorization
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Minimum period of time between dispenses
Time period supply is authorized for
Number of refills authorized
Amount of medication to supply per dispense
Number of days supply per dispense
Intended dispenser
First fill details
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
First fill quantity
First fill duration
proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Used in:
Medication to be taken
Used in:
routine | urgent | asap | stat
Used in:
Reported rather than primary record
Used in:
active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Used in:
Any restrictions on medication substitution
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Why should (not) substitution be made
Whether substitution is allowed or not
Used in:
MedicationRequest Intent Codes See http://hl7.org/fhir/CodeSystem/medicationrequest-intent
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for MedicationStatement. Record of medication being taken by a patient. See http://hl7.org/fhir/StructureDefinition/MedicationStatement
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External identifier
Fulfils plan, proposal or order
Part of referenced event
Reason for current status
Type of medication usage
Who is/was taking the medication
Encounter / Episode associated with MedicationStatement
When the statement was asserted?
Person or organization that provided the information about the taking of this medication
Additional supporting information
Reason for why the medication is being/was taken
Condition or observation that supports why the medication is being/was taken
Further information about the statement
Details of how medication is/was taken or should be taken
The date/time or interval when the medication is/was/will be taken
Used in:
What medication was taken
Used in:
active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken
Used in:
Medication Status Codes See http://hl7.org/fhir/CodeSystem/medication-statement-status
(message has no fields)
Used in:
Medication Status Codes See http://hl7.org/fhir/CodeSystem/medication-status
(message has no fields)
Used in: ,
MedicationRequest Status Codes See http://hl7.org/fhir/CodeSystem/medicationrequest-status
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for MedicinalProduct. Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use). See http://hl7.org/fhir/StructureDefinition/MedicinalProduct
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business identifier for this product. Could be an MPID
Regulatory type, e.g. Investigational or Authorized
If this medicine applies to human or veterinary uses
The dose form for a single part product, or combined form of a multiple part product
The legal status of supply of the medicinal product as classified by the regulator
Whether the Medicinal Product is subject to additional monitoring for regulatory reasons
Whether the Medicinal Product is subject to special measures for regulatory reasons
If authorised for use in children
Allows the product to be classified by various systems
Marketing status of the medicinal product, in contrast to marketing authorizaton
Pharmaceutical aspects of product
Package representation for the product
Supporting documentation, typically for regulatory submission
A master file for to the medicinal product (e.g. Pharmacovigilance System Master File)
A product specific contact, person (in a role), or an organization
Clinical trials or studies that this product is involved in
Reference to another product, e.g. for linking authorised to investigational product
An operation applied to the product, for manufacturing or adminsitrative purpose
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The type of manufacturing operation
Regulatory authorization reference number
Regulatory authorization date
To indicate if this proces is commercially confidential
The manufacturer or establishment associated with the process
A regulator which oversees the operation
The product's name, including full name and possibly coded parts
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The full product name
Country where the name applies
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Country code for where this name applies
Jurisdiction code for where this name applies
Language code for this name
Coding words or phrases of the name
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
A fragment of a product name
Idenifying type for this part of the name (e.g. strength part)
Indicates if the medicinal product has an orphan designation for the treatment of a rare disease
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Identifier for the designation, or procedure number
The type of special designation, e.g. orphan drug, minor use
The intended use of the product, e.g. prevention, treatment
For example granted, pending, expired or withdrawn
Date when the designation was granted
Animal species for which this applies
Condition for which the medicinal use applies
Used in:
Auto-generated from StructureDefinition for MedicinalProductAuthorization. The regulatory authorization of a medicinal product. See http://hl7.org/fhir/StructureDefinition/MedicinalProductAuthorization
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business identifier for the marketing authorization, as assigned by a regulator
The medicinal product that is being authorized
The country in which the marketing authorization has been granted
Jurisdiction within a country
The status of the marketing authorization
The date at which the given status has become applicable
The date when a suspended the marketing or the marketing authorization of the product is anticipated to be restored
The beginning of the time period in which the marketing authorization is in the specific status shall be specified A complete date consisting of day, month and year shall be specified using the ISO 8601 date format
A period of time after authorization before generic product applicatiosn can be submitted
The date when the first authorization was granted by a Medicines Regulatory Agency
Date of first marketing authorization for a company's new medicinal product in any country in the World
The legal framework against which this authorization is granted
Marketing Authorization Holder
Medicines Regulatory Agency
Authorization in areas within a country
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The assigned number for the marketing authorization
Country of authorization
Jurisdiction within a country
The legal status of supply in a jurisdiction or region
The start and expected end date of the authorization
The regulatory procedure for granting or amending a marketing authorization
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Identifier for this procedure
Type of procedure
Applcations submitted to obtain a marketing authorization
Date of procedure
Used in:
Auto-generated from StructureDefinition for MedicinalProductContraindication. MedicinalProductContraindication. See http://hl7.org/fhir/StructureDefinition/MedicinalProductContraindication
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
The medication for which this is an indication
The disease, symptom or procedure for the contraindication
The status of the disease or symptom for the contraindication
A comorbidity (concurrent condition) or coinfection
Information about the use of the medicinal product in relation to other therapies as part of the indication
The population group to which this applies
Information about the use of the medicinal product in relation to other therapies described as part of the indication
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The type of relationship between the medicinal product indication or contraindication and another therapy
Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication
Used in:
Auto-generated from StructureDefinition for MedicinalProductIndication. MedicinalProductIndication. See http://hl7.org/fhir/StructureDefinition/MedicinalProductIndication
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
The medication for which this is an indication
The disease, symptom or procedure that is the indication for treatment
The status of the disease or symptom for which the indication applies
Comorbidity (concurrent condition) or co-infection as part of the indication
The intended effect, aim or strategy to be achieved by the indication
Timing or duration information as part of the indication
Describe the undesirable effects of the medicinal product
The population group to which this applies
Information about the use of the medicinal product in relation to other therapies described as part of the indication
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The type of relationship between the medicinal product indication or contraindication and another therapy
Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication
Used in:
Auto-generated from StructureDefinition for MedicinalProductIngredient. An ingredient of a manufactured item or pharmaceutical product. See http://hl7.org/fhir/StructureDefinition/MedicinalProductIngredient
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Identifier for the ingredient
Ingredient role e.g. Active ingredient, excipient
If the ingredient is a known or suspected allergen
Manufacturer of this Ingredient
A specified substance that comprises this ingredient
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The specified substance
The group of specified substance, e.g. group 1 to 4
Confidentiality level of the specified substance as the ingredient
Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The quantity of substance in the unit of presentation, or in the volume (or mass) of the single pharmaceutical product or manufactured item
A lower limit for the quantity of substance in the unit of presentation. For use when there is a range of strengths, this is the lower limit, with the presentation attribute becoming the upper limit
The strength per unitary volume (or mass)
A lower limit for the strength per unitary volume (or mass), for when there is a range. The concentration attribute then becomes the upper limit
For when strength is measured at a particular point or distance
The country or countries for which the strength range applies
Strength expressed in terms of a reference substance
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Relevant reference substance
Strength expressed in terms of a reference substance
Strength expressed in terms of a reference substance
For when strength is measured at a particular point or distance
The country or countries for which the strength range applies
The ingredient substance
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The ingredient substance
Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product
Auto-generated from StructureDefinition for MedicinalProductInteraction. MedicinalProductInteraction. See http://hl7.org/fhir/StructureDefinition/MedicinalProductInteraction
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
The medication for which this is a described interaction
The interaction described
The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction
The effect of the interaction, for example "reduced gastric absorption of primary medication"
The incidence of the interaction, e.g. theoretical, observed
Actions for managing the interaction
The specific medication, food or laboratory test that interacts
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The specific medication, food or laboratory test that interacts
Used in:
Auto-generated from StructureDefinition for MedicinalProductManufactured. The manufactured item as contained in the packaged medicinal product. See http://hl7.org/fhir/StructureDefinition/MedicinalProductManufactured
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Dose form as manufactured and before any transformation into the pharmaceutical product
The “real world” units in which the quantity of the manufactured item is described
The quantity or "count number" of the manufactured item
Manufacturer of the item (Note that this should be named "manufacturer" but it currently causes technical issues)
Ingredient
Dimensions, color etc.
Other codeable characteristics
Auto-generated from StructureDefinition for MedicinalProductPackaged. A medicinal product in a container or package. See http://hl7.org/fhir/StructureDefinition/MedicinalProductPackaged
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Unique identifier
The product with this is a pack for
Textual description
The legal status of supply of the medicinal product as classified by the regulator
Marketing information
Manufacturer of this Package Item
Manufacturer of this Package Item
Batch numbering
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
A number appearing on the outer packaging of a specific batch
A number appearing on the immediate packaging (and not the outer packaging)
A packaging item, as a contained for medicine, possibly with other packaging items within
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Including possibly Data Carrier Identifier
The physical type of the container of the medicine
The quantity of this package in the medicinal product, at the current level of packaging. The outermost is always 1
Material type of the package item
A possible alternate material for the packaging
A device accompanying a medicinal product
The manufactured item as contained in the packaged medicinal product
Allows containers within containers
Dimensions, color etc.
Other codeable characteristics
Shelf Life and storage information
Manufacturer of this Package Item
Auto-generated from StructureDefinition for MedicinalProductPharmaceutical. A pharmaceutical product described in terms of its composition and dose form. See http://hl7.org/fhir/StructureDefinition/MedicinalProductPharmaceutical
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
An identifier for the pharmaceutical medicinal product
The administrable dose form, after necessary reconstitution
Todo
Ingredient
Accompanying device
Characteristics e.g. a products onset of action
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
A coded characteristic
The status of characteristic e.g. assigned or pending
The path by which the pharmaceutical product is taken into or makes contact with the body
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Coded expression for the route
The first dose (dose quantity) administered in humans can be specified, for a product under investigation, using a numerical value and its unit of measurement
The maximum single dose that can be administered as per the protocol of a clinical trial can be specified using a numerical value and its unit of measurement
The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered as per the protocol referenced in the clinical trial authorisation
The maximum dose per treatment period that can be administered as per the protocol referenced in the clinical trial authorisation
The maximum treatment period during which an Investigational Medicinal Product can be administered as per the protocol referenced in the clinical trial authorisation
A species for which this route applies
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Coded expression for the species
A species specific time during which consumption of animal product is not appropriate
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk
A value for the time
Extra information about the withdrawal period
Auto-generated from StructureDefinition for MedicinalProductUndesirableEffect. MedicinalProductUndesirableEffect. See http://hl7.org/fhir/StructureDefinition/MedicinalProductUndesirableEffect
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
The medication for which this is an indication
The symptom, condition or undesirable effect
Classification of the effect
The frequency of occurrence of the effect
The population group to which this applies
Auto-generated from StructureDefinition for MessageDefinition. A resource that defines a type of message that can be exchanged between systems. See http://hl7.org/fhir/StructureDefinition/MessageDefinition
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier for a given MessageDefinition
Primary key for the message definition on a given server
Business version of the message definition
Name for this message definition (computer friendly)
Name for this message definition (human friendly)
Takes the place of
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the message definition
The context that the content is intended to support
Intended jurisdiction for message definition (if applicable)
Why this message definition is defined
Use and/or publishing restrictions
Definition this one is based on
Protocol/workflow this is part of
Canonical reference to a GraphDefinition
Responses to this message
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Reference to allowed message definition response
When should this response be used
consequence | currency | notification
Used in:
Event code or link to the EventDefinition
Used in:
Resource(s) that are the subject of the event
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Profile that must be adhered to by focus
Minimum number of focuses of this type
Maximum number of focuses of this type
Type of resource
Used in:
always | on-error | never | on-success
Used in:
draft | active | retired | unknown
Used in:
Auto-generated from StructureDefinition for MessageHeader. A resource that describes a message that is exchanged between systems. See http://hl7.org/fhir/StructureDefinition/MessageHeader
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Real world sender of the message
The source of the data entry
The source of the decision
Final responsibility for event
Cause of event
The actual content of the message
Link to the definition for this message
Code for the event this message represents or link to event definition
Used in:
Message destination application(s)
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Name of system
Particular delivery destination within the destination
Actual destination address or id
Intended "real-world" recipient for the data
Message source application
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Name of system
Name of software running the system
Version of software running
Human contact for problems
Actual message source address or id
If this is a reply to prior message
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Id of original message
Specific list of hints/warnings/errors
ok | transient-error | fatal-error
Used in:
Auto-generated from StructureDefinition for messageheader-response-request. messageheader initiator requests a response. See http://hl7.org/fhir/StructureDefinition/messageheader-response-request
Unique id for inter-element referencing
Value of extension
Used in:
The impact of the content of a message. See http://hl7.org/fhir/message-significance-category
(message has no fields)
Used in:
HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message. See http://hl7.org/fhir/messageheader-response-request
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for Meta. Metadata about a resource. See http://hl7.org/fhir/StructureDefinition/Meta
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Version specific identifier
When the resource version last changed
Identifies where the resource comes from
Profiles this resource claims to conform to
Security Labels applied to this resource
Tags applied to this resource
Auto-generated from StructureDefinition for MetadataResource. Common Ancestor declaration for definitional resources. See http://hl7.org/fhir/StructureDefinition/MetadataResource
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this metadata resource, represented as a URI (globally unique)
Business version of the metadata resource
Name for this metadata resource (computer friendly)
Name for this metadata resource (human friendly)
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the metadata resource
The context that the content is intended to support
Intended jurisdiction for metadata resource (if applicable)
draft | active | retired | unknown
Used in:
Auto-generated from StructureDefinition for mimeType. Type of attachment. See http://hl7.org/fhir/StructureDefinition/mimeType
Unique id for inter-element referencing
Value of extension
Used in:
This valueset is not enumerable, and so is represented as a string.
Auto-generated from StructureDefinition for minLength. At least this many characters. See http://hl7.org/fhir/StructureDefinition/minLength
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for MolecularSequence. Information about a biological sequence. See http://hl7.org/fhir/StructureDefinition/MolecularSequence
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Unique ID for this particular sequence. This is a FHIR-defined id
Base number of coordinate system (0 for 0-based numbering or coordinates, inclusive start, exclusive end, 1 for 1-based numbering, inclusive start, inclusive end)
Who and/or what this is about
Specimen used for sequencing
The method for sequencing
Who should be responsible for test result
The number of copies of the sequence of interest. (RNASeq)
Sequence that was observed
Average number of reads representing a given nucleotide in the reconstructed sequence
Pointer to next atomic sequence
An set of value as quality of sequence
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Standard sequence for comparison
Start position of the sequence
End position of the sequence
Quality score for the comparison
Method to get quality
True positives from the perspective of the truth data
True positives from the perspective of the query data
False negatives
False positives
False positives where the non-REF alleles in the Truth and Query Call Sets match
Precision of comparison
Recall of comparison
F-score
Receiver Operator Characteristic (ROC) Curve
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Genotype quality score
Roc score true positive numbers
Roc score false positive numbers
Roc score false negative numbers
Precision of the GQ score
Sensitivity of the GQ score
FScore of the GQ score
indel | snp | unknown
Used in:
A sequence used as reference
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Chromosome containing genetic finding
The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37'
Reference identifier
A pointer to another MolecularSequence entity as reference sequence
A string to represent reference sequence
Start position of the window on the reference sequence
End position of the window on the reference sequence
sense | antisense
Used in:
watson | crick
Used in:
External repository which contains detailed report related with observedSeq in this resource
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
URI of the repository
Repository's name
Id of the dataset that used to call for dataset in repository
Id of the variantset that used to call for variantset in repository
Id of the read
directlink | openapi | login | oauth | other
Used in:
Structural variant
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Structural variant change type
Does the structural variant have base pair resolution breakpoints?
Structural variant length
Structural variant inner
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Structural variant inner start
Structural variant inner end
Structural variant outer
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Structural variant outer start
Structural variant outer end
aa | dna | rna
Used in:
Variant in sequence
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Start position of the variant on the reference sequence
End position of the variant on the reference sequence
Allele that was observed
Allele in the reference sequence
Extended CIGAR string for aligning the sequence with reference bases
Pointer to observed variant information
Auto-generated from StructureDefinition for Money. An amount of economic utility in some recognized currency. See http://hl7.org/fhir/StructureDefinition/Money
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Numerical value (with implicit precision)
ISO 4217 Currency Code
Used in:
This valueset is not enumerable, and so is represented as a string.
Auto-generated from StructureDefinition for MoneyQuantity. An amount of money. With regard to precision, see [Decimal Precision](datatypes.html#precision). See http://hl7.org/fhir/StructureDefinition/MoneyQuantity
Unique id for inter-element referencing
Additional content defined by implementations
Numerical value (with implicit precision)
Unit representation
System that defines coded unit form
Coded form of the unit
< | <= | >= | > - how to understand the value
Used in:
A set of codes for each different representation of a name. See http://hl7.org/fhir/ValueSet/name-v3-representation
(message has no fields)
Used in:
The use of a human name. See http://hl7.org/fhir/name-use
(message has no fields)
Used in:
Auto-generated from StructureDefinition for namespace. specify namespace other than http://hl7.org/fhir. See http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for NamingSystem. System of unique identification. See http://hl7.org/fhir/StructureDefinition/NamingSystem
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Name for this naming system (computer friendly)
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Who maintains system namespace?
e.g. driver, provider, patient, bank etc.
Natural language description of the naming system
The context that the content is intended to support
Intended jurisdiction for naming system (if applicable)
How/where is it used
codesystem | identifier | root
Used in:
draft | active | retired | unknown
Used in:
Unique identifiers used for system
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The unique identifier
Is this the id that should be used for this type
Notes about identifier usage
When is identifier valid?
oid | uuid | uri | other
Used in:
Identifies the style of unique identifier used to identify a namespace. See http://hl7.org/fhir/namingsystem-identifier-type
(message has no fields)
Used in:
Identifies the purpose of the naming system. See http://hl7.org/fhir/namingsystem-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Narrative. Human-readable summary of the resource (essential clinical and business information). See http://hl7.org/fhir/StructureDefinition/Narrative
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Limited xhtml content
generated | extensions | additional | empty
Used in:
Auto-generated from StructureDefinition for Narrative Link. Narrative Link. See http://hl7.org/fhir/StructureDefinition/narrativeLink
Unique id for inter-element referencing
Value of extension
The status of a resource narrative. See http://hl7.org/fhir/narrative-status
(message has no fields)
Used in:
The presentation types of notes. See http://hl7.org/fhir/note-type
(message has no fields)
Used in: , ,
Auto-generated from StructureDefinition for nullFlavor. NI | OTH | NINF | PINF | UNK | ASKU | NAV | NASK | TRC | MSK | NA | QS. See http://hl7.org/fhir/StructureDefinition/iso21090-nullFlavor
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for NutritionOrder. Diet, formula or nutritional supplement request. See http://hl7.org/fhir/StructureDefinition/NutritionOrder
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Identifiers assigned to this order
Instantiates FHIR protocol or definition
Instantiates external protocol or definition
Instantiates protocol or definition
The person who requires the diet, formula or nutritional supplement
The encounter associated with this nutrition order
Date and time the nutrition order was requested
Who ordered the diet, formula or nutritional supplement
List of the patient's food and nutrition-related allergies and intolerances
Order-specific modifier about the type of food that should be given
Order-specific modifier about the type of food that should not be given
Comments
Enteral formula components
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of enteral or infant formula
Product or brand name of the enteral or infant formula
Type of modular component to add to the feeding
Product or brand name of the modular additive
Amount of energy per specified volume that is required
How the formula should enter the patient's gastrointestinal tract
Upper limit on formula volume per unit of time
Formula feeding instructions expressed as text
Formula feeding instruction as structured data
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Scheduled frequency of enteral feeding
The volume of formula to provide
Speed with which the formula is provided per period of time
Used in:
proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Used in:
Oral diet components
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of oral diet or diet restrictions that describe what can be consumed orally
Scheduled frequency of diet
The required consistency of fluids and liquids provided to the patient
Instructions or additional information about the oral diet
Required nutrient modifications
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of nutrient that is being modified
Quantity of the specified nutrient
Required texture modifications
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Code to indicate how to alter the texture of the foods, e.g. pureed
Concepts that are used to identify an entity that is ingested for nutritional purposes
draft | active | on-hold | revoked | completed | entered-in-error | unknown
Used in:
Supplement components
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of supplement product requested
Product or brand name of the nutritional supplement
Scheduled frequency of supplement
Amount of the nutritional supplement
Instructions or additional information about the oral supplement
Auto-generated from StructureDefinition for adaptiveFeedingDevice. Adaptive Feeding Device. See http://hl7.org/fhir/StructureDefinition/nutritionorder-adaptiveFeedingDevice
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for doNotPerform. true if request is prohibiting action. See http://hl7.org/fhir/StructureDefinition/request-doNotPerform
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for insurance. Associated insurance coverage. See http://hl7.org/fhir/StructureDefinition/request-insurance
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for replaces. Request(s) replaced by this request. See http://hl7.org/fhir/StructureDefinition/request-replaces
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Observation. Measurements and simple assertions. See http://hl7.org/fhir/StructureDefinition/Observation
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier for observation
Fulfills plan, proposal or order
Part of referenced event
Classification of type of observation
Type of observation (code / type)
Who and/or what the observation is about
What the observation is about, when it is not about the subject of record
Healthcare event during which this observation is made
Date/Time this version was made available
Who is responsible for the observation
Why the result is missing
High, low, normal, etc.
Comments about the observation
Observed body part
How it was done
Specimen used for this observation
(Measurement) Device
Related resource that belongs to the Observation group
Related measurements the observation is made from
Component results
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of component observation (code / type)
Why the component result is missing
High, low, normal, etc.
Provides guide for interpretation of component result
Actual component result
Used in:
Clinically relevant time/time-period for observation
Used in:
Provides guide for interpretation
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Low Range, if relevant
High Range, if relevant
Reference range qualifier
Reference range population
Applicable age range, if relevant
Text based reference range in an observation
registered | preliminary | final | amended +
Used in:
Actual result
Used in:
Auto-generated from StructureDefinition for Allele. Allele. See http://hl7.org/fhir/StructureDefinition/observation-geneticsAllele
Unique id for inter-element referencing
Additional content defined by implementations
Name of allele
The level of occurrence of a single DNA sequence variant within a set of chromosomes: Heteroplasmic / Homoplasmic / Homozygous / Heterozygous / Hemizygous
Allele frequency
Auto-generated from StructureDefinition for AminoAcidChange. AminoAcidChange. See http://hl7.org/fhir/StructureDefinition/observation-geneticsAminoAcidChange
Unique id for inter-element referencing
Additional content defined by implementations
HGVS nomenclature for observed Amino Acid Change
Amino Acid Change Type
Auto-generated from StructureDefinition for Ancestry. Ancestry. See http://hl7.org/fhir/StructureDefinition/observation-geneticsAncestry
Unique id for inter-element referencing
Additional content defined by implementations
Ancestry name
Ancestry percentage
Source of ancestry report
Auto-generated from StructureDefinition for CopyNumberEvent. Copy number variation. See http://hl7.org/fhir/StructureDefinition/observation-geneticsCopyNumberEvent
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for DNARegionName. DNA region name. See http://hl7.org/fhir/StructureDefinition/observation-geneticsDNARegionName
Unique id for inter-element referencing
Value of extension
Permitted data type for observation value. See http://hl7.org/fhir/permitted-data-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for ObservationDefinition. Definition of an observation. See http://hl7.org/fhir/StructureDefinition/ObservationDefinition
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Category of observation
Type of observation (code / type)
Business identifier for this ObservationDefinition instance
Multiple results allowed
Method used to produce the observation
Preferred report name
Value set of valid coded values for the observations conforming to this ObservationDefinition
Value set of normal coded values for the observations conforming to this ObservationDefinition
Value set of abnormal coded values for the observations conforming to this ObservationDefinition
Value set of critical coded values for the observations conforming to this ObservationDefinition
Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Used in:
Qualified range for continuous and ordinal observation results
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The interval itself, for continuous or ordinal observations
Range context qualifier
Targetted population of the range
Applicable age range, if relevant
Applicable gestational age range, if relevant
Condition associated with the reference range
reference | critical | absolute
Used in:
male | female | other | unknown
Used in:
Characteristics of quantitative results
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Customary unit for quantitative results
SI unit for quantitative results
SI to Customary unit conversion factor
Decimal precision of observation quantitative results
Auto-generated from StructureDefinition for delta. Qualitative change or trend in the measurement. See http://hl7.org/fhir/StructureDefinition/observation-delta
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for deviceCode. A code representing the the type of device used for this observation. Should only be used if not implicit in the code found in `Observation.code`. See http://hl7.org/fhir/StructureDefinition/observation-deviceCode
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for focusCode. Focus Code. See http://hl7.org/fhir/StructureDefinition/observation-focusCode
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for gatewayDevice. Gateway Device. See http://hl7.org/fhir/StructureDefinition/observation-gatewayDevice
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Gene. HGNC gene symbol. See http://hl7.org/fhir/StructureDefinition/observation-geneticsGene
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for GenomicSourceClass. Genomic source class. See http://hl7.org/fhir/StructureDefinition/observation-geneticsGenomicSourceClass
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Interpretation. Clinical interpretations for variant. See http://hl7.org/fhir/StructureDefinition/observation-geneticsInterpretation
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for PhaseSet. Phase set. See http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet
Unique id for inter-element referencing
Additional content defined by implementations
Phase set ID
Phase set sequence
Auto-generated from StructureDefinition for precondition. Other Observations needed to aid in the interpretation of the source observation. See http://hl7.org/fhir/StructureDefinition/observation-precondition
Unique id for inter-element referencing
Value of extension
Codes identifying the category of observation range. See http://hl7.org/fhir/observation-range-category
(message has no fields)
Used in:
Auto-generated from StructureDefinition for reagent. Reference to reagents used to generate this observation. See http://hl7.org/fhir/StructureDefinition/observation-reagent
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for replaces. Replaces referenced Observation. See http://hl7.org/fhir/StructureDefinition/observation-replaces
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for secondaryFinding. Secondary findings are genetic test results that provide information about variants in a gene unrelated to the primary purpose for the testing, most often discovered when [Whole Exome Sequencing (WES)](https://en.wikipedia.org/wiki/Exome_sequencing) or [Whole Genome Sequencing (WGS)](https://en.wikipedia.org/wiki/Whole_genome_sequencing) is performed. This extension should be used to denote when a genetic finding is being shared as a secondary finding, and ideally refer to a corresponding guideline or policy statement. For more detail, please see: https://ghr.nlm.nih.gov/primer/testing/secondaryfindings. See http://hl7.org/fhir/StructureDefinition/observation-secondaryFinding
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for sequelTo. Sequel to referenced Observation. See http://hl7.org/fhir/StructureDefinition/observation-sequelTo
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for specimenCode. A code representing the the type of specimen used for this observation. Should only be used if not implicit in the code found in `Observation.code`. See http://hl7.org/fhir/StructureDefinition/observation-specimenCode
Unique id for inter-element referencing
Value of extension
Codes providing the status of an observation. See http://hl7.org/fhir/observation-status
(message has no fields)
Used in: , , , , , ,
Auto-generated from StructureDefinition for timeOffset. Time Offset for interlacing. See http://hl7.org/fhir/StructureDefinition/observation-timeOffset
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Variant. Variant. See http://hl7.org/fhir/StructureDefinition/observation-geneticsVariant
Unique id for inter-element referencing
Additional content defined by implementations
HGVS nomenclature for observed DNA sequence variant
DNA sequence variant ID
DNA sequence variant type
Auto-generated from StructureDefinition for oid. Primitive Type oid. See http://hl7.org/fhir/StructureDefinition/oid
Used in: , , , , , , , , ,
Primitive value for oid
xml:id (or equivalent in JSON)
Additional content defined by implementations
Auto-generated from StructureDefinition for OperationDefinition. Definition of an operation or a named query. See http://hl7.org/fhir/StructureDefinition/OperationDefinition
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this operation definition, represented as a URI (globally unique)
Business version of the operation definition
Name for this operation definition (computer friendly)
Name for this operation definition (human friendly)
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the operation definition
The context that the content is intended to support
Intended jurisdiction for operation definition (if applicable)
Why this operation definition is defined
Whether content is changed by the operation
Name used to invoke the operation
Additional information about use
Marks this as a profile of the base
Invoke at the system level?
Invoke at the type level?
Invoke on an instance?
Validation information for in parameters
Validation information for out parameters
operation | query
Used in:
Define overloaded variants for when generating code
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Name of parameter to include in overload
Comments to go on overload
Parameters for the operation/query
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Name in Parameters.parameter.name or in URL
Minimum Cardinality
Maximum Cardinality (a number or *)
Description of meaning/use
If type is Reference | canonical, allowed targets
Parts of a nested Parameter
ValueSet details if this is coded
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Source of value set
required | extensible | preferred | example
Used in:
References to this parameter
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Referencing parameter
Element id of reference
number | date | string | token | reference | composite | quantity | uri | special
Used in:
What type this parameter has
Used in:
in | out
Used in:
Types this operation applies to
Used in:
draft | active | retired | unknown
Used in:
Auto-generated from StructureDefinition for allowed-type. Which types are allowed for a parameter, when the base type is Abstract. See http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for profile. Profiles (StructureDefinition or IG) - one must apply. See http://hl7.org/fhir/StructureDefinition/operationdefinition-profile
Unique id for inter-element referencing
Value of extension
Whether an operation is a normal operation or a query. See http://hl7.org/fhir/operation-kind
(message has no fields)
Used in:
Auto-generated from StructureDefinition for OperationOutcome. Information about the success/failure of an action. See http://hl7.org/fhir/StructureDefinition/OperationOutcome
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
A single issue associated with the action
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Additional details about the error
Additional diagnostic information about the issue
Deprecated: Path of element(s) related to issue
FHIRPath of element(s) related to issue
Error or warning code
Used in:
fatal | error | warning | information
Used in:
Auto-generated from StructureDefinition for authority. Reference to where the rule is defined. See http://hl7.org/fhir/StructureDefinition/operationoutcome-authority
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for detectedIssue. Reference to a contra-indication that is the basis for this error. See http://hl7.org/fhir/StructureDefinition/operationoutcome-detectedIssue
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for issue-source. Source of a validation message. See http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-source
Unique id for inter-element referencing
Value of extension
Whether an operation parameter is an input or an output parameter. See http://hl7.org/fhir/operation-parameter-use
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for Ordinal Value. Assigned Ordinal Value. See http://hl7.org/fhir/StructureDefinition/ordinalValue
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Organization. A grouping of people or organizations with a common purpose. See http://hl7.org/fhir/StructureDefinition/Organization
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Identifies this organization across multiple systems
Whether the organization's record is still in active use
Kind of organization
Name used for the organization
A list of alternate names that the organization is known as, or was known as in the past
A contact detail for the organization
An address for the organization
The organization of which this organization forms a part
Technical endpoints providing access to services operated for the organization
Contact for the organization for a certain purpose
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The type of contact
A name associated with the contact
Contact details (telephone, email, etc.) for a contact
Visiting or postal addresses for the contact
Auto-generated from StructureDefinition for OrganizationAffiliation. Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship. See http://hl7.org/fhir/StructureDefinition/OrganizationAffiliation
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business identifiers that are specific to this role
Whether this organization affiliation record is in active use
The period during which the participatingOrganization is affiliated with the primary organization
Organization where the role is available
Organization that provides/performs the role (e.g. providing services or is a member of)
Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
Definition of the role the participatingOrganization plays
Specific specialty of the participatingOrganization in the context of the role
The location(s) at which the role occurs
Healthcare services provided through the role
Contact details at the participatingOrganization relevant to this Affiliation
Technical endpoints providing access to services operated for this role
Auto-generated from StructureDefinition for primaryInd. Indicator of primary specialty. See http://hl7.org/fhir/StructureDefinition/organizationaffiliation-primaryInd
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for period. Extension. See http://hl7.org/fhir/StructureDefinition/organization-period
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for preferredContact. Extension. See http://hl7.org/fhir/StructureDefinition/organization-preferredContact
Unique id for inter-element referencing
Value of extension
Type for orientation. See http://hl7.org/fhir/orientation-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Original Text. Original Text that represents the data as seen/selected/uttered originally. See http://hl7.org/fhir/StructureDefinition/originalText
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ParameterDefinition. Definition of a parameter to a module. See http://hl7.org/fhir/StructureDefinition/ParameterDefinition
Used in: , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Name used to access the parameter value
Minimum cardinality
Maximum cardinality (a number of *)
A brief description of the parameter
What profile the value is expected to be
What type of value
Used in:
in | out
Used in:
Auto-generated from StructureDefinition for Parameters. Operation Request or Response. See http://hl7.org/fhir/StructureDefinition/Parameters
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Operation Parameter
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Name from the definition
If parameter is a whole resource
Named part of a multi-part parameter
If parameter is a data type
Used in:
Auto-generated from StructureDefinition for fullUrl. fullUrl for resource. See http://hl7.org/fhir/StructureDefinition/parameters-fullUrl
Unique id for inter-element referencing
Value of extension
The value set includes the v3 RoleCode PRN (parent), TWIN (twin) and all of their specializations. It covers the relationships needed to establish genetic pedigree relationships between family members. See http://hl7.org/fhir/ValueSet/parent-relationship-codes
(message has no fields)
Auto-generated from StructureDefinition for partOf. Part of referenced event. See http://hl7.org/fhir/StructureDefinition/event-partOf
Unique id for inter-element referencing
Value of extension
Is the Participant required to attend the appointment. See http://hl7.org/fhir/participantrequired
(message has no fields)
Used in:
The Participation status of an appointment. See http://hl7.org/fhir/participationstatus
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for Patient. Information about an individual or animal receiving health care services. See http://hl7.org/fhir/StructureDefinition/Patient
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
An identifier for this patient
Whether this patient's record is in active use
A name associated with the patient
A contact detail for the individual
The date of birth for the individual
An address for the individual
Marital (civil) status of a patient
Image of the patient
Patient's nominated primary care provider
Organization that is the custodian of the patient record
A language which may be used to communicate with the patient about his or her health
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The language which can be used to communicate with the patient about his or her health
Language preference indicator
A contact party (e.g. guardian, partner, friend) for the patient
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The kind of relationship
A name associated with the contact person
A contact detail for the person
Address for the contact person
Organization that is associated with the contact
The period during which this contact person or organization is valid to be contacted relating to this patient
male | female | other | unknown
Used in:
Indicates if the individual is deceased or not
Used in:
male | female | other | unknown
Used in:
Link to another patient resource that concerns the same actual person
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The other patient or related person resource that the link refers to
replaced-by | replaces | refer | seealso
Used in:
Whether patient is part of a multiple birth
Used in:
Auto-generated from StructureDefinition for adoptionInfo. The adoption status of the patient. See http://hl7.org/fhir/StructureDefinition/patient-adoptionInfo
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for animal. This patient is known to be an animal (non-human). See http://hl7.org/fhir/StructureDefinition/patient-animal
Unique id for inter-element referencing
Additional content defined by implementations
The animal species. E.g. Dog, Cow.
The animal breed. E.g. Poodle, Angus.
The status of the animal's reproductive parts. E.g. Neutered, Intact.
Auto-generated from StructureDefinition for birthPlace. Place of Birth for patient. See http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for birthTime. Time of day of birth. See http://hl7.org/fhir/StructureDefinition/patient-birthTime
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for cadavericDonor. Post-mortem donor status. See http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for citizenship. Nation(s) where the patient claims citizenship. See http://hl7.org/fhir/StructureDefinition/patient-citizenship
Unique id for inter-element referencing
Additional content defined by implementations
Nation code of citizenship
Time period of citizenship
Auto-generated from StructureDefinition for congregation. A group of place of religious practice. See http://hl7.org/fhir/StructureDefinition/patient-congregation
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for disability. Condition(s) limiting movement, senses, or activities. See http://hl7.org/fhir/StructureDefinition/patient-disability
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for genderIdentity. The patient's gender identity. See http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for importance. Special status given the patient. See http://hl7.org/fhir/StructureDefinition/patient-importance
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for interpreterRequired. Whether the patient needs an interpreter. See http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for mothersMaidenName. Mother's Maiden name. See http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for nationality. Nationality. See http://hl7.org/fhir/StructureDefinition/patient-nationality
Unique id for inter-element referencing
Additional content defined by implementations
Nationality Code
Nationality Period
Auto-generated from StructureDefinition for preferenceType. The type of the patient's preferred language. See http://hl7.org/fhir/StructureDefinition/patient-preferenceType
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for proficiency. Proficiency level of the communication. See http://hl7.org/fhir/StructureDefinition/patient-proficiency
Unique id for inter-element referencing
Additional content defined by implementations
The proficiency level of the communication
The proficiency type of the communication
Auto-generated from StructureDefinition for relatedPerson. This contact may have further details in this RelatedPerson. See http://hl7.org/fhir/StructureDefinition/patient-relatedPerson
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for religion. The patient's professed religious affiliations. See http://hl7.org/fhir/StructureDefinition/patient-religion
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for PaymentNotice. PaymentNotice request. See http://hl7.org/fhir/StructureDefinition/PaymentNotice
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier for the payment noctice
Request reference
Response reference
Creation date
Responsible practitioner
Payment reference
Payment or clearing date
Party being paid
Party being notified
Monetary amount of the payment
Issued or cleared Status of the payment
active | cancelled | draft | entered-in-error
Used in:
Auto-generated from StructureDefinition for PaymentReconciliation. PaymentReconciliation resource. See http://hl7.org/fhir/StructureDefinition/PaymentReconciliation
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier for a payment reconciliation
Period covered
Creation date
Party generating payment
Reference to requesting resource
Responsible practitioner
Disposition message
When payment issued
Total amount of Payment
Business identifier for the payment
Printed form identifier
Settlement particulars
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Business identifier of the payment detail
Business identifier of the prior payment detail
Category of payment
Request giving rise to the payment
Submitter of the request
Response committing to a payment
Date of commitment to pay
Contact for the response
Recipient of the payment
Amount allocated to this payable
Note concerning processing
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Note explanatory text
display | print | printoper
Used in:
queued | complete | error | partial
Used in:
active | cancelled | draft | entered-in-error
Used in:
Auto-generated from StructureDefinition for performerFunction. Type of performance. See http://hl7.org/fhir/StructureDefinition/event-performerFunction
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Period. Time range defined by start and end date/time. See http://hl7.org/fhir/StructureDefinition/Period
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Starting time with inclusive boundary
End time with inclusive boundary, if not ongoing
Auto-generated from StructureDefinition for permitted-value-conceptmap. Mapping from permitted to transmitted. See http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for permitted-value-valueset. Permitted values. See http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Person. A generic person record. See http://hl7.org/fhir/StructureDefinition/Person
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
A human identifier for this person
A name associated with the person
A contact detail for the person
The date on which the person was born
One or more addresses for the person
Image of the person
The organization that is the custodian of the person record
This person's record is in active use
male | female | other | unknown
Used in:
Link to a resource that concerns the same actual person
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The resource to which this actual person is associated
level1 | level2 | level3 | level4
Used in:
Auto-generated from StructureDefinition for PlanDefinition. The definition of a plan for a series of actions, independent of any specific patient or context. See http://hl7.org/fhir/StructureDefinition/PlanDefinition
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this plan definition, represented as a URI (globally unique)
Additional identifier for the plan definition
Business version of the plan definition
Name for this plan definition (computer friendly)
Name for this plan definition (human friendly)
Subordinate title of the plan definition
order-set | clinical-protocol | eca-rule | workflow-definition
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the plan definition
The context that the content is intended to support
Intended jurisdiction for plan definition (if applicable)
Why this plan definition is defined
Describes the clinical usage of the plan
Use and/or publishing restrictions
When the plan definition was approved by publisher
When the plan definition was last reviewed
When the plan definition is expected to be used
E.g. Education, Treatment, Assessment
Who authored the content
Who edited the content
Who reviewed the content
Who endorsed the content
Additional documentation, citations
Logic used by the plan definition
Action defined by the plan
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
User-visible prefix for the action (e.g. 1. or A.)
User-visible title
Brief description of the action
Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Code representing the meaning of the action or sub-actions
Why the action should be performed
Supporting documentation for the intended performer of the action
What goals this action supports
When the action should be triggered
Input data requirements
Output data definition
create | update | remove | fire-event
Transform to apply the template
A sub-action
single | multiple
Used in:
Whether or not the action is applicable
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Boolean-valued expression
applicability | start | stop
Used in:
Description of the activity to be performed
Used in:
Dynamic aspects of the definition
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The path to the element to be set dynamically
An expression that provides the dynamic value for the customization
visual-group | logical-group | sentence-group
Used in:
Who should participate in the action
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
E.g. Nurse, Surgeon, Parent
patient | practitioner | related-person | device
Used in:
yes | no
Used in:
routine | urgent | asap | stat
Used in:
Relationship to another action
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
What action is this related to
Time offset for the relationship
Used in:
before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Used in:
must | could | must-unless-documented
Used in:
any | all | all-or-none | exactly-one | at-most-one | one-or-more
Used in:
Type of individual the action is focused on
Used in:
When the action should take place
Used in:
What the plan is trying to accomplish
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
E.g. Treatment, dietary, behavioral
Code or text describing the goal
high-priority | medium-priority | low-priority
When goal pursuit begins
What does the goal address
Supporting documentation for the goal
Target outcome for the goal
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The parameter whose value is to be tracked
Reach goal within
The target value to be achieved
Used in:
draft | active | retired | unknown
Used in:
Type of individual the plan definition is focused on
Used in:
Auto-generated from StructureDefinition for cdsHooksEndpoint. Surface this ECA Rule here. See http://hl7.org/fhir/StructureDefinition/cqf-cdsHooksEndpoint
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Population. A definition of a set of people that apply to some clinically related context, for example people contraindicated for a certain medication. See http://hl7.org/fhir/StructureDefinition/Population
Used in: , ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The gender of the specific population
Race of the specific population
The existing physiological conditions of the specific population to which this applies
The age of the specific population
Used in:
Auto-generated from StructureDefinition for positiveInt. Primitive Type positiveInt. See http://hl7.org/fhir/StructureDefinition/positiveInt
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Primitive value for positiveInt
xml:id (or equivalent in JSON)
Additional content defined by implementations
Uses of an address not included in Address.use. See http://hl7.org/fhir/ValueSet/postal-address-use
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Practitioner. A person with a formal responsibility in the provisioning of healthcare or related services. See http://hl7.org/fhir/StructureDefinition/Practitioner
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
An identifier for the person as this agent
Whether this practitioner's record is in active use
The name(s) associated with the practitioner
A contact detail for the practitioner (that apply to all roles)
Address(es) of the practitioner that are not role specific (typically home address)
The date on which the practitioner was born
Image of the person
A language the practitioner can use in patient communication
male | female | other | unknown
Used in:
Certification, licenses, or training pertaining to the provision of care
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
An identifier for this qualification for the practitioner
Coded representation of the qualification
Period during which the qualification is valid
Organization that regulates and issues the qualification
Auto-generated from StructureDefinition for PractitionerRole. Roles/organizations the practitioner is associated with. See http://hl7.org/fhir/StructureDefinition/PractitionerRole
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifiers that are specific to a role/location
Whether this practitioner role record is in active use
The period during which the practitioner is authorized to perform in these role(s)
Practitioner that is able to provide the defined services for the organization
Organization where the roles are available
Roles which this practitioner may perform
Specific specialty of the practitioner
The location(s) at which this practitioner provides care
The list of healthcare services that this worker provides for this role's Organization/Location(s)
Contact details that are specific to the role/location/service
Description of availability exceptions
Technical endpoints providing access to services operated for the practitioner with this role
Times the Service Site is available
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Always available? e.g. 24 hour service
Opening time of day (ignored if allDay = true)
Closing time of day (ignored if allDay = true)
mon | tue | wed | thu | fri | sat | sun
Used in:
Not available during this time due to provided reason
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Reason presented to the user explaining why time not available
Service not available from this date
Auto-generated from StructureDefinition for primaryInd. Indicator of primary specialty. See http://hl7.org/fhir/StructureDefinition/practitionerrole-primaryInd
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for preferred. Preferred. See http://hl7.org/fhir/StructureDefinition/iso21090-preferred
Unique id for inter-element referencing
Value of extension
Codes specifying the type of probability distribution. See http://hl7.org/fhir/ValueSet/probability-distribution-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Procedure. An action that is being or was performed on a patient. See http://hl7.org/fhir/StructureDefinition/Procedure
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External Identifiers for this procedure
Instantiates FHIR protocol or definition
Instantiates external protocol or definition
A request for this procedure
Part of referenced event
Reason for current status
Classification of the procedure
Identification of the procedure
Who the procedure was performed on
Encounter created as part of
Who recorded the procedure
Person who asserts this procedure
Where the procedure happened
Coded reason procedure performed
The justification that the procedure was performed
Target body sites
The result of procedure
Any report resulting from the procedure
Complication following the procedure
A condition that is a result of the procedure
Instructions for follow up
Additional information about the procedure
Items used during procedure
Coded items used during the procedure
Manipulated, implanted, or removed device
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Kind of change to device
Device that was changed
When the procedure was performed
Used in:
The people who performed the procedure
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of performance
The reference to the practitioner
Organization the device or practitioner was acting for
preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Used in:
Auto-generated from StructureDefinition for causedBy. Related item that caused this procedure. See http://hl7.org/fhir/StructureDefinition/procedure-causedBy
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for incisionDateTime. The first incision time. See http://hl7.org/fhir/StructureDefinition/procedure-incisionDateTime
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for method. The method used to perform the procedure. See http://hl7.org/fhir/StructureDefinition/procedure-method
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for progressStatus. A details procedure progress. See http://hl7.org/fhir/StructureDefinition/procedure-progressStatus
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for schedule. Schedule followed. See http://hl7.org/fhir/StructureDefinition/procedure-schedule
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for ProdCharacteristic. The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available. See http://hl7.org/fhir/StructureDefinition/ProdCharacteristic
Used in: , ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Where applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
Where applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
Where applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
Where applicable, the weight can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
Where applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
Where applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
Where applicable, the imprint can be specified as text
Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations
Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
Auto-generated from StructureDefinition for ProductShelfLife. The shelf-life and storage information for a medicinal product item or container can be described using this class. See http://hl7.org/fhir/StructureDefinition/ProductShelfLife
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Unique identifier for the packaged Medicinal Product
This describes the shelf life, taking into account various scenarios such as shelf life of the packaged Medicinal Product itself, shelf life after transformation where necessary and shelf life after the first opening of a bottle, etc. The shelf life type shall be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified
The shelf life time period can be specified using a numerical value for the period of time and its unit of time measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
Special precautions for storage, if any, can be specified using an appropriate controlled vocabulary The controlled term and the controlled term identifier shall be specified
How a property is represented when serialized. See http://hl7.org/fhir/property-representation
(message has no fields)
Used in:
The type of a property value. See http://hl7.org/fhir/concept-property-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Provenance. Who, What, When for a set of resources. See http://hl7.org/fhir/StructureDefinition/Provenance
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Target Reference(s) (usually version specific)
When the activity was recorded / updated
Policy or plan the activity was defined by
Where the activity occurred, if relevant
Reason the activity is occurring
Activity that occurred
Signature on target
Actor involved
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
How the agent participated
What the agents role was
Who participated
Who the agent is representing
An entity used in this activity
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Identity of entity
Entity is attributed to this agent
derivation | revision | quotation | source | removal
Used in:
When the activity occurred
Used in:
How an entity was used in an activity. See http://hl7.org/fhir/provenance-entity-role
(message has no fields)
Used in: ,
The lifecycle status of an artifact. See http://hl7.org/fhir/publication-status
(message has no fields)
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Type for quality report. See http://hl7.org/fhir/quality-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Quantity. A measured or measurable amount. See http://hl7.org/fhir/StructureDefinition/Quantity
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Numerical value (with implicit precision)
Unit representation
System that defines coded unit form
Coded form of the unit
< | <= | >= | > - how to understand the value
Used in:
How the Quantity should be understood and represented. See http://hl7.org/fhir/quantity-comparator
(message has no fields)
Used in: , , , , ,
Auto-generated from StructureDefinition for PQ-translation. Same quantity with different units. See http://hl7.org/fhir/StructureDefinition/iso21090-PQ-translation
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for uncertainty. Standard Deviation (same units as the quantity). See http://hl7.org/fhir/StructureDefinition/iso21090-uncertainty
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for uncertaintyType. Probability Distribution Type for uncertainty. See http://hl7.org/fhir/StructureDefinition/iso21090-uncertaintyType
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for Questionnaire. A structured set of questions. See http://hl7.org/fhir/StructureDefinition/Questionnaire
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this questionnaire, represented as a URI (globally unique)
Additional identifier for the questionnaire
Business version of the questionnaire
Name for this questionnaire (computer friendly)
Name for this questionnaire (human friendly)
Instantiates protocol or definition
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the questionnaire
The context that the content is intended to support
Intended jurisdiction for questionnaire (if applicable)
Why this questionnaire is defined
Use and/or publishing restrictions
When the questionnaire was approved by publisher
When the questionnaire was last reviewed
When the questionnaire is expected to be used
Concept that represents the overall questionnaire
Questions and sections within the Questionnaire
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Unique id for item in questionnaire
ElementDefinition - details for the item
Corresponding concept for this item in a terminology
E.g. "1(a)", "2.5.3"
Primary text for the item
Whether the item must be included in data results
Whether the item may repeat
Don't allow human editing
No more than this many characters
Valueset containing permitted answers
Nested questionnaire items
Permitted answer
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Whether option is selected by default
Answer value
Used in:
all | any
Used in:
Only allow data when
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Question that determines whether item is enabled
Value for question comparison based on operator
Used in:
exists | = | != | > | < | >= | <=
Used in:
Initial value(s) when item is first rendered
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Actual value for initializing the question
Used in:
group | display | boolean | decimal | integer | date | dateTime +
Used in:
draft | active | retired | unknown
Used in:
Resource that can be subject of QuestionnaireResponse
Used in:
Auto-generated from StructureDefinition for baseType. Base Type for answer. See http://hl7.org/fhir/StructureDefinition/questionnaire-baseType
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for choiceOrientation. horizontal | vertical. See http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for constraint. Constraint. See http://hl7.org/fhir/StructureDefinition/questionnaire-constraint
Unique id for inter-element referencing
Additional content defined by implementations
Unique identifier
Why needed
Formal rule
Human-readable rule
Relative path to elements
error|warning
Used in:
Auto-generated from StructureDefinition for displayCategory. Purpose of rendered text. See http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for fhirType. The underlying FHIR data type. See http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for hidden. Don't display to user. See http://hl7.org/fhir/StructureDefinition/questionnaire-hidden
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for itemControl. E.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc. See http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl
Unique id for inter-element referencing
Value of extension
The criteria by which a question is enabled. See http://hl7.org/fhir/questionnaire-enable-operator
(message has no fields)
Used in:
Distinguishes groups from questions and display text and indicates data type for questions. See http://hl7.org/fhir/item-type
(message has no fields)
Used in:
Identifies the modes of usage of a questionnaire that should enable a particular questionnaire item. See http://terminology.hl7.org/CodeSystem/questionnaire-usage-mode
(message has no fields)
Used in:
Auto-generated from StructureDefinition for maxOccurs. Maximum repetitions. See http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for maxValue. Must be <= this value. See http://hl7.org/fhir/StructureDefinition/maxValue
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for minOccurs. Minimum repetitions. See http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for minValue. Must be >= this value. See http://hl7.org/fhir/StructureDefinition/minValue
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for optionExclusive. Option is exclusive. See http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for optionPrefix. E.g. "(a)", "1.", etc. See http://hl7.org/fhir/StructureDefinition/questionnaire-optionPrefix
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for referenceFilter. Filter to apply when looking up references. See http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for referenceProfile. Allowed profile for reference. See http://hl7.org/fhir/StructureDefinition/questionnaire-referenceProfile
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for referenceResource. Allowed resource for reference. See http://hl7.org/fhir/StructureDefinition/questionnaire-referenceResource
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for QuestionnaireResponse. A structured set of questions and their answers. See http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Unique id for this set of answers
Request fulfilled by this QuestionnaireResponse
Part of this action
Form being answered
The subject of the questions
Encounter created as part of
Date the answers were gathered
Person who received and recorded the answers
The person who answered the questions
Groups and questions
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Pointer to specific item from Questionnaire
ElementDefinition - details for the item
Name for group or question text
Nested questionnaire response items
The response(s) to the question
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Nested groups and questions
Single-valued answer to the question
Used in:
in-progress | completed | amended | entered-in-error | stopped
Used in:
Auto-generated from StructureDefinition for author. Who answered question/group. See http://hl7.org/fhir/StructureDefinition/questionnaireresponse-author
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for completionMode. E.g. Verbal, written, electronic. See http://hl7.org/fhir/StructureDefinition/questionnaireresponse-completionMode
Unique id for inter-element referencing
Value of extension
Codes describing how the QuestionnaireResponse was populated See http://hl7.org/fhir/ValueSet/questionnaireresponse-mode
(message has no fields)
Auto-generated from StructureDefinition for reason. Why response was created. See http://hl7.org/fhir/StructureDefinition/questionnaireresponse-reason
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for reviewer. Who verified completion of form?. See http://hl7.org/fhir/StructureDefinition/questionnaireresponse-reviewer
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for signature. A signature attesting to the content. See http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature
Unique id for inter-element referencing
Value of extension
Lifecycle status of the questionnaire response. See http://hl7.org/fhir/questionnaire-answers-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for signatureRequired. Is signature needed?. See http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for sliderStepValue. Increment value for slider. See http://hl7.org/fhir/StructureDefinition/questionnaire-sliderStepValue
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for supportLink. Supporting information. See http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for unit. Unit for numeric answer. See http://hl7.org/fhir/StructureDefinition/questionnaire-unit
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for unitOption. Unit choice. See http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for unitValueSet. Unit choices. See http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for usageMode. capture | display | display-non-empty | capture-display | capture-display-non-empty. See http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for Variable. Variable for processing. See http://hl7.org/fhir/StructureDefinition/variable
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Range. Set of values bounded by low and high. See http://hl7.org/fhir/StructureDefinition/Range
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Low limit
High limit
Auto-generated from StructureDefinition for Ratio. A ratio of two Quantity values - a numerator and a denominator. See http://hl7.org/fhir/StructureDefinition/Ratio
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Numerator value
Denominator value
Auto-generated from StructureDefinition for reasonCode. Why was event performed?. See http://hl7.org/fhir/StructureDefinition/workflow-reasonCode
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for reasonReference. Why was event performed?. See http://hl7.org/fhir/StructureDefinition/workflow-reasonReference
Unique id for inter-element referencing
Value of extension
A reference from one resource to another. See https://www.hl7.org/fhir/datatypes.html#Reference.
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
xml:id (or equivalent in JSON)
Additional Content defined by implementations
Type the reference refers to (e.g. "Patient") - must be a resource in resources
Logical reference, when literal reference is not known
Text alternative for the resource.
Field representing absolute URIs, which are untyped.
Field representing fragment URIs, which are untyped, and represented here without the leading '#'
Typed relative urls are represented here.
A set of flags that defines how references are supported. See http://hl7.org/fhir/reference-handling-policy
(message has no fields)
Used in:
Typed representation of relative references for the Reference.reference field. For instance, a JSON FHIR reference of 'Patient/1234' is represented in FhirProto as {patientId {value:'1234'} }, where patientId is a field of type ReferenceId.
Used in:
Id of the resource being referenced.
History version, if present.
xml:id (or equivalent in JSON)
Additional Content defined by implementations
Whether a reference needs to be version specific or version independent, or whether either can be used. See http://hl7.org/fhir/reference-version-rules
(message has no fields)
Used in:
Auto-generated from StructureDefinition for regex. Regular expression pattern. See http://hl7.org/fhir/StructureDefinition/regex
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for RelatedArtifact. Related artifacts for a knowledge resource. See http://hl7.org/fhir/StructureDefinition/RelatedArtifact
Used in: , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Short label
Brief description of the related artifact
Bibliographic citation for the artifact
Where the artifact can be accessed
What document is being referenced
What resource is being referenced
documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Used in:
Auto-generated from StructureDefinition for relatedArtifact. Documentation relevant to the 'parent' resource. See http://hl7.org/fhir/StructureDefinition/workflow-relatedArtifact
Unique id for inter-element referencing
Value of extension
The type of relationship to the related artifact. See http://hl7.org/fhir/related-artifact-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for RelatedPerson. A person that is related to a patient, but who is not a direct target of care. See http://hl7.org/fhir/StructureDefinition/RelatedPerson
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
A human identifier for this person
Whether this related person's record is in active use
The patient this person is related to
The nature of the relationship
A name associated with the person
A contact detail for the person
The date on which the related person was born
Address where the related person can be contacted or visited
Image of the person
Period of time that this relationship is considered valid
A language which may be used to communicate with about the patient's health
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The language which can be used to communicate with the patient about his or her health
Language preference indicator
male | female | other | unknown
Used in:
Auto-generated from StructureDefinition for Relative Date Criteria. Relative Date Criteria. See http://hl7.org/fhir/StructureDefinition/relative-date
Unique id for inter-element referencing
Additional content defined by implementations
Duration after the event
Event that the date is relative to
Used in:
before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Used in:
Auto-generated from StructureDefinition for relativeDateTime. A date/time that is specified relative to another event. See http://hl7.org/fhir/StructureDefinition/cqf-relativeDateTime
Unique id for inter-element referencing
Additional content defined by implementations
Relative to what event
Relative to which element on the event
How long
Used in:
before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Used in:
Auto-generated from StructureDefinition for relevantHistory. Key events in history of request. See http://hl7.org/fhir/StructureDefinition/request-relevantHistory
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Rendered Value. What should be displayed to human (if default is not appropriate). See http://hl7.org/fhir/StructureDefinition/rendered-value
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for replaces. References a resource that this resource replaces. See http://hl7.org/fhir/StructureDefinition/replaces
Unique id for inter-element referencing
Value of extension
Type for access of external URI. See http://hl7.org/fhir/repository-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for RequestGroup. A group of related requests. See http://hl7.org/fhir/StructureDefinition/RequestGroup
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business identifier
Instantiates FHIR protocol or definition
Instantiates external protocol or definition
Fulfills plan, proposal, or order
Request(s) replaced by this request
Composite request this is part of
What's being requested/ordered
Who the request group is about
Created as part of
When the request group was authored
Device or practitioner that authored the request group
Why the request group is needed
Why the request group is needed
Additional notes about the response
Proposed actions, if any
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
User-visible prefix for the action (e.g. 1. or A.)
User-visible title
Short description of the action
Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
Code representing the meaning of the action or sub-actions
Supporting documentation for the intended performer of the action
Who should perform the action
create | update | remove | fire-event
The target of the action
Sub action
single | multiple
Used in:
Whether or not the action is applicable
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Boolean-valued expression
applicability | start | stop
Used in:
visual-group | logical-group | sentence-group
Used in:
yes | no
Used in:
routine | urgent | asap | stat
Used in:
Relationship to another action
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
What action this is related to
Time offset for the relationship
Used in:
before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Used in:
must | could | must-unless-documented
Used in:
any | all | all-or-none | exactly-one | at-most-one | one-or-more
Used in:
When the action should take place
Used in:
proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Used in:
routine | urgent | asap | stat
Used in:
draft | active | on-hold | revoked | completed | entered-in-error | unknown
Used in:
Codes indicating the degree of authority/intentionality associated with a request. See http://hl7.org/fhir/request-intent
(message has no fields)
Used in: , , , ,
Identifies the level of importance to be assigned to actioning the request. See http://hl7.org/fhir/request-priority
(message has no fields)
Used in: , , , , , , , , , , ,
A list of all the request resource types defined in this version of the FHIR specification. See http://hl7.org/fhir/request-resource-types
(message has no fields)
Used in:
Codes identifying the lifecycle stage of a request. See http://hl7.org/fhir/request-status
(message has no fields)
Used in: , , , , , ,
Auto-generated from StructureDefinition for ResearchDefinition. A research context or question. See http://hl7.org/fhir/StructureDefinition/ResearchDefinition
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this research definition, represented as a URI (globally unique)
Additional identifier for the research definition
Business version of the research definition
Name for this research definition (computer friendly)
Name for this research definition (human friendly)
Title for use in informal contexts
Subordinate title of the ResearchDefinition
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the research definition
Used for footnotes or explanatory notes
The context that the content is intended to support
Intended jurisdiction for research definition (if applicable)
Why this research definition is defined
Describes the clinical usage of the ResearchDefinition
Use and/or publishing restrictions
When the research definition was approved by publisher
When the research definition was last reviewed
When the research definition is expected to be used
The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.
Who authored the content
Who edited the content
Who reviewed the content
Who endorsed the content
Additional documentation, citations, etc.
Logic used by the ResearchDefinition
What population?
What exposure?
What alternative exposure state?
What outcome?
draft | active | retired | unknown
Used in:
E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Used in:
Auto-generated from StructureDefinition for ResearchElementDefinition. A population, intervention, or exposure definition. See http://hl7.org/fhir/StructureDefinition/ResearchElementDefinition
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this research element definition, represented as a URI (globally unique)
Additional identifier for the research element definition
Business version of the research element definition
Name for this research element definition (computer friendly)
Name for this research element definition (human friendly)
Title for use in informal contexts
Subordinate title of the ResearchElementDefinition
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the research element definition
Used for footnotes or explanatory notes
The context that the content is intended to support
Intended jurisdiction for research element definition (if applicable)
Why this research element definition is defined
Describes the clinical usage of the ResearchElementDefinition
Use and/or publishing restrictions
When the research element definition was approved by publisher
When the research element definition was last reviewed
When the research element definition is expected to be used
The category of the ResearchElementDefinition, such as Education, Treatment, Assessment, etc.
Who authored the content
Who edited the content
Who reviewed the content
Who endorsed the content
Additional documentation, citations, etc.
Logic used by the ResearchElementDefinition
What defines the members of the research element
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
What code/value pairs define members?
Whether the characteristic includes or excludes members
What unit is the outcome described in?
What time period does the study cover
Observation time from study start
What time period do participants cover
Observation time from study start
What code or expression defines members?
Used in:
mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
Used in:
What time period do participants cover
Used in:
mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
Used in:
What time period does the study cover
Used in:
draft | active | retired | unknown
Used in:
E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Used in:
population | exposure | outcome
Used in:
dichotomous | continuous | descriptive
Used in:
The possible types of research elements (E.g. Population, Exposure, Outcome). See http://hl7.org/fhir/research-element-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for ResearchStudy. Investigation to increase healthcare-related patient-independent knowledge. See http://hl7.org/fhir/StructureDefinition/ResearchStudy
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier for study
Name for this study
Steps followed in executing study
Part of larger study
treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility
n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4
Classifications for the study
Drugs, devices, etc. under study
Condition being studied
Contact details for the study
References and dependencies
Used to search for the study
Geographic region(s) for study
What this is study doing
Inclusion & exclusion criteria
When the study began and ended
Organization that initiates and is legally responsible for the study
Researcher who oversees multiple aspects of the study
Facility where study activities are conducted
accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design
Comments made about the study
Defined path through the study for a subject
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Label for study arm
Categorization of study arm
Short explanation of study path
A goal for the study
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Label for the objective
primary | secondary | exploratory
active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn
Used in:
Auto-generated from StructureDefinition for researchStudy. Associated research study. See http://hl7.org/fhir/StructureDefinition/workflow-researchStudy
Unique id for inter-element referencing
Value of extension
Codes that convey the current status of the research study. See http://hl7.org/fhir/research-study-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for ResearchSubject. Physical entity which is the primary unit of interest in the study. See http://hl7.org/fhir/StructureDefinition/ResearchSubject
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier for research subject in a study
Start and end of participation
Study subject is part of
Who is part of study
What path should be followed
What path was followed
Agreement to participate in study
candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn
Used in:
Indicates the progression of a study subject through a study. See http://hl7.org/fhir/research-subject-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Resource. Base Resource. See http://hl7.org/fhir/StructureDefinition/Resource
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Auto-generated from StructureDefinition for pertainsToGoal. Pertains to goal. See http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
Unique id for inter-element referencing
Value of extension
Provides general guidance around the kind of access Control to Read, Search, Create, Update, or Delete a resource. See http://terminology.hl7.org/CodeSystem/resource-security-category
(message has no fields)
Used in:
One of the resource types defined as part of this version of FHIR. See http://hl7.org/fhir/resource-types
(message has no fields)
Used in: , , , , , , , , , , ,
How the system supports versioning for a resource. See http://hl7.org/fhir/versioning-policy
(message has no fields)
Used in:
The kind of response to a message. See http://hl7.org/fhir/response-code
(message has no fields)
Used in:
The mode of a RESTful capability statement. See http://hl7.org/fhir/restful-capability-mode
(message has no fields)
Used in:
Auto-generated from StructureDefinition for risk. Risk. See http://hl7.org/fhir/StructureDefinition/diagnosticReport-risk
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for RiskAssessment. Potential outcomes for a subject with likelihood. See http://hl7.org/fhir/StructureDefinition/RiskAssessment
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Unique identifier for the assessment
Request fulfilled by this assessment
Part of this occurrence
Evaluation mechanism
Type of assessment
Who/what does assessment apply to?
Where was assessment performed?
Condition assessed
Who did assessment?
Why the assessment was necessary?
Why the assessment was necessary?
Information used in assessment
How to reduce risk
Comments on the risk assessment
When was assessment made?
Used in:
Outcome predicted
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Possible outcome for the subject
Likelihood of specified outcome as a qualitative value
Relative likelihood
Explanation of prediction
Likelihood of specified outcome
Used in:
Timeframe or age range
Used in:
registered | preliminary | final | amended +
Used in:
Auto-generated from StructureDefinition for RiskEvidenceSynthesis. A quantified estimate of risk based on a body of evidence. See http://hl7.org/fhir/StructureDefinition/RiskEvidenceSynthesis
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this risk evidence synthesis, represented as a URI (globally unique)
Additional identifier for the risk evidence synthesis
Business version of the risk evidence synthesis
Name for this risk evidence synthesis (computer friendly)
Name for this risk evidence synthesis (human friendly)
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the risk evidence synthesis
Used for footnotes or explanatory notes
The context that the content is intended to support
Intended jurisdiction for risk evidence synthesis (if applicable)
Use and/or publishing restrictions
When the risk evidence synthesis was approved by publisher
When the risk evidence synthesis was last reviewed
When the risk evidence synthesis is expected to be used
The category of the EffectEvidenceSynthesis, such as Education, Treatment, Assessment, etc.
Who authored the content
Who edited the content
Who reviewed the content
Who endorsed the content
Additional documentation, citations, etc.
Type of synthesis
Type of study
What population?
What exposure?
What outcome?
How certain is the risk
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Certainty rating
Used for footnotes or explanatory notes
A component that contributes to the overall certainty
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of subcomponent of certainty rating
Subcomponent certainty rating
Used for footnotes or explanatory notes
What was the estimated risk
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Description of risk estimate
Type of risk estimate
Point estimate
What unit is the outcome described in?
Sample size for group measured
Number with the outcome
How precise the estimate is
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type of precision estimate
Level of confidence interval
Lower bound
Upper bound
What sample size was involved?
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Description of sample size
How many studies?
How many participants?
draft | active | retired | unknown
Used in:
The license that applies to an Implementation Guide (using an SPDX license Identifiers, or 'not-open-source'). The binding is required but new SPDX license Identifiers are allowed to be used (https://spdx.org/licenses/). See http://hl7.org/fhir/spdx-license
(message has no fields)
Used in:
Auto-generated from StructureDefinition for SampledData. A series of measurements taken by a device. See http://hl7.org/fhir/StructureDefinition/SampledData
Used in: , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Zero value and units
Number of milliseconds between samples
Multiply data by this before adding to origin
Lower limit of detection
Upper limit of detection
Number of sample points at each time point
Decimal values with spaces, or "E" | "U" | "L"
Auto-generated from StructureDefinition for Schedule. A container for slots of time that may be available for booking appointments. See http://hl7.org/fhir/StructureDefinition/Schedule
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External Ids for this item
Whether this schedule is in active use
High-level category
Specific service
Type of specialty needed
Resource(s) that availability information is being provided for
Period of time covered by schedule
Comments on availability
What Search Comparator Codes are supported in search. See http://hl7.org/fhir/search-comparator
(message has no fields)
Used in:
Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. See http://hl7.org/fhir/search-entry-mode
(message has no fields)
Used in:
A supported modifier for a search parameter. See http://hl7.org/fhir/search-modifier-code
(message has no fields)
Used in:
Data types allowed to be used for search parameters. See http://hl7.org/fhir/search-param-type
(message has no fields)
Used in: , ,
Auto-generated from StructureDefinition for SearchParameter. Search parameter for a resource. See http://hl7.org/fhir/StructureDefinition/SearchParameter
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this search parameter, represented as a URI (globally unique)
Business version of the search parameter
Name for this search parameter (computer friendly)
Original definition for the search parameter
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the search parameter
The context that the content is intended to support
Intended jurisdiction for search parameter (if applicable)
Why this search parameter is defined
Code used in URL
FHIRPath expression that extracts the values
XPath that extracts the values
Allow multiple values per parameter (or)
Allow multiple parameters (and)
Chained names supported
The resource type(s) this search parameter applies to
Used in:
eq | ne | gt | lt | ge | le | sa | eb | ap
Used in:
For Composite resources to define the parts
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Defines how the part works
Subexpression relative to main expression
missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
Used in:
draft | active | retired | unknown
Used in:
Types of resource (if a resource reference)
Used in:
number | date | string | token | reference | composite | quantity | uri | special
Used in:
normal | phonetic | nearby | distance | other
Used in:
Type if a sequence -- DNA, RNA, or amino acid sequence. See http://hl7.org/fhir/sequence-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for ServiceRequest. A request for a service to be performed. See http://hl7.org/fhir/StructureDefinition/ServiceRequest
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Identifiers assigned to this order
Instantiates FHIR protocol or definition
Instantiates external protocol or definition
What request fulfills
What request replaces
Composite Request ID
Classification of service
True if service/procedure should not be performed
What is being requested/ordered
Additional order information
Individual or Entity the service is ordered for
Encounter in which the request was created
Date request signed
Who/what is requesting service
Performer role
Requested performer
Requested location
Requested location
Explanation/Justification for procedure or service
Explanation/Justification for service or service
Associated insurance coverage
Additional clinical information
Procedure Samples
Location on Body
Comments
Patient or consumer-oriented instructions
Request provenance
Preconditions for service
Used in:
proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Used in:
When service should occur
Used in:
routine | urgent | asap | stat
Used in:
Service amount
Used in:
draft | active | on-hold | revoked | completed | entered-in-error | unknown
Used in:
Auto-generated from StructureDefinition for performerOrder. Performer Order. See http://hl7.org/fhir/StructureDefinition/request-performerOrder
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for precondition. The condition or state of the patient for this test. See http://hl7.org/fhir/StructureDefinition/servicerequest-precondition
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for questionnaireRequest. Questionnaire to be ordered. See http://hl7.org/fhir/StructureDefinition/servicerequest-questionnaireRequest
Unique id for inter-element referencing
Value of extension
The value set includes the v3 RoleCode SIB (sibling) and all of its specializations. It covers the relationships needed to establish genetic pedigree relationships between family members. See http://hl7.org/fhir/ValueSet/sibling-relationship-codes
(message has no fields)
Auto-generated from StructureDefinition for Signature. A Signature - XML DigSig, JWS, Graphical image of signature, etc. See http://hl7.org/fhir/StructureDefinition/Signature
Used in: , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Indication of the reason the entity signed the object(s)
When the signature was created
Who signed
The party represented
The actual signature content (XML DigSig. JWS, picture, etc.)
The technical format of the signature
Used in:
This valueset is not enumerable, and so is represented as a string.
The technical format of the signed resources
Used in:
This valueset is not enumerable, and so is represented as a string.
Auto-generated from StructureDefinition for SimpleQuantity. A fixed quantity (no comparator). See http://hl7.org/fhir/StructureDefinition/SimpleQuantity
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Numerical value (with implicit precision)
Unit representation
System that defines coded unit form
Coded form of the unit
How slices are interpreted when evaluating an instance. See http://hl7.org/fhir/resource-slicing-rules
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Slot. A slot of time on a schedule that may be available for booking appointments. See http://hl7.org/fhir/StructureDefinition/Slot
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External Ids for this item
A broad categorization of the service that is to be performed during this appointment
The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource
The specialty of a practitioner that would be required to perform the service requested in this appointment
The style of appointment or patient that may be booked in the slot (not service type)
The schedule resource that this slot defines an interval of status information
Date/Time that the slot is to begin
Date/Time that the slot is to conclude
This slot has already been overbooked, appointments are unlikely to be accepted for this time
Comments on the slot to describe any extended information. Such as custom constraints on the slot
busy | free | busy-unavailable | busy-tentative | entered-in-error
Used in:
The free/busy status of the slot. See http://hl7.org/fhir/slotstatus
(message has no fields)
Used in:
Codes that define what the server is capable of. See http://terminology.hl7.org/CodeSystem/smart-capabilities
(message has no fields)
Used in:
The possible sort directions, ascending or descending. See http://hl7.org/fhir/sort-direction
(message has no fields)
Used in:
Auto-generated from StructureDefinition for special-status. Special note about status for implementers. See http://hl7.org/fhir/StructureDefinition/valueset-special-status
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Specimen. Sample for analysis. See http://hl7.org/fhir/StructureDefinition/Specimen
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External Identifier
Identifier assigned by the lab
Kind of material that forms the specimen
Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
The time when specimen was received for processing
Specimen from which this specimen originated
Why the specimen was collected
State of the specimen
Comments
Collection details
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Who collected the specimen
How long it took to collect specimen
The quantity of specimen collected
Technique used to perform collection
Anatomical collection site
Collection time
Used in:
Whether or how long patient abstained from food and/or drink
Used in:
Direct container of specimen (tube/slide, etc.)
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Id for the container
Textual description of the container
Kind of container directly associated with specimen
Container volume or size
Quantity of specimen within container
Additive associated with container
Used in:
Processing and processing step details
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Textual description of procedure
Indicates the treatment step applied to the specimen
Material used in the processing step
Date and time of specimen processing
Used in:
available | unavailable | unsatisfactory | entered-in-error
Used in:
Auto-generated from StructureDefinition for collectionPriority. Urgency for collection. See http://hl7.org/fhir/StructureDefinition/specimen-collectionPriority
Unique id for inter-element referencing
Value of extension
Degree of preference of a type of conditioned specimen. See http://hl7.org/fhir/specimen-contained-preference
(message has no fields)
Used in:
Auto-generated from StructureDefinition for SpecimenDefinition. Kind of specimen. See http://hl7.org/fhir/StructureDefinition/SpecimenDefinition
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business identifier of a kind of specimen
Kind of material to collect
Patient preparation for collection
Time aspect for collection
Specimen collection procedure
Specimen in container intended for testing by lab
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Primary or secondary specimen
Type of intended specimen
Specimen requirements
Specimen retention time
Rejection criterion
The specimen's container
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Container material
Kind of container associated with the kind of specimen
Color of container cap
Container description
Container capacity
Specimen container preparation
Additive associated with container
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Additive associated with container
Used in:
Minimum volume
Used in:
Specimen handling before testing
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Temperature qualifier
Temperature range
Maximum preservation time
Preservation instruction
preferred | alternate
Used in:
Auto-generated from StructureDefinition for isDryWeight. Whether quantity is a dry weight. See http://hl7.org/fhir/StructureDefinition/specimen-isDryWeight
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for processingTime. Time of processing. See http://hl7.org/fhir/StructureDefinition/specimen-processingTime
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for sequenceNumber. The sequence number of the sample. See http://hl7.org/fhir/StructureDefinition/specimen-sequenceNumber
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for specialHandling. Special handling of the specimen. See http://hl7.org/fhir/StructureDefinition/specimen-specialHandling
Unique id for inter-element referencing
Value of extension
Codes providing the status/availability of a specimen. See http://hl7.org/fhir/specimen-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for standards-status. HL7 Ballot/Standards status of artifact. See http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
Unique id for inter-element referencing
Value of extension
Used in:
HL7 Ballot/Standards status of artifact. See http://terminology.hl7.org/CodeSystem/standards-status
(message has no fields)
Used in:
The validation status of the target See http://hl7.org/fhir/CodeSystem/status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for statusReason. Reason for current status. See http://hl7.org/fhir/StructureDefinition/event-statusReason
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for statusReason. Reason for current status. See http://hl7.org/fhir/StructureDefinition/request-statusReason
Unique id for inter-element referencing
Value of extension
Type for strand. See http://hl7.org/fhir/strand-type
(message has no fields)
Used in:
Auto-generated from StructureDefinition for string. Primitive Type string. See http://hl7.org/fhir/StructureDefinition/string
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Primitive value for string
xml:id (or equivalent in JSON)
Additional content defined by implementations
Auto-generated from StructureDefinition for markdown. String equivalent with markdown. See http://hl7.org/fhir/StructureDefinition/rendering-markdown
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for SC-coding. code for string. See http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for xhtml. String equivalent with html markup. See http://hl7.org/fhir/StructureDefinition/rendering-xhtml
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for StructureDefinition. Structural Definition. See http://hl7.org/fhir/StructureDefinition/StructureDefinition
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this structure definition, represented as a URI (globally unique)
Additional identifier for the structure definition
Business version of the structure definition
Name for this structure definition (computer friendly)
Name for this structure definition (human friendly)
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the structure definition
The context that the content is intended to support
Intended jurisdiction for structure definition (if applicable)
Why this structure definition is defined
Use and/or publishing restrictions
Assist with indexing and finding
Whether the structure is abstract
FHIRPath invariants - when the extension can be used
Type defined or constrained by this structure
Definition that this type is constrained/specialized from
If an extension, where it can be used in instances
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Where the extension can be used in instances
fhirpath | element | extension
Used in:
specialization | constraint - How relates to base definition
Used in:
Differential view of the structure
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Definition of elements in the resource (if no StructureDefinition)
FHIR Version this StructureDefinition targets
Used in:
primitive-type | complex-type | resource | logical
Used in:
External specification that the content is mapped to
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Internal id when this mapping is used
Identifies what this mapping refers to
Names what this mapping refers to
Versions, Issues, Scope limitations etc.
Snapshot view of the structure
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Definition of elements in the resource (if no StructureDefinition)
draft | active | retired | unknown
Used in:
Auto-generated from StructureDefinition for ancestor. StructureDefinition this is derived from. See http://hl7.org/fhir/StructureDefinition/structuredefinition-ancestor
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for applicable-version. Another Version this applies to. See http://hl7.org/fhir/StructureDefinition/structuredefinition-applicable-version
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for category. Category from official resource list. See http://hl7.org/fhir/StructureDefinition/structuredefinition-category
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for codegen-super. Use a different base when generating code. See http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for dependencies. Dependent Profiles - must be valid against these too. See http://hl7.org/fhir/StructureDefinition/structuredefinition-dependencies
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for fmm-no-warnings. FMM Level (if no warnings). See http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm-no-warnings
Unique id for inter-element referencing
Value of extension
Defines the type of structure that a definition is describing. See http://hl7.org/fhir/structure-definition-kind
(message has no fields)
Used in:
Auto-generated from StructureDefinition for normative-version. If normative, which was the first normative version. See http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for security-category. Security Categorization for Resource. See http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for summary. Additional text for the summary presentation. See http://hl7.org/fhir/StructureDefinition/structuredefinition-summary
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for table-name. Show mappings in the summary table with this name. See http://hl7.org/fhir/StructureDefinition/structuredefinition-table-name
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for template-status. Template Status Code (more authoring statuses). See http://hl7.org/fhir/StructureDefinition/structuredefinition-template-status
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for xml-no-order. Whether elements can come in any order (XML). See http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-no-order
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for StructureMap. A Map of relationships between 2 structures that can be used to transform data. See http://hl7.org/fhir/StructureDefinition/StructureMap
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this structure map, represented as a URI (globally unique)
Additional identifier for the structure map
Business version of the structure map
Name for this structure map (computer friendly)
Name for this structure map (human friendly)
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the structure map
The context that the content is intended to support
Intended jurisdiction for structure map (if applicable)
Why this structure map is defined
Use and/or publishing restrictions
Other maps used by this map (canonical URLs)
Named sections for reader convenience
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Human-readable label
Another group that this group adds rules to
Additional description/explanation for group
Named instance provided when invoking the map
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Name for this instance of data
Type for this instance of data
Documentation for this instance of data
source | target
Used in:
Transform Rule from source to target
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Name of the rule for internal references
Rules contained in this rule
Documentation for this instance of data
Which other rules to apply in the context of this rule
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Name of a rule or group to apply
Variable to pass to the rule or group
Source inputs to the mapping
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type or variable this rule applies to
Specified minimum cardinality
Specified maximum cardinality (number or *)
Rule only applies if source has this type
Optional field for this source
Named context for field, if a field is specified
FHIRPath expression - must be true or the rule does not apply
FHIRPath expression - must be true or the mapping engine throws an error instead of completing
Message to put in log if source exists (FHIRPath)
Default value if no value exists
Used in:
first | not_first | last | not_last | only_one
Used in:
Content to create because of this mapping rule
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Type or variable this rule applies to
Field to create in the context
Named context for field, if desired, and a field is specified
Internal rule reference for shared list items
type | variable
Used in:
first | share | last | collate
Used in:
Parameters to the transform
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Parameter value - variable or literal
Used in:
create | copy +
Used in:
none | types | type-and-types
Used in:
draft | active | retired | unknown
Used in:
Structure Definition used by this map
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Canonical reference to structure definition
Name for type in this map
Documentation on use of structure
source | queried | target | produced
Used in:
How to interpret the context. See http://hl7.org/fhir/map-context-type
(message has no fields)
Used in:
If this is the default rule set to apply for the source type, or this combination of types. See http://hl7.org/fhir/map-group-type-mode
(message has no fields)
Used in:
Mode for this instance of data. See http://hl7.org/fhir/map-input-mode
(message has no fields)
Used in:
How the referenced structure is used in this mapping. See http://hl7.org/fhir/map-model-mode
(message has no fields)
Used in:
If field is a list, how to manage the source. See http://hl7.org/fhir/map-source-list-mode
(message has no fields)
Used in:
If field is a list, how to manage the production. See http://hl7.org/fhir/map-target-list-mode
(message has no fields)
Used in:
How data is copied/created. See http://hl7.org/fhir/map-transform
(message has no fields)
Used in:
Auto-generated from StructureDefinition for style. Html style value. See http://hl7.org/fhir/StructureDefinition/rendering-style
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for styleSensitive. Are styles important for processing?. See http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Subscription. Server push subscription criteria. See http://hl7.org/fhir/StructureDefinition/Subscription
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Contact details for source (e.g. troubleshooting)
When to automatically delete the subscription
Description of why this subscription was created
Rule for server push
Latest error note
The channel on which to report matches to the criteria
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Where the channel points to
Usage depends on the channel type
MIME type to send, or omit for no payload
Used in:
This valueset is not enumerable, and so is represented as a string.
rest-hook | websocket | email | sms | message
Used in:
requested | active | error | off
Used in:
The type of method used to execute a subscription. See http://hl7.org/fhir/subscription-channel-type
(message has no fields)
Used in:
The status of a subscription. See http://hl7.org/fhir/subscription-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for Substance. A homogeneous material with a definite composition. See http://hl7.org/fhir/StructureDefinition/Substance
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Unique identifier
What class/type of substance this is
What substance this is
Textual description of the substance, comments
Composition information about the substance
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Optional amount (concentration)
A component of the substance
Used in:
If this describes a specific package/container of the substance
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Identifier of the package/container
When no longer valid to use
Amount of substance in the package
active | inactive | entered-in-error
Used in:
Auto-generated from StructureDefinition for SubstanceAmount. Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID. See http://hl7.org/fhir/StructureDefinition/SubstanceAmount
Used in: , ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Most elements that require a quantitative value will also have a field called amount type. Amount type should always be specified because the actual value of the amount is often dependent on it. EXAMPLE: In capturing the actual relative amounts of substances or molecular fragments it is essential to indicate whether the amount refers to a mole ratio or weight ratio. For any given element an effort should be made to use same the amount type for all related definitional elements
A textual comment on a numeric value
Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field
Used in:
Reference range of possible or expected values
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Lower limit possible or expected
Upper limit possible or expected
Auto-generated from StructureDefinition for SubstanceNucleicAcid. Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction. See http://hl7.org/fhir/StructureDefinition/SubstanceNucleicAcid
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
The type of the sequence shall be specified based on a controlled vocabulary
The number of linear sequences of nucleotides linked through phosphodiester bonds shall be described. Subunits would be strands of nucleic acids that are tightly associated typically through Watson-Crick base pairing. NOTE: If not specified in the reference source, the assumption is that there is 1 subunit
The area of hybridisation shall be described if applicable for double stranded RNA or DNA. The number associated with the subunit followed by the number associated to the residue shall be specified in increasing order. The underscore “” shall be used as separator as follows: “Subunitnumber Residue”
(TBC)
Subunits are listed in order of decreasing length; sequences of the same length will be ordered by molecular weight; subunits that have identical sequences will be repeated multiple times
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Index of linear sequences of nucleic acids in order of decreasing length. Sequences of the same length will be ordered by molecular weight. Subunits that have identical sequences will be repeated and have sequential subscripts
Actual nucleotide sequence notation from 5' to 3' end using standard single letter codes. In addition to the base sequence, sugar and type of phosphate or non-phosphate linkage should also be captured
The length of the sequence shall be captured
(TBC)
The nucleotide present at the 5’ terminal shall be specified based on a controlled vocabulary. Since the sequence is represented from the 5' to the 3' end, the 5’ prime nucleotide is the letter at the first position in the sequence. A separate representation would be redundant
The nucleotide present at the 3’ terminal shall be specified based on a controlled vocabulary. Since the sequence is represented from the 5' to the 3' end, the 5’ prime nucleotide is the letter at the last position in the sequence. A separate representation would be redundant
The linkages between sugar residues will also be captured
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The entity that links the sugar residues together should also be captured for nearly all naturally occurring nucleic acid the linkage is a phosphate group. For many synthetic oligonucleotides phosphorothioate linkages are often seen. Linkage connectivity is assumed to be 3’-5’. If the linkage is either 3’-3’ or 5’-5’ this should be specified
Each linkage will be registered as a fragment and have an ID
Each linkage will be registered as a fragment and have at least one name. A single name shall be assigned to each linkage
Residues shall be captured as described in 5.3.6.8.3
5.3.6.8.1 Sugar ID (Mandatory)
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The Substance ID of the sugar or sugar-like component that make up the nucleotide
The name of the sugar or sugar-like component that make up the nucleotide
The residues that contain a given sugar will be captured. The order of given residues will be captured in the 5‘-3‘direction consistent with the base sequences listed above
Auto-generated from StructureDefinition for SubstancePolymer. Todo. See http://hl7.org/fhir/StructureDefinition/SubstancePolymer
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Todo
Todo
Todo
Todo
Todo
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Todo
Todo
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Todo
Todo
Todo
Todo
Todo
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Todo
Todo
Todo
Todo
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Todo
Todo
Todo
Todo
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Todo
Todo
Todo
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Todo
Todo
Todo
Auto-generated from StructureDefinition for SubstanceProtein. A SubstanceProtein is defined as a single unit of a linear amino acid sequence, or a combination of subunits that are either covalently linked or have a defined invariant stoichiometric relationship. This includes all synthetic, recombinant and purified SubstanceProteins of defined sequence, whether the use is therapeutic or prophylactic. This set of elements will be used to describe albumins, coagulation factors, cytokines, growth factors, peptide/SubstanceProtein hormones, enzymes, toxins, toxoids, recombinant vaccines, and immunomodulators. See http://hl7.org/fhir/StructureDefinition/SubstanceProtein
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
The SubstanceProtein descriptive elements will only be used when a complete or partial amino acid sequence is available or derivable from a nucleic acid sequence
Number of linear sequences of amino acids linked through peptide bonds. The number of subunits constituting the SubstanceProtein shall be described. It is possible that the number of subunits can be variable
The disulphide bond between two cysteine residues either on the same subunit or on two different subunits shall be described. The position of the disulfide bonds in the SubstanceProtein shall be listed in increasing order of subunit number and position within subunit followed by the abbreviation of the amino acids involved. The disulfide linkage positions shall actually contain the amino acid Cysteine at the respective positions
This subclause refers to the description of each subunit constituting the SubstanceProtein. A subunit is a linear sequence of amino acids linked through peptide bonds. The Subunit information shall be provided when the finished SubstanceProtein is a complex of multiple sequences; subunits are not used to delineate domains within a single sequence. Subunits are listed in order of decreasing length; sequences of the same length will be ordered by decreasing molecular weight; subunits that have identical sequences will be repeated multiple times
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Index of primary sequences of amino acids linked through peptide bonds in order of decreasing length. Sequences of the same length will be ordered by molecular weight. Subunits that have identical sequences will be repeated and have sequential subscripts
The sequence information shall be provided enumerating the amino acids from N- to C-terminal end using standard single-letter amino acid codes. Uppercase shall be used for L-amino acids and lowercase for D-amino acids. Transcribed SubstanceProteins will always be described using the translated sequence; for synthetic peptide containing amino acids that are not represented with a single letter code an X should be used within the sequence. The modified amino acids will be distinguished by their position in the sequence
Length of linear sequences of amino acids contained in the subunit
The sequence information shall be provided enumerating the amino acids from N- to C-terminal end using standard single-letter amino acid codes. Uppercase shall be used for L-amino acids and lowercase for D-amino acids. Transcribed SubstanceProteins will always be described using the translated sequence; for synthetic peptide containing amino acids that are not represented with a single letter code an X should be used within the sequence. The modified amino acids will be distinguished by their position in the sequence
Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID
The name of the fragment modified at the N-terminal of the SubstanceProtein shall be specified
Unique identifier for molecular fragment modification based on the ISO 11238 Substance ID
The modification at the C-terminal shall be specified
Auto-generated from StructureDefinition for SubstanceReferenceInformation. Todo. See http://hl7.org/fhir/StructureDefinition/SubstanceReferenceInformation
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Todo
Todo
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Todo
Todo
Todo
Todo
Todo
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Todo
Todo
Todo
Todo
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Todo
Todo
Todo
Todo
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Todo
Todo
Todo
Todo
Todo
Todo
Todo
Todo
Used in:
Auto-generated from StructureDefinition for SubstanceSourceMaterial. Source material shall capture information on the taxonomic and anatomical origins as well as the fraction of a material that can result in or can be modified to form a substance. This set of data elements shall be used to define polymer substances isolated from biological matrices. Taxonomic and anatomical origins shall be described using a controlled vocabulary as required. This information is captured for naturally derived polymers ( . starch) and structurally diverse substances. For Organisms belonging to the Kingdom Plantae the Substance level defines the fresh material of a single species or infraspecies, the Herbal Drug and the Herbal preparation. For Herbal preparations, the fraction information will be captured at the Substance information level and additional information for herbal extracts will be captured at the Specified Substance Group 1 information level. See for further explanation the Substance Class: Structurally Diverse and the herbal annex. See http://hl7.org/fhir/StructureDefinition/SubstanceSourceMaterial
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
General high level classification of the source material specific to the origin of the material
The type of the source material shall be specified based on a controlled vocabulary. For vaccines, this subclause refers to the class of infectious agent
The state of the source material when extracted
The unique identifier associated with the source material parent organism shall be specified
The organism accepted Scientific name shall be provided based on the organism taxonomy
The parent of the herbal drug Ginkgo biloba, Leaf is the substance ID of the substance (fresh) of Ginkgo biloba L. or Ginkgo biloba L. (Whole plant)
The parent substance of the Herbal Drug, or Herbal preparation
The country where the plant material is harvested or the countries where the plasma is sourced from as laid down in accordance with the Plasma Master File. For “Plasma-derived substances” the attribute country of origin provides information about the countries used for the manufacturing of the Cryopoor plama or Crioprecipitate
The place/region where the plant is harvested or the places/regions where the animal source material has its habitat
Stage of life for animals, plants, insects and microorganisms. This information shall be provided only when the substance is significantly different in these stages (e.g. foetal bovine serum)
Many complex materials are fractions of parts of plants, animals, or minerals. Fraction elements are often necessary to define both Substances and Specified Group 1 Substances. For substances derived from Plants, fraction information will be captured at the Substance information level ( . Oils, Juices and Exudates). Additional information for Extracts, such as extraction solvent composition, will be captured at the Specified Substance Group 1 information level. For plasma-derived products fraction information will be captured at the Substance and the Specified Substance Group 1 levels
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
This element is capturing information about the fraction of a plant part, or human plasma for fractionation
The specific type of the material constituting the component. For Herbal preparations the particulars of the extracts (liquid/dry) is described in Specified Substance Group 1
This subclause describes the organism which the substance is derived from. For vaccines, the parent organism shall be specified based on these subclause elements. As an example, full taxonomy will be described for the Substance Name: ., Leaf
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The family of an organism shall be specified
The genus of an organism shall be specified; refers to the Latin epithet of the genus element of the plant/animal scientific name; it is present in names for genera, species and infraspecies
The species of an organism shall be specified; refers to the Latin epithet of the species of the plant/animal; it is present in names for species and infraspecies
The Intraspecific type of an organism shall be specified
The intraspecific description of an organism shall be specified based on a controlled vocabulary. For Influenza Vaccine, the intraspecific description shall contain the syntax of the antigen in line with the WHO convention
4.9.13.6.1 Author type (Conditional)
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The type of author of an organism species shall be specified. The parenthetical author of an organism species refers to the first author who published the plant/animal name (of any rank). The primary author of an organism species refers to the first author(s), who validly published the plant/animal name
The author of an organism species shall be specified. The author year of an organism shall also be specified when applicable; refers to the year in which the first author(s) published the infraspecific plant/animal name (of any rank)
4.9.13.8.1 Hybrid species maternal organism ID (Optional)
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The identifier of the maternal species constituting the hybrid organism shall be specified based on a controlled vocabulary. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal
The name of the maternal species constituting the hybrid organism shall be specified. For plants, the parents aren’t always known, and it is unlikely that it will be known which is maternal and which is paternal
The identifier of the paternal species constituting the hybrid organism shall be specified based on a controlled vocabulary
The name of the paternal species constituting the hybrid organism shall be specified
The hybrid type of an organism shall be specified
4.9.13.7.1 Kingdom (Conditional)
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The kingdom of an organism shall be specified
The phylum of an organism shall be specified
The class of an organism shall be specified
The order of an organism shall be specified,
To do
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Entity of anatomical origin of source material within an organism
The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply
Auto-generated from StructureDefinition for SubstanceSpecification. The detailed description of a substance, typically at a level beyond what is used for prescribing. See http://hl7.org/fhir/StructureDefinition/SubstanceSpecification
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Identifier by which this substance is known
High level categorization, e.g. polymer or nucleic acid
Status of substance within the catalogue e.g. approved
If the substance applies to only human or veterinary use
Textual description of the substance
Supporting literature
Textual comment about this record of a substance
General information detailing this substance
The molecular weight or weight range (for proteins, polymers or nucleic acids)
Data items specific to nucleic acids
Data items specific to polymers
Data items specific to proteins
Material or taxonomic/anatomical source for the substance
Codes associated with the substance
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The specific code
Status of the code assignment
The date at which the code status is changed as part of the terminology maintenance
Any comment can be provided in this field, if necessary
Supporting literature
Moiety, for structural modifications
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Role that the moiety is playing
Identifier by which this moiety substance is known
Textual name for this moiety substance
Stereochemistry type
Optical activity type
Molecular formula
Quantitative value for this moiety
Used in:
Names applicable to this substance
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The actual name
Name type
The status of the name
If this is the preferred name for this substance
Language of the name
The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive
The jurisdiction where this name applies
A synonym of this name
A translation for this name
Supporting literature
Details of the official nature of this name
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Which authority uses this official name
The status of the official name
Date of official name change
General specifications for this substance, including how it is related to other substances
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
A category for this property, e.g. Physical, Chemical, Enzymatic
Property type e.g. viscosity, pH, isoelectric point
Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)
Quantitative value for this property
Used in:
A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol)
Used in:
A link between this substance and another, with details of the relationship
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
For example "salt to parent", "active moiety", "starting material"
For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships
For use when the numeric
An operator for the amount, for example "average", "approximately", "less than"
Supporting literature
A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other
Used in:
A pointer to another substance, as a resource or just a representational code
Used in:
Structural information
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Stereochemistry type
Optical activity type
Molecular formula
Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot
The molecular weight or weight range (for proteins, polymers or nucleic acids)
Supporting literature
Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Substance identifier for each non-natural or radioisotope
Substance name for each non-natural or radioisotope
The type of isotopic substitution present in a single substance
Half life - for a non-natural nuclide
The molecular weight or weight range (for proteins, polymers or nucleic acids)
Used in: , ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The method by which the molecular weight was determined
Type of molecular weight such as exact, average (also known as. number average), weight average
Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field
Molecular structural representation
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The type of structure (e.g. Full, Partial, Representative)
The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX
An attached file with the structural representation
Auto-generated from StructureDefinition for SupplyDelivery. Delivery of bulk Supplies. See http://hl7.org/fhir/StructureDefinition/SupplyDelivery
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External identifier
Fulfills plan, proposal or order
Part of referenced event
Patient for whom the item is supplied
Category of dispense event
Dispenser
Where the Supply was sent
Who collected the Supply
When event occurred
Used in:
in-progress | completed | abandoned | entered-in-error
Used in:
The item that is delivered or supplied
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Amount dispensed
Medication, Substance, or Device supplied
Used in:
Status of the supply delivery. See http://hl7.org/fhir/supplydelivery-status
(message has no fields)
Used in:
This value sets refers to a specific supply item. See http://terminology.hl7.org/CodeSystem/supply-item-type
(message has no fields)
Auto-generated from StructureDefinition for SupplyRequest. Request for a medication, substance or device. See http://hl7.org/fhir/StructureDefinition/SupplyRequest
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier for SupplyRequest
The kind of supply (central, non-stock, etc.)
The requested amount of the item indicated
When the request was made
Individual making the request
Who is intended to fulfill the request
The reason why the supply item was requested
The reason why the supply item was requested
The origin of the supply
The destination of the supply
Medication, Substance, or Device requested to be supplied
Used in:
When the request should be fulfilled
Used in:
Ordered item details
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Item detail
Value of detail
Used in:
routine | urgent | asap | stat
Used in:
draft | active | suspended +
Used in:
Status of the supply request. See http://hl7.org/fhir/supplyrequest-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for supportingInfo. Other information that may be relevant to this event. See http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
Unique id for inter-element referencing
Value of extension
Operations supported by REST at the system level. See http://hl7.org/fhir/ValueSet/system-restful-interaction
(message has no fields)
Used in:
Auto-generated from StructureDefinition for targetBodyStructure. The target point for this procedure. See http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Task. A task to be performed. See http://hl7.org/fhir/StructureDefinition/Task
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Task Instance Identifier
Formal definition of task
Formal definition of task
Request fulfilled by this task
Requisition or grouper id
Composite task
Reason for current status
E.g. "Specimen collected", "IV prepped"
Task Type
Human-readable explanation of task
What task is acting on
Beneficiary of the Task
Healthcare event during which this task originated
Start and end time of execution
Task Creation Date
Task Last Modified Date
Who is asking for task to be done
Requested performer
Responsible individual
Where task occurs
Why task is needed
Why task is needed
Associated insurance coverage
Comments made about the task
Key events in history of the Task
unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Used in:
Information produced as part of task
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Label for output
Result of output
Used in:
Information used to perform task
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Label for the input
Content to use in performing the task
Used in:
routine | urgent | asap | stat
Used in:
Constraints on fulfillment tasks
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
How many times to repeat
When fulfillment sought
For whom is fulfillment sought?
draft | requested | received | accepted | +
Used in:
Auto-generated from StructureDefinition for candidateList. List of possible owners of Task. See http://hl7.org/fhir/StructureDefinition/task-candidateList
Unique id for inter-element referencing
Value of extension
Distinguishes whether the task is a proposal, plan or full order. See http://hl7.org/fhir/task-intent
(message has no fields)
Distinguishes whether the task is a proposal, plan or full order. See http://hl7.org/fhir/ValueSet/task-intent
(message has no fields)
Used in:
Auto-generated from StructureDefinition for replaces. Task(s) replaced by this Task. See http://hl7.org/fhir/StructureDefinition/task-replaces
Unique id for inter-element referencing
Value of extension
The current status of the task. See http://hl7.org/fhir/task-status
(message has no fields)
Used in:
Life cycle of the Status Code of a Template Design (Version) See urn:oid:2.16.840.1.113883.3.1937.98.5.8
(message has no fields)
The status indicates the level of maturity of the design and may be used to manage the use of the design. See http://hl7.org/fhir/ValueSet/template-status-code
(message has no fields)
Used in:
Auto-generated from StructureDefinition for TerminologyCapabilities. A statement of system capabilities. See http://hl7.org/fhir/StructureDefinition/TerminologyCapabilities
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
Business version of the terminology capabilities
Name for this terminology capabilities (computer friendly)
Name for this terminology capabilities (human friendly)
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the terminology capabilities
The context that the content is intended to support
Intended jurisdiction for terminology capabilities (if applicable)
Why this terminology capabilities is defined
Use and/or publishing restrictions
Whether lockedDate is supported
Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
If cross-system closure is supported
explicit | all
Used in:
A code system supported by the server
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
URI for the Code System
Whether subsumption is supported
Version of Code System supported
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Version identifier for this version
If this is the default version for this code system
If compositional grammar is supported
Language Displays supported
Properties supported for $lookup
Filter Properties supported
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Code of the property supported
Operations supported for the property
Information about the [ValueSet/$expand](valueset-operation-expand.html) operation
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Whether the server can return nested value sets
Whether the server supports paging on expansion
Allow request for incomplete expansions?
Documentation about text searching works
Supported expansion parameter
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Expansion Parameter name
Description of support for parameter
If this describes a specific instance
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Describes this specific instance
Base URL for the implementation
instance | capability | requirements
Used in:
Software that is covered by this terminology capability statement
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
A name the software is known by
Version covered by this statement
draft | active | retired | unknown
Used in:
Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Whether the client must identify the map
Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Whether translations are validated
Auto-generated from StructureDefinition for TestReport. Describes the results of a TestScript execution. See http://hl7.org/fhir/StructureDefinition/TestReport
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
External identifier
Informal name of the executed TestScript
Reference to the version-specific TestScript that was executed to produce this TestReport
The final score (percentage of tests passed) resulting from the execution of the TestScript
Name of the tester producing this report (Organization or individual)
When the TestScript was executed and this TestReport was generated
A participant in the test execution, either the execution engine, a client, or a server
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The uri of the participant. An absolute URL is preferred
The display name of the participant
test-engine | client | server
Used in:
pass | fail | pending
Used in:
The results of the series of required setup operations before the tests were executed
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
A setup operation or assert that was executed
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The assertion to perform
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
A message associated with the result
A link to further details on the result
pass | skip | fail | warning | error
Used in:
The operation to perform
Used in: , ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
A message associated with the result
A link to further details on the result
pass | skip | fail | warning | error
Used in:
completed | in-progress | waiting | stopped | entered-in-error
Used in:
The results of running the series of required clean up steps
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
One or more teardown operations performed
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The teardown operation performed
A test executed from the test script
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Tracking/logging name of this test
Tracking/reporting short description of the test
A test operation or assert that was performed
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The operation performed
The assertion performed
The results of executing an action. See http://hl7.org/fhir/report-action-result-codes
(message has no fields)
Used in: ,
The type of participant. See http://hl7.org/fhir/report-participant-type
(message has no fields)
Used in:
The reported execution result. See http://hl7.org/fhir/report-result-codes
(message has no fields)
Used in:
The current status of the test report. See http://hl7.org/fhir/report-status-codes
(message has no fields)
Used in:
Auto-generated from StructureDefinition for TestScript. Describes a set of tests. See http://hl7.org/fhir/StructureDefinition/TestScript
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this test script, represented as a URI (globally unique)
Additional identifier for the test script
Business version of the test script
Name for this test script (computer friendly)
Name for this test script (human friendly)
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the test script
The context that the content is intended to support
Intended jurisdiction for test script (if applicable)
Why this test script is defined
Use and/or publishing restrictions
Reference of the validation profile
An abstract server representing a destination or receiver in a message exchange
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The index of the abstract destination server starting at 1
FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor
Fixture in the test script - by reference (uri)
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Whether or not to implicitly create the fixture during setup
Whether or not to implicitly delete the fixture during teardown
Reference of the resource
Required capability that is assumed to function correctly on the FHIR server being tested
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Capabilities that are assumed to function correctly on the FHIR server being tested
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Are the capabilities required?
Are the capabilities validated?
The expected capabilities of the server
Which origin server these requirements apply to
Which server these requirements apply to
Links to the FHIR specification
Required Capability Statement
Links to the FHIR specification
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
URL to the specification
Short description
An abstract server representing a client or sender in a message exchange
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The index of the abstract origin server starting at 1
FHIR-Client | FHIR-SDC-FormFiller
A series of required setup operations before tests are executed
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
A setup operation or assert to perform
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The assertion to perform
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Tracking/logging assertion label
Tracking/reporting assertion description
Id of the source fixture to be evaluated
The FHIRPath expression to evaluate against the source fixture
XPath or JSONPath expression to evaluate against the source fixture
The FHIRPath expression to be evaluated
HTTP header field name
Fixture Id of minimum content resource
Perform validation on navigation links?
XPath or JSONPath expression
Request URL comparison value
HTTP response code to test
Fixture Id of source expression or headerField
Profile Id of validation profile reference
The value to compare to
Will this assert produce a warning only on error?
Mime type to compare against the 'Content-Type' header
Used in:
This valueset is not enumerable, and so is represented as a string.
response | request
Used in:
equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval
Used in:
delete | get | options | patch | post | put | head
Used in:
Resource type
Used in:
okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable
Used in:
The setup operation to perform
Used in: , ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The operation code type that will be executed
Tracking/logging operation label
Tracking/reporting operation description
Server responding to the request
Whether or not to send the request url in encoded format
Server initiating the request
Explicitly defined path parameters
Fixture Id of mapped request
Fixture Id of mapped response
Fixture Id of body for PUT and POST requests
Id of fixture used for extracting the [id], [type], and [vid] for GET requests
Request URL
Mime type to accept in the payload of the response, with charset etc.
Used in:
This valueset is not enumerable, and so is represented as a string.
Mime type of the request payload contents, with charset etc.
Used in:
This valueset is not enumerable, and so is represented as a string.
delete | get | options | patch | post | put | head
Used in:
Each operation can have one or more header elements
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
HTTP header field name
HTTP headerfield value
Resource type
Used in:
draft | active | retired | unknown
Used in:
A series of required clean up steps
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
One or more teardown operations to perform
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The teardown operation to perform
A test in this script
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Tracking/logging name of this test
Tracking/reporting short description of the test
A test operation or assert to perform
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The setup operation to perform
The setup assertion to perform
Placeholder for evaluated elements
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Descriptive name for this variable
Default, hard-coded, or user-defined value for this variable
Natural language description of the variable
The FHIRPath expression against the fixture body
HTTP header field name for source
Hint help text for default value to enter
XPath or JSONPath against the fixture body
Fixture Id of source expression or headerField within this variable
The allowable request method or HTTP operation codes. See http://hl7.org/fhir/http-operations
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for time. Primitive Type time. See http://hl7.org/fhir/StructureDefinition/time
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
The absolute time of the event as a Unix epoch in microseconds.
xml:id (or equivalent in JSON)
Additional content defined by implementations
Used in:
Auto-generated from StructureDefinition for Timezone Code. IANA Timezone Code per BCP 175. See http://hl7.org/fhir/StructureDefinition/tz-code
Unique id for inter-element referencing
Value of extension
Used in:
This valueset is not enumerable, and so is represented as a string.
Auto-generated from StructureDefinition for Timing. A timing schedule that specifies an event that may occur multiple times. See http://hl7.org/fhir/StructureDefinition/Timing
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
When the event occurs
BID | TID | QID | AM | PM | QD | QOD | +
When the event is to occur
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Number of times to repeat
Maximum number of times to repeat
How long when it happens
How long when it happens (Max)
Event occurs frequency times per period
Event occurs up to frequencyMax times per period
Event occurs frequency times per period
Upper limit of period (3-4 hours)
Time of day for action
Minutes from event (before or after)
Length/Range of lengths, or (Start and/or end) limits
Used in:
mon | tue | wed | thu | fri | sat | sun
Used in:
s | min | h | d | wk | mo | a - unit of time (UCUM)
Used in:
s | min | h | d | wk | mo | a - unit of time (UCUM)
Used in:
Code for time period of occurrence
Used in:
Auto-generated from StructureDefinition for dayOfMonth. Day of Month for schedule. See http://hl7.org/fhir/StructureDefinition/timing-dayOfMonth
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for exact. Whether specified times must be followed as closely as possible. See http://hl7.org/fhir/StructureDefinition/timing-exact
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for Translation. Language Translation (Localization). See http://hl7.org/fhir/StructureDefinition/translation
Unique id for inter-element referencing
Additional content defined by implementations
Code for Language
Content in other Language
Used in:
Auto-generated from StructureDefinition for TriggerDefinition. Defines an expected trigger for a module. See http://hl7.org/fhir/StructureDefinition/TriggerDefinition
Used in: , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Name or URI that identifies the event
Triggering data of the event (multiple = 'and')
Whether the event triggers (boolean expression)
Timing of the event
Used in:
named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
Used in:
The type of trigger. See http://hl7.org/fhir/trigger-type
(message has no fields)
Used in:
How a type relates to its baseDefinition. See http://hl7.org/fhir/type-derivation-rule
(message has no fields)
Used in:
Operations supported by REST at the type or instance level. See http://hl7.org/fhir/ValueSet/type-restful-interaction
(message has no fields)
Used in:
Codes to identify how UDI data was entered. See http://hl7.org/fhir/udi-entry-type
(message has no fields)
Used in: ,
A unit of time (units from UCUM). See http://hl7.org/fhir/ValueSet/units-of-time
(message has no fields)
Used in: ,
Auto-generated from StructureDefinition for unsignedInt. Primitive Type unsignedInt. See http://hl7.org/fhir/StructureDefinition/unsignedInt
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Primitive value for unsignedInt
xml:id (or equivalent in JSON)
Additional content defined by implementations
Auto-generated from StructureDefinition for uri. Primitive Type uri. See http://hl7.org/fhir/StructureDefinition/uri
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Primitive value for uri
xml:id (or equivalent in JSON)
Additional content defined by implementations
Auto-generated from StructureDefinition for url. Primitive Type url. See http://hl7.org/fhir/StructureDefinition/url
Used in: , , , , , , , , , , , , , , , , , , , , , , , ,
Primitive value for url
xml:id (or equivalent in JSON)
Additional content defined by implementations
Auto-generated from StructureDefinition for UsageContext. Describes the context of use for a conformance or knowledge resource. See http://hl7.org/fhir/StructureDefinition/UsageContext
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Unique id for inter-element referencing
Additional content defined by implementations
Type of context being specified
Value that defines the context
Used in:
Auto-generated from StructureDefinition for group. The group which this usage context is part of. See http://hl7.org/fhir/StructureDefinition/usagecontext-group
Unique id for inter-element referencing
Value of extension
The purpose of the Claim: predetermination, preauthorization, claim. See http://hl7.org/fhir/claim-use
(message has no fields)
Used in: , ,
Auto-generated from StructureDefinition for uuid. Primitive Type uuid. See http://hl7.org/fhir/StructureDefinition/uuid
Used in: , , , , , , , , ,
Primitive value for uuid
xml:id (or equivalent in JSON)
Additional content defined by implementations
FHIR Value set/code system definition for HL7 v2 table 0444 ( Name assembly order) See http://terminology.hl7.org/CodeSystem/v2-0444
(message has no fields)
Codes that provide guidance around the circumstances in which a given address should be used. See http://terminology.hl7.org/CodeSystem/v3-AddressUse
(message has no fields)
Set of codes used to value Act.Confidentiality and Role.Confidentiality attribute in accordance with the definition for concept domain "Confidentiality". See http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification
(message has no fields)
Used in:
A set of codes specifying the security classification of acts and roles in accordance with the definition for concept domain "Confidentiality". See http://terminology.hl7.org/CodeSystem/v3-Confidentiality
(message has no fields)
OpenIssue: Needs description See http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifier
(message has no fields)
Description: The qualifier is a set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. For example, a given name may be flagged as a nickname, a family name may be a pseudonym or a name of public records. See http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifierR2
(message has no fields)
**** MISSING DEFINITIONS **** See http://terminology.hl7.org/CodeSystem/v3-EntityNameUse
(message has no fields)
Description: A set of codes advising a system or user which name in a set of names to select for a given purpose. See http://terminology.hl7.org/CodeSystem/v3-EntityNameUseR2
(message has no fields)
Used in:
A collection of codes specifying why a valid value is not present. See http://terminology.hl7.org/CodeSystem/v3-NullFlavor
(message has no fields)
Used in:
A set of codes specifying the modality by which the Entity playing the Role is participating in the Act. Examples: Physically present, over the telephone, written communication. Rationale: Particularly for author (originator) participants this is used to specify whether the information represented by the act was initially provided verbally, (hand-)written, or electronically. Open Issue: There needs to be a reexamination of the hierarchies as there seems to be some muddling between ELECTRONIC and other concepts that involve electronic communication that are in other hierarchies. See http://terminology.hl7.org/CodeSystem/v3-ParticipationMode
(message has no fields)
**** MISSING DEFINITIONS **** See http://terminology.hl7.org/CodeSystem/v3-ProbabilityDistributionType
(message has no fields)
A set of codes further specifying the kind of Role; specific classification codes for further qualifying RoleClass codes. See http://terminology.hl7.org/CodeSystem/v3-RoleCode
(message has no fields)
**** MISSING DEFINITIONS **** See http://terminology.hl7.org/CodeSystem/v3-TimingEvent
(message has no fields)
Auto-generated from StructureDefinition for ValueSet. A set of codes drawn from one or more code systems. See http://hl7.org/fhir/StructureDefinition/ValueSet
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Canonical identifier for this value set, represented as a URI (globally unique)
Additional identifier for the value set (business identifier)
Business version of the value set
Name for this value set (computer friendly)
Name for this value set (human friendly)
For testing purposes, not real usage
Date last changed
Name of the publisher (organization or individual)
Contact details for the publisher
Natural language description of the value set
The context that the content is intended to support
Intended jurisdiction for value set (if applicable)
Indicates whether or not any change to the content logical definition may occur
Why this value set is defined
Use and/or publishing restrictions
Content logical definition of the value set (CLD)
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Fixed date for references with no specified version (transitive)
Whether inactive codes are in the value set
Explicitly exclude codes from a code system or other value sets
Include one or more codes from a code system or other value set(s)
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The system the codes come from
Specific version of the code system referred to
Select the contents included in this value set
A concept defined in the system
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Code or expression from system
Text to display for this code for this value set in this valueset
Additional representations for this concept
Used in: ,
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Human language of the designation
Types of uses of designations
The text value for this designation
Select codes/concepts by their properties (including relationships)
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
A property/filter defined by the code system
Code from the system, or regex criteria, or boolean value for exists
= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Used in:
Used when the value set is "expanded"
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Identifies the value set expansion (business identifier)
Time ValueSet expansion happened
Total number of codes in the expansion
Offset at which this resource starts
Codes in the value set
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
System value for the code
If user cannot select this entry
If concept is inactive in the code system
Version in which this code/display is defined
Code - if blank, this is not a selectable code
User display for the concept
Additional representations for this item
Codes contained under this entry
Parameter that controlled the expansion process
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Name as assigned by the client or server
Value of the named parameter
Used in:
draft | active | retired | unknown
Used in:
Auto-generated from StructureDefinition for activityStatusDate. Date when the activity status is in effect. See http://hl7.org/fhir/StructureDefinition/valueset-activityStatusDate
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for author. Entity/entities that create and may modify the Value Set. See http://hl7.org/fhir/StructureDefinition/valueset-author
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for authoritativeSource. Reference to the current trusted source of the ValueSet resource (metadata and definition). See http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for caseSensitive. If code is case sensitive. See http://hl7.org/fhir/StructureDefinition/valueset-caseSensitive
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for concept-comments. Comment about the use of this code in this context. See http://hl7.org/fhir/StructureDefinition/valueset-concept-comments
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for concept-definition. A definition for this code. See http://hl7.org/fhir/StructureDefinition/valueset-concept-definition
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for conceptOrder. Appearance order for user selection. See http://hl7.org/fhir/StructureDefinition/valueset-conceptOrder
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for deprecated. The concept should not be used. See http://hl7.org/fhir/StructureDefinition/valueset-deprecated
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for effectiveDate. When the value set version becomes Active and is available for use. See http://hl7.org/fhir/StructureDefinition/valueset-effectiveDate
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for expand-group. Defines a hierarchy structure (when in UI mode). See http://hl7.org/fhir/StructureDefinition/valueset-expand-group
Unique id for inter-element referencing
Additional content defined by implementations
Underlying code from the system
Display for the group
Codes or other groups in this group
Auto-generated from StructureDefinition for expand-rules. all-codes | ungrouped | groups-only. See http://hl7.org/fhir/StructureDefinition/valueset-expand-rules
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for expansionSource. ValueSet definition used to generate this expansion (logical URL). See http://hl7.org/fhir/StructureDefinition/valueset-expansionSource
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for expirationDate. When the value set version should no longer be used. See http://hl7.org/fhir/StructureDefinition/valueset-expirationDate
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for expression. An alternative computable expression of the value set content. See http://hl7.org/fhir/StructureDefinition/valueset-expression
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for extensible. Intended to be used with an extensible binding (e.g. 'open'). See http://hl7.org/fhir/StructureDefinition/valueset-extensible
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for keyWord. Descriptors and key terms for search. See http://hl7.org/fhir/StructureDefinition/valueset-keyWord
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for label. E.g. "(a)", "1.", etc. See http://hl7.org/fhir/StructureDefinition/valueset-label
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for map. A concept map relevant to interpret this value set. See http://hl7.org/fhir/StructureDefinition/valueset-map
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for otherName. Alternative names. See http://hl7.org/fhir/StructureDefinition/valueset-otherName
Unique id for inter-element referencing
Additional content defined by implementations
Human readable, short and specific
Which name is preferred for this language
Auto-generated from StructureDefinition for parameterSource. Declares the source of the parameter. See http://hl7.org/fhir/StructureDefinition/valueset-parameterSource
Unique id for inter-element referencing
Value of extension
Used in:
Auto-generated from StructureDefinition for reference. Url of Value set the code was chosen from. See http://hl7.org/fhir/StructureDefinition/valueset-reference
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for rules-text. An alternative non-computable expression of the value set content. See http://hl7.org/fhir/StructureDefinition/valueset-rules-text
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for sourceReference. Where did this content come from. See http://hl7.org/fhir/StructureDefinition/valueset-sourceReference
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for steward. Entity responsible for Value Set. See http://hl7.org/fhir/StructureDefinition/valueset-steward
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for supplement. Declares dependency on a particular supplment. See http://hl7.org/fhir/StructureDefinition/valueset-supplement
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for system. Code system resource. See http://hl7.org/fhir/StructureDefinition/valueset-system
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for systemName. Code system name. See http://hl7.org/fhir/StructureDefinition/valueset-systemName
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for systemRef. Where to find code system. See http://hl7.org/fhir/StructureDefinition/valueset-systemRef
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for toocostly. The expansion is incomplete because the full expansion is too large. See http://hl7.org/fhir/StructureDefinition/valueset-toocostly
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for trusted-expansion. Reference to a trusted expansion. See http://hl7.org/fhir/StructureDefinition/valueset-trusted-expansion
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for unclosed. The expansion is incomplete (perhaps because of post-coordination). See http://hl7.org/fhir/StructureDefinition/valueset-unclosed
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for usage. Who has used and how?. See http://hl7.org/fhir/StructureDefinition/valueset-usage
Unique id for inter-element referencing
Additional content defined by implementations
A consumer of or client for the value set
Implementation/project/standard that uses value set
Auto-generated from StructureDefinition for warning. Extra warning about the correct use of the value set. See http://hl7.org/fhir/StructureDefinition/valueset-warning
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for workflowStatus. Indicates the state of development of the value set. See http://hl7.org/fhir/StructureDefinition/valueset-workflowStatus
Unique id for inter-element referencing
Value of extension
Auto-generated from StructureDefinition for VerificationResult. Describes validation requirements, source(s), status and dates for one or more elements. See http://hl7.org/fhir/StructureDefinition/VerificationResult
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
A resource that was validated
The fhirpath location(s) within the resource that was validated
none | initial | periodic
When the validation status was updated
nothing | primary | multiple
The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)
Frequency of revalidation
The date/time validation was last completed (including failed validations)
The date when target is next validated, if appropriate
fatal | warn | rec-only | none
Information about the entity attesting to information
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
The individual or organization attesting to information
When the who is asserting on behalf of another (organization or individual)
The method by which attested information was submitted/retrieved
The date the information was attested to
A digital identity certificate associated with the attestation source
A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
Proxy signature
Attester signature
Information about the primary source(s) involved in validation
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Reference to the primary source
Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source)
Method for exchanging information with the primary source
successful | failed | unknown
When the target was validated against the primary source
yes | no | undetermined
specific | any | source
attested | validated | in-process | req-revalid | val-fail | reval-fail
Used in:
Information about the entity validating information
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Reference to the organization validating information
A digital identity certificate associated with the validator
Validator signature
A coded concept listing the base codes. See http://hl7.org/fhir/vision-base-codes
(message has no fields)
Used in:
A coded concept listing the eye codes. See http://hl7.org/fhir/vision-eye-codes
(message has no fields)
Used in:
Auto-generated from StructureDefinition for VisionPrescription. Prescription for vision correction products for a patient. See http://hl7.org/fhir/StructureDefinition/VisionPrescription
Used in:
Logical id of this artifact
Metadata about the resource
A set of rules under which this content was created
Language of the resource content
Text summary of the resource, for human interpretation
Contained, inline Resources
Additional content defined by implementations
Extensions that cannot be ignored
Business Identifier for vision prescription
Response creation date
Who prescription is for
Created during encounter / admission / stay
When prescription was authorized
Who authorized the vision prescription
Vision lens authorization
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Product to be supplied
Power of the lens
Lens power for astigmatism
Lens meridian which contain no power for astigmatism
Added power for multifocal levels
Contact lens power
Contact lens back curvature
Contact lens diameter
Lens wear duration
Color required
Brand required
Notes for coatings
right | left
Used in:
Eye alignment compensation
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Extensions that cannot be ignored even if unrecognized
Amount of adjustment
up | down | in | out
Used in:
active | cancelled | draft | entered-in-error
Used in:
Common UCUM units for recording Vital Signs See http://hl7.org/fhir/ValueSet/ucum-vitals-common
(message has no fields)
Auto-generated from StructureDefinition for wg. Owning Work Group. See http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
Unique id for inter-element referencing
Value of extension
Used in:
How a search parameter relates to the set of elements returned by evaluating its xpath query. See http://hl7.org/fhir/search-xpath-usage
(message has no fields)
Used in:
Auto-generated from StructureDefinition for xhtml. Primitive Type xhtml. See http://hl7.org/fhir/StructureDefinition/xhtml
Used in: ,
Actual xhtml
xml:id (or equivalent in JSON)