NHSN Reporting: Inpatient Medication Administration
0.1.0 - STU 1 Ballot

This page is part of the NHSN Reporting: Inpatient Medication Administration (v0.1.0: STU 1 on FHIR R4 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: Observation - Laboratory SARS COVID-19

Defining URL:http://hl7.org/fhir/us/nhsn-med-admin/StructureDefinition/Observation-lab-sars-cov
Version:0.1.0
Name:ObservationLabSarsCov
Title:Observation Laboratory SARS COVID-19
Status:Active as of 2021-04-13T00:12:31+00:00
Definition:

This profile reprsents a SARS COVID-19 lab test

Publisher:HL7 International - Pharmacy Work Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/us/nhsn-med-admin/StructureDefinition/Observation-lab-sars-cov

Formal Views of Profile Content

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

This structure is derived from USCoreLaboratoryResultObservationProfile

Summary

Mandatory: 3 elements
Must-Support: 11 elements

Slices

This structure defines the following Slices:

  • The element Observation.code.coding is sliced based on the value of pattern:$this

This structure is derived from USCoreLaboratoryResultObservationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*USCoreLaboratoryResultObservationProfileMeasurements and simple assertions
... code S1..1CodeableConceptLaboratory Test Name
Binding: LOINCCodes (extensible): LOINC codes

.... coding S1..1(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:testSarsCov2NucleicAcid S0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 Nucleic Acid) (required): COVID_19 (Tests for SARS_CoV_2 Nucleic Acid)

..... coding:testPanelsSarsCov2NucleicAcid S0..1CodingCode defined by a terminology system
Binding: COVID_19 (Test Panels for SARS_CoV_2 Nucleic Acid) (required): COVID_19 (Test Panels for SARS_CoV_2 Nucleic Acid)

..... coding:testSarsCov2IgGAntibody S0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 IgG Antibody) (required): COVID_19 (Tests for SARS_CoV_2 IgG Antibody)

..... coding:testPanelsSarsCov2Antibody S0..1CodingCode defined by a terminology system
Binding: COVID_19 (Test Panels for SARS_CoV_2 Antibody) (required): COVID_19 (Test Panels for SARS_CoV_2 Antibody)

..... coding:testSarsCov2Antibody S0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 Antibody) (required): COVID_19 (Tests for SARS_CoV_2 Antibody)

..... coding:testSarsCov2Antigen S0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 Antigen) (required)
..... coding:testSarsCov2CultureIdMethod S0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 by Culture and Identification Method) (required): COVID_19 (Tests for SARS_CoV_2 by Culture and Identification Method)

..... coding:testPanelsSarsCov2Antigen S0..1CodingCode defined by a terminology system
Binding: VSAC 2.16.840.1.113762.1.4.1146.1270 (required): COVID_19 (Test Panels for SARS_CoV_2 Antigen)

... effective[x] S1..1dateTime, PeriodClinically relevant time/time-period for observation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*USCoreLaboratoryResultObservationProfileMeasurements and simple assertions
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness 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..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category S1..*(Slice Definition)Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:Laboratory S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: laboratory
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptLaboratory Test Name
Binding: LOINCCodes (extensible): LOINC codes

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ1..1(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:testSarsCov2NucleicAcid SΣ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 Nucleic Acid) (required): COVID_19 (Tests for SARS_CoV_2 Nucleic Acid)


..... coding:testPanelsSarsCov2NucleicAcid SΣ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Test Panels for SARS_CoV_2 Nucleic Acid) (required): COVID_19 (Test Panels for SARS_CoV_2 Nucleic Acid)


..... coding:testSarsCov2IgGAntibody SΣ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 IgG Antibody) (required): COVID_19 (Tests for SARS_CoV_2 IgG Antibody)


..... coding:testPanelsSarsCov2Antibody SΣ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Test Panels for SARS_CoV_2 Antibody) (required): COVID_19 (Test Panels for SARS_CoV_2 Antibody)


..... coding:testSarsCov2Antibody SΣ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 Antibody) (required): COVID_19 (Tests for SARS_CoV_2 Antibody)


..... coding:testSarsCov2Antigen SΣ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 Antigen) (required)
..... coding:testSarsCov2CultureIdMethod SΣ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 by Culture and Identification Method) (required): COVID_19 (Tests for SARS_CoV_2 by Culture and Identification Method)


..... coding:testPanelsSarsCov2Antigen SΣ0..1CodingCode defined by a terminology system
Binding: VSAC 2.16.840.1.113762.1.4.1146.1270 (required): COVID_19 (Test Panels for SARS_CoV_2 Antigen)


