Health eData 1 Sandbox
0.1.0 - CI Build United States of America flag

Health eData 1 Sandbox, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/argonautproject/USCDIV7/ and changes regularly. See the Directory of published versions

Resource Profile: US Core Observation Patient Accommodation Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-accommodation Version: 0.1.0
Active as of 2026-05-13 Maturity Level: 3 Computable Name: USCoreObservationAccommodationProfile
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.73

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

The US Core Observation Patient Accommodation Profile inherits from the FHIR Observation resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Accommodation Data Element of the Patient Demographics/Information Data Class. It sets minimum expectations for the Observation resource to record, search, and fetch information about modifications, tools, technologies, and other supports necessary to enable a patient to access care. Examples include, but are not limited to, sign language interpreters, wheelchair accessibility requirements, and sensory accommodation. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

Example Usage Scenarios:

The following are example usage scenarios for the US Core Observation profile:

  • Query for Observation resources belonging to a Patient
  • [Record or update] a Patient Observation

Mandatory and Must Support Data Elements

The following data elements must always be present ([Mandatory] definition) or must be supported if the data is present in the sending system ([Must Support] definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The [Formal Views] below provides the formal summary, definitions, and terminology requirements.

Each Observation Must Have:

  1. a status
  2. patient accommodation code
  3. a patient

Each Observation Must Support:

  1. classification of type of observation
  2. clinically relevant time or time period for the observation
  3. coded or free text patient accommodation

Additional USCDI Requirements:

These [Additional USCDI Requirements] elements are not Mandatory or Must Support but are required for ONC Health IT certification testing and are included in the formal definition of the profile and the Observation examples.

  1. π—”π——π——π—œπ—§π—œπ—’π—‘π—”π—Ÿ π—¨π—¦π—–π——π—œ: who is responsible for the observation

Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

Liquid Script to Generate StructureDefinition All Nice N Pretty Like

{% include structure-table.md sd=sd source="differential" show_must_support=true show_uscdi=true %}

USCoreObservationAccommodationProfile β€” US Core Observation Patient Accommodation Profile

The US Core Observation Patient Accommodation Profile inherits from the FHIR Observation resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Accommodation Data Element of the Patient Demographics/Information Data Class. It sets minimum expectations for the Observation resource to record, search, and fetch information about modifications, tools, technologies, and other supports necessary to enable a patient to access care. Examples include, but are not limited to, sign language interpreters, wheelchair accessibility requirements, and sensory accommodation. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

  • URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-accommodation
  • Version: 0.1.0
  • Status: active
  • Kind: resource
  • Type: Observation
  • Base Definition: http://hl7.org/fhir/StructureDefinition/Observation
  • Derivation: constraint

Elements (differential)

Element Must Support Add'l USCDI Cardinality Type Description
Observation Β  Β  0..* Β  US Core Observation Patient Accommodation Profile
Measurements and simple assertions made about a patient, device or other subject.
↳ status βœ… Β  1..1 code registered | preliminary | final | amended +
The status of the result value.
Binding: http://hl7.org/fhir/ValueSet/observation-status\|4.0.1 (required) β€” Codes providing the status of an observation.
↳ category βœ… Β  0..* CodeableConcept Classification of type of observation
A code that classifies the general type of observation being made.
Binding: http://hl7.org/fhir/us/core/ValueSet/us-core-simple-observation-category (preferred) β€” FHIR and US Core codes for high level observation categories.
Slicing: discriminator value@$this β€” rules: open
↳ category
slice: us-core		 βœ… Β  0..1 CodeableConcept Classification of type of observation
A code that classifies the general type of observation being made.
Binding: http://hl7.org/fhir/us/core/ValueSet/us-core-simple-observation-category (preferred) β€” FHIR and US Core codes for high level observation categories.
Pattern (CodeableConcept): http://hl7.org/fhir/us/core/CodeSystem/us-core-category#accommodation
↳ code βœ… Β  1..1 CodeableConcept Patient accommodation code
Describes what was observed. Sometimes this is called the observation "name".
Binding: http://hl7.org/fhir/ValueSet/observation-codes\|4.0.1 (example) β€” Codes identifying names of simple observations.
Pattern (CodeableConcept): http://hl7.org/fhir/us/core/CodeSystem/us-core-category#accommodation
↳ subject βœ… Β  1..1 Reference
target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient		 Who and/or what the observation is about
The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the focus element or the code itself specifies the actual focus of the observation.
↳ effective[x] βœ… Β  0..1 dateTime
Period
Timing
instant		 Clinically relevant time/time-period for observation
The time or time-period the observed value is asserted as being true.
↳ performer Β  βœ… 0..* Reference
target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization
target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
target: http://hl7.org/fhir/StructureDefinition/PractitionerRole
target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam
target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson		 Who is responsible for the observation
Who was responsible for asserting the observed value as "true".
↳ value[x] βœ… Β  0..1 string
CodeableConcept		 Actual result
The information determined as a result of making the observation, if the information has a simple value.		 


## USCoreObservationAccommodationProfile β€” US Core Observation Patient Accommodation Profile

The US Core Observation Patient Accommodation Profile inherits from the FHIR [Observation](https://hl7.org/fhir/R4/observation.html) resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) *Accommodation Data Element of the Patient Demographics/Information Data Class*. It sets minimum expectations for the Observation resource to record, search, and fetch information about modifications, tools, technologies, and other supports necessary to enable a patient to access care. Examples include, but are not limited to, sign language interpreters, wheelchair accessibility requirements, and sensory accommodation. It specifies which core elements, extensions, vocabularies, and value sets **SHALL** be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

- **URL:** `http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-accommodation`
- **Version:** 0.1.0
- **Status:** active
- **Kind:** resource
- **Type:** `Observation`
- **Base Definition:** `http://hl7.org/fhir/StructureDefinition/Observation`
- **Derivation:** constraint


### Elements (differential)

| Element | Must Support | Add'l USCDI | Cardinality | Type | Description |
|---|:---:|:---:|---|---|---|
| `Observation` |  |  | 0..* |  | **US Core Observation Patient Accommodation Profile**<br/>Measurements and simple assertions made about a patient, device or other subject. |
| <span style="padding-left: 1.5em;">↳</span> `status` | βœ… |  | 1..1 | `code` | **registered \| preliminary \| final \| amended +**<br/>The status of the result value.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/observation-status\|4.0.1` (required) β€” Codes providing the status of an observation.</span> |
| <span style="padding-left: 1.5em;">↳</span> `category` | βœ… |  | 0..* | `CodeableConcept` | **Classification of  type of observation**<br/>A code that classifies the general type of observation being made.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/us/core/ValueSet/us-core-simple-observation-category` (preferred) β€” FHIR and US Core codes for high level observation categories.</span><br/><span style="font-size: 0.85em;">**Slicing:** discriminator `value@$this` β€” rules: open</span> |
| <span style="padding-left: 1.5em;">↳</span> `category`<br/><span style="font-size: 0.85em;">slice: `us-core`</span> | βœ… |  | 0..1 | `CodeableConcept` | **Classification of  type of observation**<br/>A code that classifies the general type of observation being made.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/us/core/ValueSet/us-core-simple-observation-category` (preferred) β€” FHIR and US Core codes for high level observation categories.</span><br/><span style="font-size: 0.85em;">**Pattern (CodeableConcept):** `http://hl7.org/fhir/us/core/CodeSystem/us-core-category#accommodation`</span> |
| <span style="padding-left: 1.5em;">↳</span> `code` | βœ… |  | 1..1 | `CodeableConcept` | **Patient accommodation code**<br/>Describes what was observed. Sometimes this is called the observation "name".<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/observation-codes\|4.0.1` (example) β€” Codes identifying names of simple observations.</span><br/><span style="font-size: 0.85em;">**Pattern (CodeableConcept):** `http://hl7.org/fhir/us/core/CodeSystem/us-core-category#accommodation`</span> |
| <span style="padding-left: 1.5em;">↳</span> `subject` | βœ… |  | 1..1 | `Reference`<br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient</span> | **Who and/or what the observation is about**<br/>The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. |
| <span style="padding-left: 1.5em;">↳</span> `effective[x]` | βœ… |  | 0..1 | `dateTime`<br/>`Period`<br/>`Timing`<br/>`instant` | **Clinically relevant time/time-period for observation**<br/>The time or time-period the observed value is asserted as being true. |
| <span style="padding-left: 1.5em;">↳</span> `performer` |  | βœ… | 0..* | `Reference`<br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/StructureDefinition/PractitionerRole</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson</span> | **Who is responsible for the observation**<br/>Who was responsible for asserting the observed value as "true". |
| <span style="padding-left: 1.5em;">↳</span> `value[x]` | βœ… |  | 0..1 | `string`<br/>`CodeableConcept` | **Actual result**<br/>The information determined as a result of making the observation, if the information has a simple value. |

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation US Core Observation Patient Accommodation Profile
Constraints: obs-6, obs-7
... implicitRules ?!Ξ£ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΞ£ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
.... category:us-core S 0..1 CodeableConcept Classification of type of observation
Binding: US Core Simple Observation Category (preferred): FHIR and US Core codes for high level observation categories.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: accommodation
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code SΞ£ 1..1 CodeableConcept Patient accommodation code
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-category
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: accommodation
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΞ£ 1..1 Reference(US Core Patient Profile(9.0.0-ballot)) Who and/or what the observation is about
... effective[x] SΞ£ 0..1 Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer Ξ£ 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile(9.0.0-ballot) | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who is responsible for the observation
... value[x] SΞ£C 0..1 Actual result
.... valueString string S
.... valueCodeableConcept CodeableConcept S

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred US Core Simple Observation Category 📦9.0.0-ballot US Core v9.0
Observation.category:us-core Base preferred US Core Simple Observation Category 📦9.0.0-ballot US Core v9.0
Observation.code Base example LOINC Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* Observation US Core Observation Patient Accommodation Profile
... status S 1..1 code registered | preliminary | final | amended +
... Slices for category S 0..* CodeableConcept Classification of type of observation
Slice: Unordered, Open by value:$this
Binding: US Core Simple Observation Category (preferred): FHIR and US Core codes for high level observation categories.
.... category:us-core S 0..1 CodeableConcept Classification of type of observation
Binding: US Core Simple Observation Category (preferred): FHIR and US Core codes for high level observation categories.
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: accommodation
... code S 1..1 CodeableConcept Patient accommodation code
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-category
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: accommodation
... effective[x] S 0..1 Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile(9.0.0-ballot) | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who is responsible for the observation
... value[x] S 0..1 Actual result
.... valueString string S
.... valueCodeableConcept CodeableConcept S

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.category Base preferred US Core Simple Observation Category 📦9.0.0-ballot US Core v9.0
Observation.category:us-core Base preferred US Core Simple Observation Category 📦9.0.0-ballot US Core v9.0
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation US Core Observation Patient Accommodation Profile
Constraints: obs-6, obs-7
... id Ξ£ 0..1 id Logical id of this artifact
... meta Ξ£ 0..1 Meta Metadata about the resource
... implicitRules ?!Ξ£ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Ξ£ 0..* Identifier Business Identifier for observation
... basedOn Ξ£ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... partOf Ξ£ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
... status ?!SΞ£ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
... Slices for category S 0..* CodeableConcept Classification of type of observation
Slice: Unordered, Open by value:$this
Binding: US Core Simple Observation Category (preferred): FHIR and US Core codes for high level observation categories.
.... category:us-core S 0..1 CodeableConcept Classification of type of observation
Binding: US Core Simple Observation Category (preferred): FHIR and US Core codes for high level observation categories.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: accommodation
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code SΞ£ 1..1 CodeableConcept Patient accommodation code
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-category
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: accommodation
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΞ£ 1..1 Reference(US Core Patient Profile(9.0.0-ballot)) Who and/or what the observation is about
... focus Ξ£ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Ξ£ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] SΞ£ 0..1 Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... issued Ξ£ 0..1 instant Date/Time this version was made available
... performer Ξ£ 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile(9.0.0-ballot) | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who is responsible for the observation
... value[x] SΞ£C 0..1 Actual result
.... valueString string S
.... valueCodeableConcept CodeableConcept S
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Ξ£ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
.... high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Ξ£ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
... derivedFrom Ξ£ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
... component Ξ£ 0..* BackboneElement Component results
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Ξ£ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Ξ£ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... value[x] Ξ£ 0..1 Actual component result
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
.... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred US Core Simple Observation Category 📦9.0.0-ballot US Core v9.0
Observation.category:us-core Base preferred US Core Simple Observation Category 📦9.0.0-ballot US Core v9.0
Observation.code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation US Core Observation Patient Accommodation Profile
Constraints: obs-6, obs-7
... implicitRules ?!Ξ£ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΞ£ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
.... category:us-core S 0..1 CodeableConcept Classification of type of observation
Binding: US Core Simple Observation Category (preferred): FHIR and US Core codes for high level observation categories.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: accommodation
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code SΞ£ 1..1 CodeableConcept Patient accommodation code
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-category
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: accommodation
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΞ£ 1..1 Reference(US Core Patient Profile(9.0.0-ballot)) Who and/or what the observation is about
... effective[x] SΞ£ 0..1 Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer Ξ£ 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile(9.0.0-ballot) | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who is responsible for the observation
... value[x] SΞ£C 0..1 Actual result
.... valueString string S
.... valueCodeableConcept CodeableConcept S

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred US Core Simple Observation Category 📦9.0.0-ballot US Core v9.0
Observation.category:us-core Base preferred US Core Simple Observation Category 📦9.0.0-ballot US Core v9.0
Observation.code Base example LOINC Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation 0..* Observation US Core Observation Patient Accommodation Profile
... status S 1..1 code registered | preliminary | final | amended +
... Slices for category S 0..* CodeableConcept Classification of type of observation
Slice: Unordered, Open by value:$this
Binding: US Core Simple Observation Category (preferred): FHIR and US Core codes for high level observation categories.
.... category:us-core S 0..1 CodeableConcept Classification of type of observation
Binding: US Core Simple Observation Category (preferred): FHIR and US Core codes for high level observation categories.
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: accommodation
... code S 1..1 CodeableConcept Patient accommodation code
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-category
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: accommodation
... effective[x] S 0..1 Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... performer 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile(9.0.0-ballot) | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who is responsible for the observation
... value[x] S 0..1 Actual result
.... valueString string S
.... valueCodeableConcept CodeableConcept S

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.category Base preferred US Core Simple Observation Category 📦9.0.0-ballot US Core v9.0
Observation.category:us-core Base preferred US Core Simple Observation Category 📦9.0.0-ballot US Core v9.0

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation US Core Observation Patient Accommodation Profile
Constraints: obs-6, obs-7
... id Ξ£ 0..1 id Logical id of this artifact
... meta Ξ£ 0..1 Meta Metadata about the resource
... implicitRules ?!Ξ£ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Ξ£ 0..* Identifier Business Identifier for observation
... basedOn Ξ£ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... partOf Ξ£ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
... status ?!SΞ£ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.
... Slices for category S 0..* CodeableConcept Classification of type of observation
Slice: Unordered, Open by value:$this
Binding: US Core Simple Observation Category (preferred): FHIR and US Core codes for high level observation categories.
.... category:us-core S 0..1 CodeableConcept Classification of type of observation
Binding: US Core Simple Observation Category (preferred): FHIR and US Core codes for high level observation categories.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: accommodation
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code SΞ£ 1..1 CodeableConcept Patient accommodation code
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-category
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: accommodation
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΞ£ 1..1 Reference(US Core Patient Profile(9.0.0-ballot)) Who and/or what the observation is about
... focus Ξ£ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Ξ£ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] SΞ£ 0..1 Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
... issued Ξ£ 0..1 instant Date/Time this version was made available
... performer Ξ£ 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile(9.0.0-ballot) | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Who is responsible for the observation
... value[x] SΞ£C 0..1 Actual result
.... valueString string S
.... valueCodeableConcept CodeableConcept S
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Ξ£ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
.... high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Ξ£ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
... derivedFrom Ξ£ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
... component Ξ£ 0..* BackboneElement Component results
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Ξ£ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Ξ£ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... value[x] Ξ£ 0..1 Actual component result
..... valueQuantity Quantity
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueBoolean boolean
..... valueInteger integer
..... valueRange Range
..... valueRatio Ratio
..... valueSampledData SampledData
..... valueTime time
..... valueDateTime dateTime
..... valuePeriod Period
.... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
.... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
.... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred US Core Simple Observation Category 📦9.0.0-ballot US Core v9.0
Observation.category:us-core Base preferred US Core Simple Observation Category 📦9.0.0-ballot US Core v9.0
Observation.code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

 

Other representations of profile: CSV, Excel, Schematron