Implementation Guide
23.1.0 - R4 APIs

Publish Box goes here

Resource Profile: Profile - Athena Observation

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile Version: 23.1.0
Active as of 2022-03-01 Computable Name: AthenaObservation

athena observation profile

This Observation profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read, search, create and update capabilities of these products.

Overview

This resource captures measurements and simple assertions made about a patient, device, or other subject.

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access Observation resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

The profile also defines the content that must be supplied to the API Server in response to requests to populate Observation resources. Fields which are marked as Mandatory in this profile are those that must be supplied to the API Server in content used to populate a resource.

Source

The Observation resource is derived from the OBS and other related tables in athenaPractice and athenaFlow. Specific detail can be found in the Mappings tab in the profile detail page.

Usage:

Formal Views of Profile Content

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

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* Observation Measurements and simple assertions
... id S 0..1 id Unique Id for this particular observation
... meta S 0..1 Meta Unique Id for this particular observation
.... versionId 0..1 id Version specific identifier
.... lastUpdated 0..1 instant When the resource version last changed
.... Slices for profile 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Athena Allergy Profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile
..... profile:US Core Observation Lab Profile 0..1 canonical() This USCore profile is supported only for obsterms with category Laboratory
..... profile:US Core Pediatric BMI For Age Profile 0..1 canonical() This USCore profile is supported only for obsterm with HDID 22346
..... profile:US Core Pulse Oximetry Profile 0..1 canonical() This USCore profile is supported only for obsterm with HDID 2173
..... profile:US Core Pediatric Head Occipital-frontal Circumference Percentile Profile 0..1 canonical() This USCore profile is supported only for obsterm with HDID 5346
..... profile:US Core Pediatric Weight For Height Profile 0..1 canonical() This USCore profile is supported only for obsterm with HDID 29139
..... profile:US Core Smokingstatus Profile 0..1 canonical() This USCore profile is supported only for obsterm with LOINC code 72166-2
..... profile:US Core Blood Pressure Profile 0..1 canonical() This USCore profile is supported only for obsterm with HDID BP-PANEL
.... Slices for security 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
..... security:SENSITIVECHART 0..1 Coding Security Labels applied to this resource
..... security:CONFABBR 0..1 Coding Security Labels applied to this resource
...... system 1..1 uri Identity of the terminology system
...... code 1..1 code Symbol in syntax defined by the system
.... tag 1..2 Coding Tags applied to this resource
... identifier 0..* Identifier Unique Id for this particular observation
... Slices for category 0..1 CodeableConcept Classification of type of observation
Slice: Unordered, Open by value:CodeableConcept
.... category:FHIRCATEGORY 0..1 CodeableConcept Classification of type of observation
..... coding 0..1 Coding Code defined by a terminology system
.... category:PANELCATEGORY 0..1 CodeableConcept Classification of type of observation
..... coding 0..1 Coding Code defined by a terminology system
.... category:HG_GROUPID 0..1 CodeableConcept Classification of type of observation
..... coding 0..1 Coding Code defined by a terminology system
..... text 0..1 string Plain text representation of the concept
... code S 1..1 CodeableConcept Type of observation (code / type)
.... Slices for coding 0..4 Coding Code defined by a terminology system
Slice: Unordered, Open by value:coding
..... coding:TOCODE 0..1 Coding Code defined by a terminology system
..... coding:HDID 0..1 Coding Code defined by a terminology system
..... coding:C1_CODE 0..1 Coding Code defined by a terminology system
..... coding:C2_CODE 0..1 Coding Code defined by a terminology system
.... text 0..1 string Plain text representation of the concept
... subject S 0..1 Reference(Patient) Who and/or what this is about
... encounter S 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] S 0..1 dateTime Clinically relevant time/time-period for observation
... issued S 0..1 instant Date/Time this was made available
... Slices for performer 1..2 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
Slice: Unordered, Open by value:type
.... performer:PractitionerPerformer S 1..1 Reference(Practitioner) Who is responsible for the observation
.... performer:OrganizationPerformer S 0..1 Reference(Organization) Who is responsible for the observation
... value[x] S 0..1 Actual result
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
... dataAbsentReason 0..1 CodeableConcept Why the result is missing
... interpretation 0..1 CodeableConcept High, low, normal, etc.
... note 0..1 Annotation Comments about result
... referenceRange 0..1 BackboneElement Provides guide for interpretation
.... text 0..1 string Provides guide for interpretation
... component 0..1 BackboneElement Only supported for USCore pulse Oximetry profile
.... code 0..1 CodeableConcept Type of component observation (code / type)
..... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:coding
...... coding:TOCODE 0..1 Coding Code defined by a terminology system
...... coding:HDID 0..1 Coding Code defined by a terminology system
.... value[x] 0..1 Quantity Actual component result
.... dataAbsentReason 0..1 CodeableConcept Why the component result is missing

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... id SΣ 0..1 id Unique Id for this particular observation
... meta SΣ 0..1 Meta Unique Id for this particular observation
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... Slices for profile Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Athena Allergy Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile
..... profile:US Core Observation Lab Profile Σ 0..1 canonical() This USCore profile is supported only for obsterms with category Laboratory
..... profile:US Core Pediatric BMI For Age Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID 22346
..... profile:US Core Pulse Oximetry Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID 2173
..... profile:US Core Pediatric Head Occipital-frontal Circumference Percentile Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID 5346
..... profile:US Core Pediatric Weight For Height Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID 29139
..... profile:US Core Smokingstatus Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with LOINC code 72166-2
..... profile:US Core Blood Pressure Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID BP-PANEL
.... Slices for security Σ 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... system Σ 1..1 uri Identity of the terminology system
...... code Σ 1..1 code Symbol in syntax defined by the system
.... tag Σ 1..2 Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..* Identifier Unique Id for this particular observation
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category 0..1 CodeableConcept Classification of type of observation
Slice: Unordered, Open by value:CodeableConcept
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:FHIRCATEGORY 0..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ 0..1 Coding Code defined by a terminology system
.... category:PANELCATEGORY 0..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ 0..1 Coding Code defined by a terminology system
.... category:HG_GROUPID 0..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ 0..1 Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... Slices for coding Σ 0..4 Coding Code defined by a terminology system
Slice: Unordered, Open by value:coding
..... coding:TOCODE Σ 0..1 Coding Code defined by a terminology system
..... coding:HDID Σ 0..1 Coding Code defined by a terminology system
..... coding:C1_CODE Σ 0..1 Coding Code defined by a terminology system
..... coding:C2_CODE Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 0..1 Reference(Patient) Who and/or what this is about
... encounter SΣ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] SΣ 0..1 dateTime Clinically relevant time/time-period for observation
... issued SΣ 0..1 instant Date/Time this was made available
... Slices for performer Σ 1..2 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
Slice: Unordered, Open by value:type
.... performer:PractitionerPerformer SΣ 1..1 Reference(Practitioner) Who is responsible for the observation
.... performer:OrganizationPerformer SΣ 0..1 Reference(Organization) Who is responsible for the observation
... value[x] SΣC 0..1 Actual result
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
... 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..1 CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..1 Annotation Comments about result
... referenceRange C 0..1 BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text 0..1 string Provides guide for interpretation
... component Σ 0..1 BackboneElement Only supported for USCore pulse Oximetry profile
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 0..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:coding
...... coding:TOCODE Σ 0..1 Coding Code defined by a terminology system
...... coding:HDID Σ 0..1 Coding Code defined by a terminology system
.... value[x] Σ 0..1 Quantity Actual component result
.... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Observation.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Observation.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Observation.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:FHIRCATEGORYpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:PANELCATEGORYpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:HG_GROUPIDpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... id SΣ 0..1 id Unique Id for this particular observation
... meta SΣ 0..1 Meta Unique Id for this particular observation
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Athena Allergy Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile
..... profile:US Core Observation Lab Profile Σ 0..1 canonical() This USCore profile is supported only for obsterms with category Laboratory
..... profile:US Core Pediatric BMI For Age Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID 22346
..... profile:US Core Pulse Oximetry Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID 2173
..... profile:US Core Pediatric Head Occipital-frontal Circumference Percentile Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID 5346
..... profile:US Core Pediatric Weight For Height Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID 29139
..... profile:US Core Smokingstatus Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with LOINC code 72166-2
..... profile:US Core Blood Pressure Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID BP-PANEL
.... Slices for security Σ 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... tag Σ 1..2 Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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
... 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 Unique Id for this particular 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 0..1 CodeableConcept Classification of type of observation
Slice: Unordered, Open by value:CodeableConcept
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:FHIRCATEGORY 0..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..1 Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... category:PANELCATEGORY 0..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..1 Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... category:HG_GROUPID 0..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..1 Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..4 Coding Code defined by a terminology system
Slice: Unordered, Open by value:coding
..... coding:TOCODE Σ 0..1 Coding Code defined by a terminology system
..... coding:HDID Σ 0..1 Coding Code defined by a terminology system
..... coding:C1_CODE Σ 0..1 Coding Code defined by a terminology system
..... coding:C2_CODE Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 0..1 Reference(Patient) Who and/or what this is about
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter SΣ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] SΣ 0..1 dateTime Clinically relevant time/time-period for observation
... issued SΣ 0..1 instant Date/Time this was made available
... Slices for performer Σ 1..2 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
Slice: Unordered, Open by value:type
.... performer:PractitionerPerformer SΣ 1..1 Reference(Practitioner) Who is responsible for the observation
.... performer:OrganizationPerformer SΣ 0..1 Reference(Organization) Who is responsible for the observation
... value[x] SΣC 0..1 Actual result
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
... 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..1 CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..1 Annotation Comments about result
... 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..1 BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... 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 Low Range, if relevant
.... high C 0..1 SimpleQuantity 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 Provides guide for interpretation
... 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..1 BackboneElement Only supported for USCore pulse Oximetry profile
.... 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 Σ 0..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:coding
...... coding:TOCODE Σ 0..1 Coding Code defined by a terminology system
...... coding:HDID Σ 0..1 Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... value[x] Σ 0..1 Quantity Actual component result
.... 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