.... text Σ0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(US Core Patient Profile)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..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣI1..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] SΣI0..1Result Value
us-core-4: SHOULD use Snomed CT for coded Results
us-core-3: SHALL use UCUM for coded quantity units.
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)
... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method 0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText 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..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... value[x] Σ0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..*CodeableConceptHigh, 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*USCoreLaboratoryResultObservationProfileMeasurements and simple assertions
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 1..*(Slice Definition)Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:Laboratory 1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: laboratory
... code Σ1..1CodeableConceptLaboratory Test Name
Binding: LOINCCodes (extensible): LOINC codes

.... coding Σ1..1(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:testSarsCov2NucleicAcid Σ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 Nucleic Acid) (required): COVID_19 (Tests for SARS_CoV_2 Nucleic Acid)


..... coding:testPanelsSarsCov2NucleicAcid Σ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Test Panels for SARS_CoV_2 Nucleic Acid) (required): COVID_19 (Test Panels for SARS_CoV_2 Nucleic Acid)


..... coding:testSarsCov2IgGAntibody Σ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 IgG Antibody) (required): COVID_19 (Tests for SARS_CoV_2 IgG Antibody)


..... coding:testPanelsSarsCov2Antibody Σ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Test Panels for SARS_CoV_2 Antibody) (required): COVID_19 (Test Panels for SARS_CoV_2 Antibody)


..... coding:testSarsCov2Antibody Σ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 Antibody) (required): COVID_19 (Tests for SARS_CoV_2 Antibody)


..... coding:testSarsCov2Antigen Σ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 Antigen) (required)
..... coding:testSarsCov2CultureIdMethod Σ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 by Culture and Identification Method) (required): COVID_19 (Tests for SARS_CoV_2 by Culture and Identification Method)


..... coding:testPanelsSarsCov2Antigen Σ0..1CodingCode defined by a terminology system
Binding: VSAC 2.16.840.1.113762.1.4.1146.1270 (required): COVID_19 (Test Panels for SARS_CoV_2 Antigen)


... effective[x] ΣI1..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... value[x] ΣI0..1Result Value
us-core-4: SHOULD use Snomed CT for coded Results
us-core-3: SHALL use UCUM for coded quantity units.
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)

doco Documentation for this format

This structure is derived from USCoreLaboratoryResultObservationProfile

Summary

Mandatory: 3 elements
Must-Support: 11 elements

Slices

This structure defines the following Slices:

  • The element Observation.code.coding is sliced based on the value of pattern:$this

Differential View

This structure is derived from USCoreLaboratoryResultObservationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*USCoreLaboratoryResultObservationProfileMeasurements and simple assertions
... code S1..1CodeableConceptLaboratory Test Name
Binding: LOINCCodes (extensible): LOINC codes

.... coding S1..1(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:testSarsCov2NucleicAcid S0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 Nucleic Acid) (required): COVID_19 (Tests for SARS_CoV_2 Nucleic Acid)

..... coding:testPanelsSarsCov2NucleicAcid S0..1CodingCode defined by a terminology system
Binding: COVID_19 (Test Panels for SARS_CoV_2 Nucleic Acid) (required): COVID_19 (Test Panels for SARS_CoV_2 Nucleic Acid)

..... coding:testSarsCov2IgGAntibody S0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 IgG Antibody) (required): COVID_19 (Tests for SARS_CoV_2 IgG Antibody)

..... coding:testPanelsSarsCov2Antibody S0..1CodingCode defined by a terminology system
Binding: COVID_19 (Test Panels for SARS_CoV_2 Antibody) (required): COVID_19 (Test Panels for SARS_CoV_2 Antibody)

..... coding:testSarsCov2Antibody S0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 Antibody) (required): COVID_19 (Tests for SARS_CoV_2 Antibody)

..... coding:testSarsCov2Antigen S0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 Antigen) (required)
..... coding:testSarsCov2CultureIdMethod S0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 by Culture and Identification Method) (required): COVID_19 (Tests for SARS_CoV_2 by Culture and Identification Method)

..... coding:testPanelsSarsCov2Antigen S0..1CodingCode defined by a terminology system
Binding: VSAC 2.16.840.1.113762.1.4.1146.1270 (required): COVID_19 (Test Panels for SARS_CoV_2 Antigen)

... effective[x] S1..1dateTime, PeriodClinically relevant time/time-period for observation

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*USCoreLaboratoryResultObservationProfileMeasurements and simple assertions
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness 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..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category S1..*(Slice Definition)Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:Laboratory S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: laboratory
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptLaboratory Test Name
Binding: LOINCCodes (extensible): LOINC codes

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ1..1(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... coding:testSarsCov2NucleicAcid SΣ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 Nucleic Acid) (required): COVID_19 (Tests for SARS_CoV_2 Nucleic Acid)


