LabObservation

Introduction

Formal url http://devdays-example-ig.com/fhir/StructureDefinition/DevDaysIGtutorial-Observation
Version 1.0.0
Published by Example, someone@somewhere.org
Status active (since 2019-06-08)

This Structure Definition defines the required elements and constraints on the Observation resource. DevDaysIGtutorial-Observation refers to this StructureDefinition. Example text....

StructureDefinition LabObservation

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
basedOnΣ I0..0Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)
partOfΣ I0..1Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)
statusS Σ ?!1..1codeBinding
category0..*CodeableConceptBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
subjectS Σ I1..1Reference(DevDaysIGtutorial-Patient)
focusΣ I0..*Reference(Resource)
encounterΣ I0..1Reference(Encounter)
effectivePeriodPeriod
effectiveTimingTiming
effectiveInstantinstant
effectiveDateTimeS Σ1..1dateTime
issuedΣ0..1instant
performerΣ I0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)
valueCodeableConceptCodeableConcept
valueStringstring
valueBooleanboolean
valueIntegerinteger
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueTimetime
valueDateTimedateTime
valuePeriodPeriod
id0..1string
extensionI0..*Extension
valueS Σ1..1decimal
comparatorΣ ?!0..1codeBinding
unitS Σ1..1string
systemS Σ I1..1uriFixed Value
codeS Σ1..1code
dataAbsentReasonS I0..1CodeableConceptBinding
interpretation0..*CodeableConceptBinding
note0..*Annotation
bodySite0..0CodeableConcept
id0..1string
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueContributorContributor
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueDosageDosage
valueMetaMeta
valueReferenceReference()
methodQualifier1..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
specimenI0..1Reference(Specimen)
deviceI0..0Reference(Device | DeviceMetric)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
lowI0..1SimpleQuantity
highI0..1SimpleQuantity
type0..1CodeableConceptBinding
appliesTo0..*CodeableConcept
ageI0..1Range
text0..1string
hasMemberΣ I0..0Reference(Observation | QuestionnaireResponse | MolecularSequence)
derivedFromΣ I0..0Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)

Valid example

Valid: Hemoglobin [Mass/volume] in Blood

<Observation xmlns="http://hl7.org/fhir">
    <id value="example-valid-labobservation-01" />
    <meta>
        <profile value="http://devdays-example-ig.com/fhir/StructureDefinition/DevDaysIGtutorial-Observation" />
    </meta>
    <identifier>
        <system value="https://devdays-example-ig.com/NamingSystem/labObservarionIdentifier" />
        <value value="0a7c96cc-58ee-41da-8c56-f03dc8df3de1" />
    </identifier>
    <status value="final" />
    <code>
        <coding>
            <system value="http://loinc.org" />
            <code value="718-7" />
            <display value="Hemoglobin [Mass/volume] in Blood" />
        </coding>
    </code>
    <subject>
        <reference value="Patient/example-valid-labpatient-01" />
        <display value="Mr. Pietje Puk" />
    </subject>
    <effectiveDateTime value="2019-05-23T12:00:00+02:00" />
    <issued value="2019-05-24T10:00:00+02:00" />
    <valueQuantity>
        <value value="7.2" />
        <unit value="g/dl" />
        <system value="http://unitsofmeasure.org" />
        <code value="g/dL" />
    </valueQuantity>
    <interpretation>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation" />
            <code value="L" />
            <display value="Low" />
        </coding>
    </interpretation>
    <method>
        <extension url="http://devdays-example-ig.com/fhir/StructureDefinition/DevDaysIGtutorial-observation-method-qualifier">
            <valueCodeableConcept>
                <coding>
                    <system value="http://example-Tx.org" />
                    <code value="QualifierCode01" />
                    <display value="Method Qualifier code 01" />
                </coding>
            </valueCodeableConcept>
        </extension>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="9564003" />
            <display value="Complete blood count with white cell differential, automated" />
        </coding>
    </method>
    <referenceRange>
        <low>
            <value value="7.5" />
            <unit value="g/dl" />
            <system value="http://unitsofmeasure.org" />
            <code value="g/dL" />
        </low>
        <high>
            <value value="10" />
            <unit value="g/dl" />
            <system value="http://unitsofmeasure.org" />
            <code value="g/dL" />
        </high>
    </referenceRange>