PathConformanceValueSetURI
Observation.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Observation.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Observation.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Observation.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:FHIRCATEGORYpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:PANELCATEGORYpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:HG_GROUPIDpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

This structure is derived from Observation

Summary

Mandatory: 4 elements(4 nested mandatory elements)
Must-Support: 11 elements
Fixed: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.meta.profile
  • The element 1 is sliced based on the value of Observation.meta.security
  • The element 1 is sliced based on the value of Observation.category
  • The element 1 is sliced based on the value of Observation.code.coding
  • The element 1 is sliced based on the value of Observation.performer
  • The element 1 is sliced based on the value of Observation.component.code.coding

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* Observation Measurements and simple assertions
... id S 0..1 id Unique Id for this particular observation
... meta S 0..1 Meta Unique Id for this particular observation
.... versionId 0..1 id Version specific identifier
.... lastUpdated 0..1 instant When the resource version last changed
.... Slices for profile 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Athena Allergy Profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile
..... profile:US Core Observation Lab Profile 0..1 canonical() This USCore profile is supported only for obsterms with category Laboratory
..... profile:US Core Pediatric BMI For Age Profile 0..1 canonical() This USCore profile is supported only for obsterm with HDID 22346
..... profile:US Core Pulse Oximetry Profile 0..1 canonical() This USCore profile is supported only for obsterm with HDID 2173
..... profile:US Core Pediatric Head Occipital-frontal Circumference Percentile Profile 0..1 canonical() This USCore profile is supported only for obsterm with HDID 5346
..... profile:US Core Pediatric Weight For Height Profile 0..1 canonical() This USCore profile is supported only for obsterm with HDID 29139
..... profile:US Core Smokingstatus Profile 0..1 canonical() This USCore profile is supported only for obsterm with LOINC code 72166-2
..... profile:US Core Blood Pressure Profile 0..1 canonical() This USCore profile is supported only for obsterm with HDID BP-PANEL
.... Slices for security 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
..... security:SENSITIVECHART 0..1 Coding Security Labels applied to this resource
..... security:CONFABBR 0..1 Coding Security Labels applied to this resource
...... system 1..1 uri Identity of the terminology system
...... code 1..1 code Symbol in syntax defined by the system
.... tag 1..2 Coding Tags applied to this resource
... identifier 0..* Identifier Unique Id for this particular observation
... Slices for category 0..1 CodeableConcept Classification of type of observation
Slice: Unordered, Open by value:CodeableConcept
.... category:FHIRCATEGORY 0..1 CodeableConcept Classification of type of observation
..... coding 0..1 Coding Code defined by a terminology system
.... category:PANELCATEGORY 0..1 CodeableConcept Classification of type of observation
..... coding 0..1 Coding Code defined by a terminology system
.... category:HG_GROUPID 0..1 CodeableConcept Classification of type of observation
..... coding 0..1 Coding Code defined by a terminology system
..... text 0..1 string Plain text representation of the concept
... code S 1..1 CodeableConcept Type of observation (code / type)
.... Slices for coding 0..4 Coding Code defined by a terminology system
Slice: Unordered, Open by value:coding
..... coding:TOCODE 0..1 Coding Code defined by a terminology system
..... coding:HDID 0..1 Coding Code defined by a terminology system
..... coding:C1_CODE 0..1 Coding Code defined by a terminology system
..... coding:C2_CODE 0..1 Coding Code defined by a terminology system
.... text 0..1 string Plain text representation of the concept
... subject S 0..1 Reference(Patient) Who and/or what this is about
... encounter S 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] S 0..1 dateTime Clinically relevant time/time-period for observation
... issued S 0..1 instant Date/Time this was made available
... Slices for performer 1..2 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
Slice: Unordered, Open by value:type
.... performer:PractitionerPerformer S 1..1 Reference(Practitioner) Who is responsible for the observation
.... performer:OrganizationPerformer S 0..1 Reference(Organization) Who is responsible for the observation
... value[x] S 0..1 Actual result
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
... dataAbsentReason 0..1 CodeableConcept Why the result is missing
... interpretation 0..1 CodeableConcept High, low, normal, etc.
... note 0..1 Annotation Comments about result
... referenceRange 0..1 BackboneElement Provides guide for interpretation
.... text 0..1 string Provides guide for interpretation
... component 0..1 BackboneElement Only supported for USCore pulse Oximetry profile
.... code 0..1 CodeableConcept Type of component observation (code / type)
..... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:coding
...... coding:TOCODE 0..1 Coding Code defined by a terminology system
...... coding:HDID 0..1 Coding Code defined by a terminology system
.... value[x] 0..1 Quantity Actual component result
.... dataAbsentReason 0..1 CodeableConcept Why the component result is missing

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... id SΣ 0..1 id Unique Id for this particular observation
... meta SΣ 0..1 Meta Unique Id for this particular observation
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... Slices for profile Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Athena Allergy Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile
..... profile:US Core Observation Lab Profile Σ 0..1 canonical() This USCore profile is supported only for obsterms with category Laboratory
..... profile:US Core Pediatric BMI For Age Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID 22346
..... profile:US Core Pulse Oximetry Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID 2173
..... profile:US Core Pediatric Head Occipital-frontal Circumference Percentile Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID 5346
..... profile:US Core Pediatric Weight For Height Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID 29139
..... profile:US Core Smokingstatus Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with LOINC code 72166-2
..... profile:US Core Blood Pressure Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID BP-PANEL
.... Slices for security Σ 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... system Σ 1..1 uri Identity of the terminology system
...... code Σ 1..1 code Symbol in syntax defined by the system
.... tag Σ 1..2 Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..* Identifier Unique Id for this particular observation
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category 0..1 CodeableConcept Classification of type of observation
Slice: Unordered, Open by value:CodeableConcept
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:FHIRCATEGORY 0..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ 0..1 Coding Code defined by a terminology system
.... category:PANELCATEGORY 0..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ 0..1 Coding Code defined by a terminology system
.... category:HG_GROUPID 0..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ 0..1 Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... Slices for coding Σ 0..4 Coding Code defined by a terminology system
Slice: Unordered, Open by value:coding
..... coding:TOCODE Σ 0..1 Coding Code defined by a terminology system
..... coding:HDID Σ 0..1 Coding Code defined by a terminology system
..... coding:C1_CODE Σ 0..1 Coding Code defined by a terminology system
..... coding:C2_CODE Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 0..1 Reference(Patient) Who and/or what this is about
... encounter SΣ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] SΣ 0..1 dateTime Clinically relevant time/time-period for observation
... issued SΣ 0..1 instant Date/Time this was made available
... Slices for performer Σ 1..2 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
Slice: Unordered, Open by value:type
.... performer:PractitionerPerformer SΣ 1..1 Reference(Practitioner) Who is responsible for the observation
.... performer:OrganizationPerformer SΣ 0..1 Reference(Organization) Who is responsible for the observation
... value[x] SΣC 0..1 Actual result
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
... 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..1 CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..1 Annotation Comments about result
... referenceRange C 0..1 BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text 0..1 string Provides guide for interpretation
... component Σ 0..1 BackboneElement Only supported for USCore pulse Oximetry profile
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 0..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:coding
...... coding:TOCODE Σ 0..1 Coding Code defined by a terminology system
...... coding:HDID Σ 0..1 Coding Code defined by a terminology system
.... value[x] Σ 0..1 Quantity Actual component result
.... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Observation.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Observation.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Observation.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Observation.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:FHIRCATEGORYpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:PANELCATEGORYpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:HG_GROUPIDpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* Observation Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
... id SΣ 0..1 id Unique Id for this particular observation
... meta SΣ 0..1 Meta Unique Id for this particular observation
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:Athena Allergy Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile
..... profile:US Core Observation Lab Profile Σ 0..1 canonical() This USCore profile is supported only for obsterms with category Laboratory
..... profile:US Core Pediatric BMI For Age Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID 22346
..... profile:US Core Pulse Oximetry Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID 2173
..... profile:US Core Pediatric Head Occipital-frontal Circumference Percentile Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID 5346
..... profile:US Core Pediatric Weight For Height Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID 29139
..... profile:US Core Smokingstatus Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with LOINC code 72166-2
..... profile:US Core Blood Pressure Profile Σ 0..1 canonical() This USCore profile is supported only for obsterm with HDID BP-PANEL
.... Slices for security Σ 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... tag Σ 1..2 Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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
... 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 Unique Id for this particular 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 0..1 CodeableConcept Classification of type of observation
Slice: Unordered, Open by value:CodeableConcept
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:FHIRCATEGORY 0..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..1 Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... category:PANELCATEGORY 0..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..1 Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... category:HG_GROUPID 0..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..1 Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..4 Coding Code defined by a terminology system
Slice: Unordered, Open by value:coding
..... coding:TOCODE Σ 0..1 Coding Code defined by a terminology system
..... coding:HDID Σ 0..1 Coding Code defined by a terminology system
..... coding:C1_CODE Σ 0..1 Coding Code defined by a terminology system
..... coding:C2_CODE Σ 0..1 Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 0..1 Reference(Patient) Who and/or what this is about
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter SΣ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] SΣ 0..1 dateTime Clinically relevant time/time-period for observation
... issued SΣ 0..1 instant Date/Time this was made available
... Slices for performer Σ 1..2 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
Slice: Unordered, Open by value:type
.... performer:PractitionerPerformer SΣ 1..1 Reference(Practitioner) Who is responsible for the observation
.... performer:OrganizationPerformer SΣ 0..1 Reference(Organization) Who is responsible for the observation
... value[x] SΣC 0..1 Actual result
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
... 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..1 CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..1 Annotation Comments about result
... 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..1 BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... 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 Low Range, if relevant
.... high C 0..1 SimpleQuantity 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 Provides guide for interpretation
... 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..1 BackboneElement Only supported for USCore pulse Oximetry profile
.... 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 Σ 0..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:coding
...... coding:TOCODE Σ 0..1 Coding Code defined by a terminology system
...... coding:HDID Σ 0..1 Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... value[x] Σ 0..1 Quantity Actual component result
.... 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