..... coding:testPanelsSarsCov2NucleicAcid SΣ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Test Panels for SARS_CoV_2 Nucleic Acid) (required): COVID_19 (Test Panels for SARS_CoV_2 Nucleic Acid)


..... coding:testSarsCov2IgGAntibody SΣ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 IgG Antibody) (required): COVID_19 (Tests for SARS_CoV_2 IgG Antibody)


..... coding:testPanelsSarsCov2Antibody SΣ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Test Panels for SARS_CoV_2 Antibody) (required): COVID_19 (Test Panels for SARS_CoV_2 Antibody)


..... coding:testSarsCov2Antibody SΣ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 Antibody) (required): COVID_19 (Tests for SARS_CoV_2 Antibody)


..... coding:testSarsCov2Antigen SΣ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 Antigen) (required)
..... coding:testSarsCov2CultureIdMethod SΣ0..1CodingCode defined by a terminology system
Binding: COVID_19 (Tests for SARS_CoV_2 by Culture and Identification Method) (required): COVID_19 (Tests for SARS_CoV_2 by Culture and Identification Method)


..... coding:testPanelsSarsCov2Antigen SΣ0..1CodingCode defined by a terminology system
Binding: VSAC 2.16.840.1.113762.1.4.1146.1270 (required): COVID_19 (Test Panels for SARS_CoV_2 Antigen)


.... text Σ0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(US Core Patient Profile)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..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] SΣI1..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... value[x] SΣI0..1Result Value
us-core-4: SHOULD use Snomed CT for coded Results
us-core-3: SHALL use UCUM for coded quantity units.
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason SI0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)
... interpretation 0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method 0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText 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..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... value[x] Σ0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..*CodeableConceptHigh, 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

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Max Binding: AllLanguages
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:LaboratorypreferredPattern: laboratory
Observation.codeextensibleLOINCCodes
Observation.code.coding:testSarsCov2NucleicAcidrequiredCOVID_19 (Tests for SARS_CoV_2 Nucleic Acid)
Observation.code.coding:testPanelsSarsCov2NucleicAcidrequiredCOVID_19 (Test Panels for SARS_CoV_2 Nucleic Acid)
Observation.code.coding:testSarsCov2IgGAntibodyrequiredCOVID_19 (Tests for SARS_CoV_2 IgG Antibody)
Observation.code.coding:testPanelsSarsCov2AntibodyrequiredCOVID_19 (Test Panels for SARS_CoV_2 Antibody)
Observation.code.coding:testSarsCov2AntibodyrequiredCOVID_19 (Tests for SARS_CoV_2 Antibody)
Observation.code.coding:testSarsCov2AntigenrequiredCOVID_19 (Tests for SARS_CoV_2 Antigen)
Observation.code.coding:testSarsCov2CultureIdMethodrequiredCOVID_19 (Tests for SARS_CoV_2 by Culture and Identification Method)
Observation.code.coding:testPanelsSarsCov2Antigenrequiredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1146.1270
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes

Constraints

IdPathDetailsRequirements
dom-2ObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ObservationIf 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-4ObservationIf 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-5ObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ObservationA resource should have narrative for robust management
: text.`div`.exists()
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7ObservationIf 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()
us-core-2ObservationIf there is no component or hasMember element then either a value[x] or a data absent reason must be present
: (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
ele-1Observation.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.category:LaboratoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.code.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.code.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.code.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.code.coding:testSarsCov2NucleicAcidAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.code.coding:testPanelsSarsCov2NucleicAcidAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.code.coding:testSarsCov2IgGAntibodyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.code.coding:testPanelsSarsCov2AntibodyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.code.coding:testSarsCov2AntibodyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.code.coding:testSarsCov2AntigenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.code.coding:testSarsCov2CultureIdMethodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.code.coding:testPanelsSarsCov2AntigenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.code.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.focusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.effective[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
us-core-1Observation.effective[x]Datetime must be at least to day.
: ($this as dateTime).toString().length() >= 8
ele-1Observation.issuedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
us-core-4Observation.value[x]SHOULD use Snomed CT for coded Results
: valueCodeableConcept.coding.system.empty() or valueCodeableConcept.coding.system = 'http://snomed.info/sct'
us-core-3Observation.value[x]SHALL use UCUM for coded quantity units.
: valueQuantity.system.empty() or valueQuantity.system = 'http://unitsofmeasure.org'
ele-1Observation.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.bodySiteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.methodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.specimenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.deviceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRangeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
obs-3Observation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
ele-1Observation.referenceRange.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.referenceRange.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.referenceRange.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.referenceRange.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.referenceRange.lowAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.highAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.appliesToAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.ageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.referenceRange.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.hasMemberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.derivedFromAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.componentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Observation.component.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Observation.component.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.interpretationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Observation.component.referenceRangeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())