</Observation>
{
    "resourceType": "Observation",
    "id": "example-valid-labobservation-01",
    "meta": {
        "profile":  [
            "http://devdays-example-ig.com/fhir/StructureDefinition/DevDaysIGtutorial-Observation"
        ]
    },
    "identifier":  [
        {
            "system": "https://devdays-example-ig.com/NamingSystem/labObservarionIdentifier",
            "value": "0a7c96cc-58ee-41da-8c56-f03dc8df3de1"
        }
    ],
    "status": "final",
    "code": {
        "coding":  [
            {
                "system": "http://loinc.org",
                "code": "718-7",
                "display": "Hemoglobin [Mass/volume] in Blood"
            }
        ]
    },
    "subject": {
        "reference": "Patient/example-valid-labpatient-01",
        "display": "Mr. Pietje Puk"
    },
    "effectiveDateTime": "2019-05-23T12:00:00+02:00",
    "issued": "2019-05-24T10:00:00+02:00",
    "valueQuantity": {
        "value": 7.2,
        "unit": "g/dl",
        "system": "http://unitsofmeasure.org",
        "code": "g/dL"
    },
    "interpretation":  [
        {
            "coding":  [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                    "code": "L",
                    "display": "Low"
                }
            ]
        }
    ],
    "method": {
        "extension":  [
            {
                "url": "http://devdays-example-ig.com/fhir/StructureDefinition/DevDaysIGtutorial-observation-method-qualifier",
                "valueCodeableConcept": {
                    "coding":  [
                        {
                            "system": "http://example-Tx.org",
                            "code": "QualifierCode01",
                            "display": "Method Qualifier code 01"
                        }
                    ]
                }
            }
        ],
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "9564003",
                "display": "Complete blood count with white cell differential, automated"
            }
        ]
    },
    "referenceRange":  [
        {
            "low": {
                "value": 7.5,
                "unit": "g/dl",
                "system": "http://unitsofmeasure.org",
                "code": "g/dL"
            },
            "high": {
                "value": 10,
                "unit": "g/dl",
                "system": "http://unitsofmeasure.org",
                "code": "g/dL"
            }
        }
    ]
}

Invalid example

Invalid: Hemoglobin [Mass/volume] in Blood

<Observation xmlns="http://hl7.org/fhir">
    <id value="example-invalid-labobservation-01" />
    <meta>
        <profile value="http://devdays-example-ig.com/fhir/StructureDefinition/DevDaysIGtutorial-Observation" />
    </meta>
    <identifier>
        <system value="https://devdays-example-ig.com/NamingSystem/labObservarionIdentifier" />
        <value value="0a7c96cc-58ee-41da-8c56-f03dc8df3de1" />
    </identifier>
    <status value="final" />
    <code>
        <coding>
            <!--  wrong system - should be loinc  -->
            <system value="http://snomed.sct" />
            <code value="718-7" />
            <display value="Hemoglobin [Mass/volume] in Blood" />
        </coding>
    </code>
    <subject>
        <reference value="Patient/example-valid-labpatient-01" />
        <display value="Mr. Pietje Puk" />
    </subject>
    <!--  wrong datatype, should be effectiveDateTime  -->
    <effectivePeriod>
        <start value="2019-05-23T12:00:00+02:00" />
    </effectivePeriod>
    <valueQuantity>
        <value value="7.2" />
        <unit value="g/dl" />
        <system value="http://unitsofmeasure.org" />
        <code value="g/dL" />
    </valueQuantity>
    <interpretation>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation" />
            <code value="L" />
            <display value="Low" />
        </coding>
    </interpretation>
    <method>
        <extension url="http://devdays-example-ig.com/fhir/StructureDefinition/DevDaysIGtutorial-observation-method-qualifier">
            <valueCodeableConcept>
                <coding>
                    <system value="http://example-Tx.org" />
                    <!--  incorrect code should be QualifierCode01    -->
                    <code value="Code01" />
                    <display value="Method Qualifier code 01" />
                </coding>
            </valueCodeableConcept>
        </extension>
        <extension url="http://devdays-example-ig.com/fhir/StructureDefinition/DevDaysIGtutorial-observation-method-qualifier">
            <valueCodeableConcept>
                <coding>
                    <system value="http://example-Tx.org" />
                    <!--  incorrect code should be QualifierCode01    -->
                    <code value="Code01" />
                    <display value="Method Qualifier code 01" />
                </coding>
            </valueCodeableConcept>
        </extension>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="9564003" />
            <display value="Complete blood count with white cell differential, automated" />
        </coding>
    </method>
    <referenceRange>
        <low>
            <value value="7.5" />
            <unit value="g/dl" />
            <system value="http://unitsofmeasure.org" />
            <code value="g/dL" />
        </low>
        <high>
            <value value="10" />
            <unit value="g/dl" />
            <system value="http://unitsofmeasure.org" />
            <code value="g/dL" />
        </high>
    </referenceRange>