PathConformanceValueSetURI
Observation.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Observation.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Observation.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Observation.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:FHIRCATEGORYpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:PANELCATEGORYpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:HG_GROUPIDpreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodexampleObservationMethods
http://hl7.org/fhir/ValueSet/observation-methods
from the FHIR Standard
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

This structure is derived from Observation

Summary

Mandatory: 4 elements(4 nested mandatory elements)
Must-Support: 11 elements
Fixed: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.meta.profile
  • The element 1 is sliced based on the value of Observation.meta.security
  • The element 1 is sliced based on the value of Observation.category
  • The element 1 is sliced based on the value of Observation.code.coding
  • The element 1 is sliced based on the value of Observation.performer
  • The element 1 is sliced based on the value of Observation.component.code.coding

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

Interactions supported by this resource are listed below.

Search Parameters

Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Observation resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/fhir/r4/Observation?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}

Where:

Name Description
[base] Specifies the base URL of the FHIR Server, e.g., https://apsandbox.fhirapi.athenahealth.com/demoAPIServer
[_count] Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results Observation resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Athenahealth Partner program. Note: The API Server support the HL7 FHIR Paging capability.
[_format] Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary] Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.
_id (token) The ID of the resource
_security (token) Search by a security label
_tag (token) Search by a resource tag
_lastUpdated (date)
_lastUpdated-fromnow (quantity) Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time, e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.
category (token) The classification of the type of observation
code (token) The code of the observation type
combo-code (token) The code of the observation type or component type
combo-value-concept (token) The value or component value of the observation, if the value is a CodeableConcept
combo-value-quantity (quantity) Code and quantity value parameter pair, including in components
component-code (token) The component code of the observation type
component-value-quantity (quantity) The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)
date (date) Obtained date/time. If the obtained element is a period, a date that falls in the period
date-fromnow (quantity) Like date except expressed as a positive or negative offset from the current time in units of time, e.g. occurrence-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.
encounter (reference) Encounter related to the observation
identifier (token) The unique id for a particular observation
patient (reference) The subject that the observation is about (if patient)
performer (reference) Who performed the observation
status (token) The status of the observation
subject (reference) The subject that the observation is about
value-concept (token) The value of the observation, if the value is a CodeableConcept
value-quantity (quantity) The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)
_recent (quantity) Specifies the number of most recent (latest) results to return for each matching observation term. The value must be a positive integer. e.g. _recent=1 to request only the single most recent value for each type of observation (OBS term).
HTTP Response Codes

The following HTTP response codes are returned by this API call:

200 OK The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 Unauthorized Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 Server Error The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.