Laboratory Base Class FHIR Profiles
0.1 - Draft United States of America flag

Laboratory Base Class FHIR Profiles, published by HL7 International - Clinical Information Modeling Initiative. This is not an authorized publication; it is the continuous build for version 0.1). This version is based on the current content of https://github.com/HL7/cimi-labs/ and changes regularly. See the Directory of published versions

Resource Profile: Standard Laboratory Observation Base profile ( Abstract )

Official URL: http://hl7.org/fhir/us/cimi-labs/StructureDefinition/standard-lab-obs Version: 0.1
Draft as of 2023-08-02 Computable Name: StandardLabObs

Copyright/Legal: Graphite Health, all rights reserved Creative Commons License

An abstract base profile on which other sub-types will be built.

Scope

The Standard Lab Observation profile is an abstract base profile used to inform its subtypes. This profile contains all of the common extensions and constraints that apply to all of the specfic subtypes, coded, narrative, ordinal, quantitative, and titer.

A word about document type of lab tests

There are many LOINC codes that describe lab tests who’s results or values are reported within an attached document. These tests will not use a profile derived from this base. This is due to the fact that the Observation resource does not allow the attachement data type within the value element. These tests will use a profile of teh DiagnosticReport resource, further explained on that page.

Observation.code

This element is not constrained in this profile but is consstrained by its subtypes.

Observaiton.value

This will also be constrained by the subtypes.

Example

Since this is an abstract base type and not inted for instantiating data, there is no example for this.

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreLaboratoryResultObservationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*USCoreLaboratoryResultObservationProfileThis is an abstract profile. Child profiles: Observation, Observation, Observation, Observation, Observation, Observation
Measurements and simple assertions
... Slices for identifier S0..*IdentifierBusiness Identifier for observation
Slice: Unordered, Open by pattern:type
.... identifier:accessionIdentifier 0..1IdentifierBusiness Identifier for observation
..... type 1..1CodeableConceptDescription of identifier
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/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ACSN
.... identifier:fillerOrderNumber 0..1IdentifierBusiness Identifier for observation
..... type 1..1CodeableConceptDescription of identifier
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/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
.... identifier:placerOrderNumber 0..1IdentifierBusiness Identifier for observation
..... type 1..1CodeableConceptDescription of identifier
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/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
... Slices for performer S0..*Reference(Practitioner | Organization)Who is responsible for the observation
Slice: Unordered, Open by exists:Observation.performer
.... performer:responsibleObserver 0..1Reference(Practitioner)Who is responsible for the observation
.... performer:performingLaboratory 0..1Reference(Organization)Who is responsible for the observation
.... performer:performingOrganizationMedicalDirector 0..1Reference(Practitioner)Who is responsible for the observation
... dataAbsentReason 0..1CodeableConceptWhy the result is missing
Binding: Null Flavor value set (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.dataAbsentReasonextensibleNullFlavor_VSET
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*USCoreLaboratoryResultObservationProfileThis is an abstract profile. Child profiles: Observation, Observation, Observation, Observation, Observation, Observation
Measurements and simple assertions
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierBusiness Identifier for observation
Slice: Unordered, Open by pattern:type
.... identifier:accessionIdentifier Σ0..1IdentifierBusiness Identifier for observation
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ACSN
.... identifier:fillerOrderNumber Σ0..1IdentifierBusiness Identifier for observation
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
.... identifier:placerOrderNumber Σ0..1IdentifierBusiness Identifier for observation
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
... Slices for category S1..*CodeableConceptClassification 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
..... 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 SΣ1..1CodeableConceptLaboratory Test Name
Binding: LOINCCodes (extensible): LOINC codes

... subject SΣ1..1Reference(US Core Patient Profile)Who and/or what the observation is about
... effective[x] SΣC0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... Slices for performer SΣ0..*Reference(Practitioner | Organization)Who is responsible for the observation
Slice: Unordered, Open by exists:Observation.performer
.... performer:responsibleObserver Σ0..1Reference(Practitioner)Who is responsible for the observation
.... performer:performingLaboratory Σ0..1Reference(Organization)Who is responsible for the observation
.... performer:performingOrganizationMedicalDirector Σ0..1Reference(Practitioner)Who is responsible for the observation
... value[x] SΣC0..1Result Value
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: Null Flavor value set (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.identifier:accessionIdentifier.userequiredIdentifierUse
Observation.identifier:accessionIdentifier.typeextensiblePattern: ACSN
Observation.identifier:fillerOrderNumber.userequiredIdentifierUse
Observation.identifier:fillerOrderNumber.typeextensiblePattern: FILL
Observation.identifier:placerOrderNumber.userequiredIdentifierUse
Observation.identifier:placerOrderNumber.typeextensiblePattern: PLAC
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:LaboratorypreferredPattern: laboratory
Observation.codeextensibleLOINCCodes (a valid code from LOINC)
Observation.dataAbsentReasonextensibleNullFlavor_VSET
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*USCoreLaboratoryResultObservationProfileThis is an abstract profile. Child profiles: Observation, Observation, Observation, Observation, Observation, Observation
Measurements and simple assertions
... id Σ0..1idLogical 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): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... 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
... Slices for identifier SΣ0..*IdentifierBusiness Identifier for observation
Slice: Unordered, Open by pattern:type
.... identifier:accessionIdentifier Σ0..1IdentifierBusiness Identifier for observation
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ACSN
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:fillerOrderNumber Σ0..1IdentifierBusiness Identifier for observation
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:placerOrderNumber Σ0..1IdentifierBusiness Identifier for observation
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... 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)
... Slices for category S1..*CodeableConceptClassification 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