</Observation>
{
    "resourceType": "Observation",
    "id": "example-invalid-labobservation-01",
    "meta": {
        "profile":  [
            "http://devdays-example-ig.com/fhir/StructureDefinition/DevDaysIGtutorial-Observation"
        ]
    },
    "identifier":  [
        {
            "system": "https://devdays-example-ig.com/NamingSystem/labObservarionIdentifier",
            "value": "0a7c96cc-58ee-41da-8c56-f03dc8df3de1"
        }
    ],
    "status": "final",
    "code": {
        "coding":  [
            {
                "system": "http://snomed.sct",
                "code": "718-7",
                "display": "Hemoglobin [Mass/volume] in Blood"
            }
        ]
    },
    "subject": {
        "reference": "Patient/example-valid-labpatient-01",
        "display": "Mr. Pietje Puk"
    },
    "effectivePeriod": {
        "start": "2019-05-23T12:00:00+02:00"
    },
    "valueQuantity": {
        "value": 7.2,
        "unit": "g/dl",
        "system": "http://unitsofmeasure.org",
        "code": "g/dL"
    },
    "interpretation":  [
        {
            "coding":  [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                    "code": "L",
                    "display": "Low"
                }
            ]
        }
    ],
    "method": {
        "extension":  [
            {
                "url": "http://devdays-example-ig.com/fhir/StructureDefinition/DevDaysIGtutorial-observation-method-qualifier",
                "valueCodeableConcept": {
                    "coding":  [
                        {
                            "system": "http://example-Tx.org",
                            "code": "Code01",
                            "display": "Method Qualifier code 01"
                        }
                    ]
                }
            },
            {
                "url": "http://devdays-example-ig.com/fhir/StructureDefinition/DevDaysIGtutorial-observation-method-qualifier",
                "valueCodeableConcept": {
                    "coding":  [
                        {
                            "system": "http://example-Tx.org",
                            "code": "Code01",
                            "display": "Method Qualifier code 01"
                        }
                    ]
                }
            }
        ],
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "9564003",
                "display": "Complete blood count with white cell differential, automated"
            }
        ]
    },
    "referenceRange":  [
        {
            "low": {
                "value": 7.5,
                "unit": "g/dl",
                "system": "http://unitsofmeasure.org",
                "code": "g/dL"
            },
            "high": {
                "value": 10,
                "unit": "g/dl",
                "system": "http://unitsofmeasure.org",
                "code": "g/dL"
            }
        }
    ]
}

nl-core-patient

preferredPharmacy..1Extension
valueCodeableConceptBinding
valuePeriod
system1..
code1..
valueCodeableConcept
system1..Fixed Value
value1..
active
valueCode
telecomhttp://fhir.nl/fhir/StructureDefinition/nl-core-contactpoint
valueCodeableConceptBinding
birthDate
deceased[x]
addresshttp://fhir.nl/fhir/StructureDefinition/nl-core-address
maritalStatusBinding
multipleBirth[x]
relationshipBinding
roleBinding
valueCode
telecomhttp://fhir.nl/fhir/StructureDefinition/nl-core-contactpoint
addresshttp://fhir.nl/fhir/StructureDefinition/nl-core-address
valueCodingBinding
valueCodingBinding
commentExtension
language
practitionerRole..1Extension