Get desktop application:
View/edit binary Protocol Buffers messages
Codes for assigning sex at birth as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc) See http://hl7.org/fhir/us/core/ValueSet/birthsex
(message has no fields)
Used in:
The 41 [CDC ethnicity codes](http://www.cdc.gov/phin/resources/vocabulary/index.html) that are grouped under one of the 2 OMB ethnicity category codes. See http://hl7.org/fhir/us/core/ValueSet/detailed-ethnicity
(message has no fields)
Used in:
The 900+ [CDC Race codes](http://www.cdc.gov/phin/resources/vocabulary/index.html) that are grouped under one of the 5 OMB race category codes. See http://hl7.org/fhir/us/core/ValueSet/detailed-race
(message has no fields)
Used in:
The US Core Narrative Status Value Set limits the text status for the resource narrative. See http://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status
(message has no fields)
The codes for the ethnicity categories - 'Hispanic or Latino' and 'Non Hispanic or Latino' - as defined by the [OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997](https://www.whitehouse.gov/omb/fedreg_1997standards). See http://hl7.org/fhir/us/core/ValueSet/omb-ethnicity-category
(message has no fields)
Used in:
The codes for the concepts 'Unknown' and 'Asked but no answer' and the the codes for the five race categories - 'American Indian' or 'Alaska Native', 'Asian', 'Black or African American', 'Native Hawaiian or Other Pacific Islander', and 'White' - as defined by the [OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997](https://www.whitehouse.gov/omb/fedreg_1997standards) . See http://hl7.org/fhir/us/core/ValueSet/omb-race-category
(message has no fields)
Used in:
Auto-generated from StructureDefinition for USCoreBirthSexExtension. Extension. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Unique id for inter-element referencing
Additional content defined by implementations
Value of extension
Used in: ,
Auto-generated from StructureDefinition for USCoreEthnicityExtension. US Core ethnicity Extension. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
ethnicity Text
Extended ethnicity codes
Used in:
Used in:
Hispanic or Latino|Not Hispanic or Latino
Used in:
Used in:
Auto-generated from StructureDefinition for USCoreRaceExtension. US Core Race Extension. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Used in:
Unique id for inter-element referencing
Additional content defined by implementations
Race Text
Extended race codes
Used in:
Used in:
American Indian or Alaska Native|Asian|Black or African American|Native Hawaiian or Other Pacific Islander|White
Used in:
Used in:
The U.S. Centers for Disease Control and Prevention (CDC) has prepared a code set for use in codingrace and ethnicity data. This code set is based on current federal standards for classifying data onrace and ethnicity, specifically the minimum race and ethnicity categories defined by the U.S. Office ofManagement and Budget (OMB) and a more detailed set of race and ethnicity categories maintainedby the U.S. Bureau of the Census (BC). The main purpose of the code set is to facilitate use of federalstandards for classifying data on race and ethnicity when these data are exchanged, stored, retrieved,or analyzed in electronic form. At the same time, the code set can be applied to paper-based recordsystems to the extent that these systems are used to collect, maintain, and report data on race andethnicity in accordance with current federal standards. Source: [Race and Ethnicity Code Set Version 1.0](https://www.cdc.gov/phin/resources/vocabulary/documents/cdc-race--ethnicity-background-and-purpose.pdf). See urn:oid:2.16.840.1.113883.6.238
(message has no fields)
Auto-generated from StructureDefinition for USCoreAllergyIntolerance. Allergy or Intolerance (generally: Risk of adverse reaction to a substance). See http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance
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:
Documentation of substances suspected of (or not suspected of) causing an allergy or intolerance reaction in an individual. **Inclusion Criteria:** specific or general substances to which a patient may be exposed and which may be suspected of causing an adverse reaction; assertions refuting these suspicions. This includes: 1. Common dietary substances for allergy and intolerance documentation (SNOMEDCT) 2. Common drug classes for allergy and intolerance documentation (SNOMEDCT) 3. Common drug substances for allergy and intolerance documentation (RXNORM) 4. Common environmental substances for allergy and intolerance documentation (SNOMEDCT) 5. Common refutations and null values for substance causes for allergy and intolerance documentation (SNOMEDCT) **Exclusion Criteria:** actual conditions caused by exposure (reactions, allergies) See http://hl7.org/fhir/us/core/ValueSet/us-core-allergy-substance
(message has no fields)
Set of codes that are needed for implementation of the US-Core profiles. These codes are used as extensions to the FHIR and US Core value sets. See http://hl7.org/fhir/us/core/CodeSystem/careplan-category
(message has no fields)
Auto-generated from StructureDefinition for USCoreCarePlanProfile. Healthcare plan for patient or group. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan
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:
Auto-generated from StructureDefinition for USCoreCareTeam. Planned participants in the coordination and delivery of care for a patient or group. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam
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:
The US Core Clinical Note Type Value Set is a 'starter set' of types supported for fetching and storing clinical notes. See http://hl7.org/fhir/us/core/ValueSet/us-core-clinical-note-type
(message has no fields)
The US Core Condition Category Codes support the separate concepts of problems and health concerns in Condition.category in order for API consumers to be able to separate health concerns and problems. However this is not mandatory for 2015 certification See http://hl7.org/fhir/us/core/ValueSet/us-core-condition-category
(message has no fields)
Set of codes that are needed for implementation of the US-Core profiles. These codes are used as extensions to the FHIR and US Core value sets. See http://hl7.org/fhir/us/core/CodeSystem/condition-category
(message has no fields)
This describes the problem. Diagnosis/Problem List is broadly defined as a series of brief statements that catalog a patient's medical, nursing, dental, social, preventative and psychiatric events and issues that are relevant to that patient's healthcare (e.g., signs, symptoms, and defined conditions). ICD-10 is appropriate for Diagnosis information, and ICD-9 for historical information. See http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code
(message has no fields)
The US Core Diagnostic Report Category Value Set is a 'starter set' of categories supported for fetching and Diagnostic Reports and notes. See http://hl7.org/fhir/us/core/ValueSet/us-core-diagnosticreport-category
(message has no fields)
Auto-generated from StructureDefinition for USCoreDiagnosticReportProfileLaboratoryReporting. A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab
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
US Core Laboratory Report Order Code
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
Specimen Collection Datetime or Period
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 USCoreDiagnosticReportProfileNoteExchange. US Core Diagnostic Report Profile for Report and Note exchange. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note
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
US Core Report Code
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
Time of the report or note
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 USCoreDocumentReferenceProfile. A reference to a document. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference
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 US Core DocumentReference Type Value Set includes all LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown' See http://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-type
(message has no fields)
The US Core DocumentReferences Type Code System is a 'starter set' of categories supported for fetching and storing DocumentReference Resources. See http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category
(message has no fields)
Auto-generated from StructureDefinition for USCoreEncounterProfile. An interaction during which services are provided to the patient. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter
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 USCoreGoalProfile. Describes the intended objective(s) for a patient, group or organization. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal
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 USCoreImmunizationProfile. Immunization event information. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization
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 Type (bind to CVX)
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 USCoreImplantableDeviceProfile. Item used in healthcare. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device
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 USCoreLaboratoryResultObservationProfile. Measurements and simple assertions. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab
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
Laboratory Test Name
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:
Result Value
Used in:
Auto-generated from StructureDefinition for USCoreLocation. Details and position information for a physical place. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-location
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 USCoreMedicationProfile. Definition of a Medication. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication
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 USCoreMedicationRequestProfile. Ordering of medication for patient or group. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest
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:
Codes providing the status of an observation for smoking status. Constrained to `final`and `entered-in-error`. See http://hl7.org/fhir/us/core/ValueSet/us-core-observation-smoking-status-status
(message has no fields)
Used in:
Auto-generated from StructureDefinition for USCoreOrganizationProfile. A grouping of people or organizations with a common purpose. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
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 USCorePatientProfile. Information about an individual or animal receiving health care services. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
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
Extension
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
US Core Race Extension
US Core ethnicity Extension
Extension
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 USCorePediatricBMIforAgeObservationProfile. FHIR Vital Signs Profile. See http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age
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
BMI percentile per age and sex for youth 2-20
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
Used when reporting vital signs panel components
Related measurements the observation is made from
Used when reporting systolic and diastolic blood pressure.
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
Vital Sign Value recorded with UCUM
Used in:
Often just a dateTime for Vital Signs
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:
Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
Used in:
Auto-generated from StructureDefinition for USCorePediatricWeightForHeightObservationProfile. FHIR Vital Signs Profile. See http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height
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
Weight-for-length per age and gender
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
Used when reporting vital signs panel components
Related measurements the observation is made from
Used when reporting systolic and diastolic blood pressure.
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
Vital Sign Value recorded with UCUM
Used in:
Often just a dateTime for Vital Signs
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:
Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
Used in:
Auto-generated from StructureDefinition for USCorePractitionerProfile. A person with a formal responsibility in the provisioning of healthcare or related services. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
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 USCorePractitionerRoleProfile. Roles/organizations the practitioner is associated with. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole
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 USCoreProcedureProfile. An action that is being or was performed on a patient. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure
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
Procedure codes from SNOMED CT, CPT, or HCPCS II
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 USCoreProvenance. US Core Provenance. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance
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 Resource this Provenance record supports
Timestamp 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:
The type of participation a provenance agent played for a given target. See http://hl7.org/fhir/us/core/ValueSet/us-core-provenance-participant-type
(message has no fields)
Set of codes that are needed for implementation of the US-Core profiles. These codes are used as extensions to the FHIR and US Core value sets. See http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type
(message has no fields)
Provider roles codes which are composed of the NUCC Health Care Provider Taxonomy Code Set classification codes for providers. Only concepts with a classification and no specialization are included. See http://hl7.org/fhir/us/core/ValueSet/us-core-provider-role
(message has no fields)
Auto-generated from StructureDefinition for USCorePulseOximetryProfile. FHIR Oxygen Saturation Profile. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry
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
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
Used when reporting vital signs panel components
Related measurements the observation is made from
Oxygen Saturation by Pulse Oximetry
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
Used when reporting systolic and diastolic blood pressure.
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
Vital Sign Value recorded with UCUM
Used in:
Often just a dateTime for Vital Signs
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:
Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.
Used in:
The US Core Smoking Status Observation Codes Value Set is a 'starter set' of concepts to capture smoking status. See http://hl7.org/fhir/us/core/ValueSet/us-core-smoking-status-observation-codes
(message has no fields)
Auto-generated from StructureDefinition for USCoreSmokingStatusProfile. Measurements and simple assertions. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus
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
Smoking Status
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:
This value set indicates the current smoking status of a patient. See http://hl7.org/fhir/us/core/ValueSet/us-core-observation-smokingstatus
(message has no fields)
This identifies the vaccine substance administered - CVX codes. **Inclusion Criteria:** Any CVX code with CVX 'status' (VSAC Property) = `Active`,` Inactive`, `Non-US` except those noted in exclusions. **Exclusion Criteria:** CVX codes that have a CVX 'status' of either `Pending` or `Never Active` AND CVX codes with CVX 'Nonvaccine' property = True. Available at http://www2a.cdc.gov/vaccines/iis/iisstandards/vaccines.asp?rpt=cvx See http://hl7.org/fhir/us/core/ValueSet/us-core-vaccines-cvx
(message has no fields)
This value set includes all the Vaccine National Drug Codes (NDC). This source of this data is provided by the [CDC](https://www2a.cdc.gov/vaccines/iis/iisstandards/ndc_crosswalk.asp) See http://hl7.org/fhir/us/core/ValueSet/us-core-ndc-vaccine-codes
(message has no fields)
Auto-generated from StructureDefinition for USCoreCondition. Detailed information about conditions, problems or diagnoses. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition
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 | health-concern
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 USCoreDirectEmailExtension. Email is a "direct" email. See http://hl7.org/fhir/us/core/StructureDefinition/us-core-direct
Unique id for inter-element referencing
Additional content defined by implementations
Value of extension
This value set defines two letter USPS alphabetic codes. See http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
(message has no fields)