... subject SΣ1..1Reference(US Core Patient Profile)Who and/or what the observation is about
... focus ΣTU0..*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ΣC0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDate/Time this version was made available
... Slices for performer SΣ0..*Reference(Practitioner | Organization)Who is responsible for the observation
Slice: Unordered, Open by exists:Observation.performer
.... performer:responsibleObserver Σ0..1Reference(Practitioner)Who is responsible for the observation
.... performer:performingLaboratory Σ0..1Reference(Organization)Who is responsible for the observation
.... performer:performingOrganizationMedicalDirector Σ0..1Reference(Practitioner)Who is responsible for the observation
... value[x] SΣC0..1Result Value
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: Null Flavor value set (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 C0..*BackboneElementProvides guide for interpretation
.... 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 C0..1SimpleQuantityLow Range, if relevant
.... high C0..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 C0..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

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.identifier:accessionIdentifier.userequiredIdentifierUse
Observation.identifier:accessionIdentifier.typeextensiblePattern: ACSN
Observation.identifier:fillerOrderNumber.userequiredIdentifierUse
Observation.identifier:fillerOrderNumber.typeextensiblePattern: FILL
Observation.identifier:placerOrderNumber.userequiredIdentifierUse
Observation.identifier:placerOrderNumber.typeextensiblePattern: PLAC
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:LaboratorypreferredPattern: laboratory
Observation.codeextensibleLOINCCodes (a valid code from LOINC)
Observation.dataAbsentReasonextensibleNullFlavor_VSET
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes

This structure is derived from USCoreLaboratoryResultObservationProfile

Summary

Mandatory: 0 element (3 nested mandatory elements)
Must-Support: 2 elements

Slices

This structure defines the following Slices:

  • The element Observation.identifier is sliced based on the value of pattern:type
  • The element Observation.performer is sliced based on the value of exists:Observation.performer

Differential View

This structure is derived from USCoreLaboratoryResultObservationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*USCoreLaboratoryResultObservationProfileThis is an abstract profile. Child profiles: Observation, Observation, Observation, Observation, Observation, Observation
Measurements and simple assertions
... Slices for identifier S0..*IdentifierBusiness Identifier for observation
Slice: Unordered, Open by pattern:type
.... identifier:accessionIdentifier 0..1IdentifierBusiness Identifier for observation
..... type 1..1CodeableConceptDescription of identifier
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/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ACSN
.... identifier:fillerOrderNumber 0..1IdentifierBusiness Identifier for observation
..... type 1..1CodeableConceptDescription of identifier
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/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
.... identifier:placerOrderNumber 0..1IdentifierBusiness Identifier for observation
..... type 1..1CodeableConceptDescription of identifier
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/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
... Slices for performer S0..*Reference(Practitioner | Organization)Who is responsible for the observation
Slice: Unordered, Open by exists:Observation.performer
.... performer:responsibleObserver 0..1Reference(Practitioner)Who is responsible for the observation
.... performer:performingLaboratory 0..1Reference(Organization)Who is responsible for the observation
.... performer:performingOrganizationMedicalDirector 0..1Reference(Practitioner)Who is responsible for the observation
... dataAbsentReason 0..1CodeableConceptWhy the result is missing
Binding: Null Flavor value set (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.dataAbsentReasonextensibleNullFlavor_VSET

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*USCoreLaboratoryResultObservationProfileThis is an abstract profile. Child profiles: Observation, Observation, Observation, Observation, Observation, Observation
Measurements and simple assertions
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ0..*IdentifierBusiness Identifier for observation
Slice: Unordered, Open by pattern:type
.... identifier:accessionIdentifier Σ0..1IdentifierBusiness Identifier for observation
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ACSN
.... identifier:fillerOrderNumber Σ0..1IdentifierBusiness Identifier for observation
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
.... identifier:placerOrderNumber Σ0..1IdentifierBusiness Identifier for observation
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
... Slices for category S1..*CodeableConceptClassification 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
..... 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 SΣ1..1CodeableConceptLaboratory Test Name
Binding: LOINCCodes (extensible): LOINC codes

... subject SΣ1..1Reference(US Core Patient Profile)Who and/or what the observation is about
... effective[x] SΣC0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... Slices for performer SΣ0..*Reference(Practitioner | Organization)Who is responsible for the observation
Slice: Unordered, Open by exists:Observation.performer
.... performer:responsibleObserver Σ0..1Reference(Practitioner)Who is responsible for the observation
.... performer:performingLaboratory Σ0..1Reference(Organization)Who is responsible for the observation
.... performer:performingOrganizationMedicalDirector Σ0..1Reference(Practitioner)Who is responsible for the observation
... value[x] SΣC0..1Result Value
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: Null Flavor value set (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.identifier:accessionIdentifier.userequiredIdentifierUse
Observation.identifier:accessionIdentifier.typeextensiblePattern: ACSN
Observation.identifier:fillerOrderNumber.userequiredIdentifierUse
Observation.identifier:fillerOrderNumber.typeextensiblePattern: FILL
Observation.identifier:placerOrderNumber.userequiredIdentifierUse
Observation.identifier:placerOrderNumber.typeextensiblePattern: PLAC
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:LaboratorypreferredPattern: laboratory
Observation.codeextensibleLOINCCodes (a valid code from LOINC)
Observation.dataAbsentReasonextensibleNullFlavor_VSET

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*USCoreLaboratoryResultObservationProfileThis is an abstract profile. Child profiles: Observation, Observation, Observation, Observation, Observation, Observation
Measurements and simple assertions
... id Σ0..1idLogical 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): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... 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
... Slices for identifier SΣ0..*IdentifierBusiness Identifier for observation
Slice: Unordered, Open by pattern:type
.... identifier:accessionIdentifier Σ0..1IdentifierBusiness Identifier for observation
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: ACSN
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:fillerOrderNumber Σ0..1IdentifierBusiness Identifier for observation
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:placerOrderNumber Σ0..1IdentifierBusiness Identifier for observation
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


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/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... 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)
... Slices for category S1..*CodeableConceptClassification 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

... subject SΣ1..1Reference(US Core Patient Profile)Who and/or what the observation is about
... focus ΣTU0..*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ΣC0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDate/Time this version was made available
... Slices for performer SΣ0..*Reference(Practitioner | Organization)Who is responsible for the observation
Slice: Unordered, Open by exists:Observation.performer
.... performer:responsibleObserver Σ0..1Reference(Practitioner)Who is responsible for the observation
.... performer:performingLaboratory Σ0..1Reference(Organization)Who is responsible for the observation
.... performer:performingOrganizationMedicalDirector Σ0..1Reference(Practitioner)Who is responsible for the observation
... value[x] SΣC0..1Result Value
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason SC0..1CodeableConceptWhy the result is missing
Binding: Null Flavor value set (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 C0..*BackboneElementProvides guide for interpretation
.... 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 C0..1SimpleQuantityLow Range, if relevant
.... high C0..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 C0..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

Terminology Bindings

PathConformanceValueSet / Code
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.identifier:accessionIdentifier.userequiredIdentifierUse
Observation.identifier:accessionIdentifier.typeextensiblePattern: ACSN
Observation.identifier:fillerOrderNumber.userequiredIdentifierUse
Observation.identifier:fillerOrderNumber.typeextensiblePattern: FILL
Observation.identifier:placerOrderNumber.userequiredIdentifierUse
Observation.identifier:placerOrderNumber.typeextensiblePattern: PLAC
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:LaboratorypreferredPattern: laboratory
Observation.codeextensibleLOINCCodes (a valid code from LOINC)
Observation.dataAbsentReasonextensibleNullFlavor_VSET
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.dataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationextensibleObservationInterpretationCodes

This structure is derived from USCoreLaboratoryResultObservationProfile

Summary

Mandatory: 0 element (3 nested mandatory elements)
Must-Support: 2 elements

Slices

This structure defines the following Slices:

  • The element Observation.identifier is sliced based on the value of pattern:type
  • The element Observation.performer is sliced based on the value of exists:Observation.performer

 

Other representations of profile: CSV, Excel, Schematron