Electronic Case Reporting (eCR)
3.0.0-ballot - STU 3 Ballot United States of America flag

Electronic Case Reporting (eCR), published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions

Resource Profile: eICR Organism Susceptibility Observation

Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-organism-susceptibility-observation Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: EICROrganismSusceptibilityObservation
Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.42.89

This Observation profile is used to report organism susceptibility in eICR laboratory results. It is referenced (hasMember) from the eICR Organism Detected Observation for the organism tested and SHALL reference an eICR Organism Isolate Specimen so that the susceptibility result is self-contained: the isolate identifies what was tested and its parent identifies the clinical specimen from which the organism was isolated.

This profile is based on and further constrains the US Public Health Laboratory Result Observation profile.

Each susceptibility observation is referenced (hasMember) from the eICR Organism Detected Observation for the organism that was tested.

Population of Observation.specimen

The population of Observation.specimen follows the FHIR Diagnostics module (Microbiology) guidance:

All Observations either reference the overall Specimen or a Specimen Isolate as appropriate. The Specimen Isolate references the Specimen it was isolated from using Specimen.parent.

For organism susceptibility:

  • Observation.specimen SHALL reference the eICR Organism Isolate Specimen representing the organism that was tested (the derived isolate), not the original clinical specimen (for example, the throat swab or urine sample).
  • The isolate Specimen references the original clinical specimen it was isolated from using Specimen.parent.
  • The associated eICR Organism Detected Observation references the original clinical specimen in its Observation.specimen.

This makes each susceptibility observation self-contained: the isolate identifies what was tested, and following Specimen.parent identifies the source specimen, body site, and collection details.

Code, value, and interpretation

Observation.code is bound (extensible) to the Antimicrobial Susceptibility Test Codes value set (VSAC OID 2.16.840.1.113762.1.4.1280.3) rather than the much broader US Core laboratory test codes, so that only susceptibility tests are used.

Observation.value[x] is not constrained to a single data type. Minimum inhibitory concentration (MIC) results reported against LOINC MIC susceptibility codes may be numeric (Quantity) or textual (string); other susceptibility methods may report a coded (CodeableConcept) result.

Observation.interpretation is bound (required) to the v3 ObservationInterpretationSusceptibility value set (for example, Susceptible, Intermediate, Resistant, Non-susceptible, Susceptible-dose dependent).

See the Meropenem Susceptibility, Klebsiella oxytoca Isolate, Urine Specimen, and Organism Detected examples.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* USPublicHealthLaboratoryResultObservation eICR Organism Susceptibility Observation
Constraints: obs-6, obs-7, us-core-2
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code (USCDI+) Result Status
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.Slices for category This element must be supported. 1..* CodeableConcept (USCDI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for category.category:us-core This element must be supported. 1..1 CodeableConcept (USCDI) Classification of type of observation
Binding: US Core Clinical Result Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
      "code" : "laboratory"
    }
  ]
}
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Susceptibility Test
Binding: VSAC 2.16.840.1.113762.1.4.1280.3 (extensible)
Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Public Health Patient) (USCDI) Who and/or what the observation is about
Observation.effective[x] This element must be supported. This element is included in summaries. C 0..1 (USCDI) Clinically relevant time/time-period for observation
Constraints: us-core-1
Observation.effective[x].effectiveDateTime dateTime This target must be supported.
Observation.effective[x].effectivePeriod Period
Observation.effective[x].effectiveTiming Timing
Observation.effective[x].effectiveInstant instant
Observation.value[x] This element must be supported. This element is included in summaries. C 0..1 Susceptibility Test Result
Constraints: us-core-3, us-core-4
Observation.value[x].valueQuantity Quantity This type must be supported.
Observation.value[x].valueCodeableConcept CodeableConcept This type must be supported.
Observation.value[x].valueString string This target must be supported.
Observation.value[x].valueBoolean boolean
Observation.value[x].valueInteger integer
Observation.value[x].valueRange Range
Observation.value[x].valueRatio Ratio
Observation.value[x].valueSampledData SampledData
Observation.value[x].valueTime time
Observation.value[x].valueDateTime dateTime
Observation.value[x].valuePeriod Period
Observation.dataAbsentReason This element must be supported. C 0..1 CodeableConcept (USCDI) Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.interpretation This element must be supported. 0..* CodeableConcept Susceptibility Interpretation
Binding: ObservationInterpretationSusceptibility (3.0.0) (required)
Observation.specimen This element must be supported. 1..1 Reference(eICR Organism Isolate Specimen) Organism isolate the susceptibility test was performed on

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Clinical Result Observation Category 📦6.1.0 US Core v6.1
Observation.code Base extensible http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1280.3 Not State Unknown
Observation.dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.interpretation Base required ObservationInterpretationSusceptibility 📍3.0.0 THO v7.5

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
us-core-1 error Observation.effective[x] Datetime must be at least to day. $this is DateTime implies $this.toString().length() >= 10
us-core-2 error Observation If 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())
us-core-3 error Observation.value[x] SHALL use UCUM for coded quantity units. value.ofType(Quantity).system.empty() or value.ofType(Quantity).system = 'http://unitsofmeasure.org'
us-core-4 best practice Observation.value[x] SHOULD use Snomed CT for coded Results value.ofType(CodeableConcept).coding.system.empty() or value.ofType(CodeableConcept).coding.system = 'http://snomed.info/sct'

This structure is derived from USPublicHealthLaboratoryResultObservation

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation 0..* USPublicHealthLaboratoryResultObservation eICR Organism Susceptibility Observation
Observation.code 1..1 CodeableConcept Susceptibility Test
Binding: VSAC 2.16.840.1.113762.1.4.1280.3 (extensible)
Observation.subject 1..1 Reference(US Public Health Patient) (USCDI) Who and/or what the observation is about
Observation.value[x] 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Susceptibility Test Result
Observation.specimen 1..1 Reference(eICR Organism Isolate Specimen) Organism isolate the susceptibility test was performed on

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.code Base extensible http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1280.3 Not State Unknown
Observation.interpretation Base required ObservationInterpretationSusceptibility 📍3.0.0 THO v7.5
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* USPublicHealthLaboratoryResultObservation eICR Organism Susceptibility Observation
Constraints: obs-6, obs-7, us-core-2
Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Observation.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Observation.contained 0..* Resource Contained, inline Resources
Observation.extension 0..* Extension Additional content defined by implementations
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.identifier This element is included in summaries. 0..* Identifier Business Identifier for observation
Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code (USCDI+) Result Status
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.Slices for category This element must be supported. 1..* CodeableConcept (USCDI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for category.category:us-core This element must be supported. 1..1 CodeableConcept (USCDI) Classification of type of observation
Binding: US Core Clinical Result Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
      "code" : "laboratory"
    }
  ]
}
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Susceptibility Test
Binding: VSAC 2.16.840.1.113762.1.4.1280.3 (extensible)
Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Public Health Patient) (USCDI) Who and/or what the observation is about
Observation.focus This element is included in summaries. 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
Observation.encounter This element is included in summaries. 0..1 Reference(Encounter) Healthcare event during which this observation is made
Observation.effective[x] This element must be supported. This element is included in summaries. C 0..1 (USCDI) Clinically relevant time/time-period for observation
Constraints: us-core-1
Observation.effective[x].effectiveDateTime dateTime This target must be supported.
Observation.effective[x].effectivePeriod Period
Observation.effective[x].effectiveTiming Timing
Observation.effective[x].effectiveInstant instant
Observation.issued This element is included in summaries. 0..1 instant Date/Time this version was made available
Observation.performer This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
Observation.value[x] This element must be supported. This element is included in summaries. C 0..1 Susceptibility Test Result
Constraints: us-core-3, us-core-4
Observation.value[x].valueQuantity Quantity This type must be supported.
Observation.value[x].valueCodeableConcept CodeableConcept This type must be supported.
Observation.value[x].valueString string This target must be supported.
Observation.value[x].valueBoolean boolean
Observation.value[x].valueInteger integer
Observation.value[x].valueRange Range
Observation.value[x].valueRatio Ratio
Observation.value[x].valueSampledData SampledData
Observation.value[x].valueTime time
Observation.value[x].valueDateTime dateTime
Observation.value[x].valuePeriod Period
Observation.dataAbsentReason This element must be supported. C 0..1 CodeableConcept (USCDI) Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.interpretation This element must be supported. 0..* CodeableConcept Susceptibility Interpretation
Binding: ObservationInterpretationSusceptibility (3.0.0) (required)
Observation.note 0..* Annotation Comments about the observation
Observation.bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
Observation.method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
Observation.specimen This element must be supported. 1..1 Reference(eICR Organism Isolate Specimen) Organism isolate the susceptibility test was performed on
Observation.device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
Observation.referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
Observation.referenceRange.id 0..1 string Unique id for inter-element referencing
Observation.referenceRange.extension 0..* Extension Additional content defined by implementations
Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.referenceRange.low C 0..1 SimpleQuantity Low Range, if relevant
Constraints: sqty-1
Observation.referenceRange.high C 0..1 SimpleQuantity High Range, if relevant
Constraints: sqty-1
Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
Observation.referenceRange.text 0..1 string Text based reference range in an observation
Observation.hasMember This element is included in summaries. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
Observation.derivedFrom This element is included in summaries. 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
Observation.component This element is included in summaries. 0..* BackboneElement Component results
Observation.component.id 0..1 string Unique id for inter-element referencing
Observation.component.extension 0..* Extension Additional content defined by implementations
Observation.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.component.code This element is included in summaries. 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Observation.component.value[x] This element is included in summaries. 0..1 Actual component result
Observation.component.value[x].valueQuantity Quantity
Observation.component.value[x].valueCodeableConcept CodeableConcept
Observation.component.value[x].valueString string
Observation.component.value[x].valueBoolean boolean
Observation.component.value[x].valueInteger integer
Observation.component.value[x].valueRange Range
Observation.component.value[x].valueRatio Ratio
Observation.component.value[x].valueSampledData SampledData
Observation.component.value[x].valueTime time
Observation.component.value[x].valueDateTime dateTime
Observation.component.value[x].valuePeriod Period
Observation.component.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.component.interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.component.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Clinical Result Observation Category 📦6.1.0 US Core v6.1
Observation.code Base extensible http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1280.3 Not State Unknown
Observation.dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.interpretation Base required ObservationInterpretationSusceptibility 📍3.0.0 THO v7.5
Observation.bodySite Base example SNOMED CT Body Structures 📦4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📦4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📦4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📦4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📦4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
sqty-1 error Observation.referenceRange.low, Observation.referenceRange.high The comparator is not used on a SimpleQuantity comparator.empty()
us-core-1 error Observation.effective[x] Datetime must be at least to day. $this is DateTime implies $this.toString().length() >= 10
us-core-2 error Observation If 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())
us-core-3 error Observation.value[x] SHALL use UCUM for coded quantity units. value.ofType(Quantity).system.empty() or value.ofType(Quantity).system = 'http://unitsofmeasure.org'
us-core-4 best practice Observation.value[x] SHOULD use Snomed CT for coded Results value.ofType(CodeableConcept).coding.system.empty() or value.ofType(CodeableConcept).coding.system = 'http://snomed.info/sct'

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* USPublicHealthLaboratoryResultObservation eICR Organism Susceptibility Observation
Constraints: obs-6, obs-7, us-core-2
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code (USCDI+) Result Status
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.Slices for category This element must be supported. 1..* CodeableConcept (USCDI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for category.category:us-core This element must be supported. 1..1 CodeableConcept (USCDI) Classification of type of observation
Binding: US Core Clinical Result Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
      "code" : "laboratory"
    }
  ]
}
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Susceptibility Test
Binding: VSAC 2.16.840.1.113762.1.4.1280.3 (extensible)
Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Public Health Patient) (USCDI) Who and/or what the observation is about
Observation.effective[x] This element must be supported. This element is included in summaries. C 0..1 (USCDI) Clinically relevant time/time-period for observation
Constraints: us-core-1
Observation.effective[x].effectiveDateTime dateTime This target must be supported.
Observation.effective[x].effectivePeriod Period
Observation.effective[x].effectiveTiming Timing
Observation.effective[x].effectiveInstant instant
Observation.value[x] This element must be supported. This element is included in summaries. C 0..1 Susceptibility Test Result
Constraints: us-core-3, us-core-4
Observation.value[x].valueQuantity Quantity This type must be supported.
Observation.value[x].valueCodeableConcept CodeableConcept This type must be supported.
Observation.value[x].valueString string This target must be supported.
Observation.value[x].valueBoolean boolean
Observation.value[x].valueInteger integer
Observation.value[x].valueRange Range
Observation.value[x].valueRatio Ratio
Observation.value[x].valueSampledData SampledData
Observation.value[x].valueTime time
Observation.value[x].valueDateTime dateTime
Observation.value[x].valuePeriod Period
Observation.dataAbsentReason This element must be supported. C 0..1 CodeableConcept (USCDI) Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.interpretation This element must be supported. 0..* CodeableConcept Susceptibility Interpretation
Binding: ObservationInterpretationSusceptibility (3.0.0) (required)
Observation.specimen This element must be supported. 1..1 Reference(eICR Organism Isolate Specimen) Organism isolate the susceptibility test was performed on

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Clinical Result Observation Category 📦6.1.0 US Core v6.1
Observation.code Base extensible http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1280.3 Not State Unknown
Observation.dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.interpretation Base required ObservationInterpretationSusceptibility 📍3.0.0 THO v7.5

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
us-core-1 error Observation.effective[x] Datetime must be at least to day. $this is DateTime implies $this.toString().length() >= 10
us-core-2 error Observation If 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())
us-core-3 error Observation.value[x] SHALL use UCUM for coded quantity units. value.ofType(Quantity).system.empty() or value.ofType(Quantity).system = 'http://unitsofmeasure.org'
us-core-4 best practice Observation.value[x] SHOULD use Snomed CT for coded Results value.ofType(CodeableConcept).coding.system.empty() or value.ofType(CodeableConcept).coding.system = 'http://snomed.info/sct'

Differential View

This structure is derived from USPublicHealthLaboratoryResultObservation

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation 0..* USPublicHealthLaboratoryResultObservation eICR Organism Susceptibility Observation
Observation.code 1..1 CodeableConcept Susceptibility Test
Binding: VSAC 2.16.840.1.113762.1.4.1280.3 (extensible)
Observation.subject 1..1 Reference(US Public Health Patient) (USCDI) Who and/or what the observation is about
Observation.value[x] 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Susceptibility Test Result
Observation.interpretation This element must be supported. 0..* CodeableConcept Susceptibility Interpretation
Binding: ObservationInterpretationSusceptibility (3.0.0) (required)
Observation.specimen 1..1 Reference(eICR Organism Isolate Specimen) Organism isolate the susceptibility test was performed on

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.code Base extensible http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1280.3 Not State Unknown
Observation.interpretation Base required ObservationInterpretationSusceptibility 📍3.0.0 THO v7.5

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Observation C 0..* USPublicHealthLaboratoryResultObservation eICR Organism Susceptibility Observation
Constraints: obs-6, obs-7, us-core-2
Observation.id This element is included in summaries. 0..1 id Logical id of this artifact
Observation.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Observation.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Observation.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Observation.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Observation.contained 0..* Resource Contained, inline Resources
Observation.extension 0..* Extension Additional content defined by implementations
Observation.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Observation.identifier This element is included in summaries. 0..* Identifier Business Identifier for observation
Observation.basedOn This element is included in summaries. 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
Observation.partOf This element is included in summaries. 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
Observation.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code (USCDI+) Result Status
Binding: ObservationStatus (required): Codes providing the status of an observation.
Observation.Slices for category This element must be supported. 1..* CodeableConcept (USCDI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Observation.Slices for category.category:us-core This element must be supported. 1..1 CodeableConcept (USCDI) Classification of type of observation
Binding: US Core Clinical Result Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
      "code" : "laboratory"
    }
  ]
}
Observation.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Susceptibility Test
Binding: VSAC 2.16.840.1.113762.1.4.1280.3 (extensible)
Observation.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Public Health Patient) (USCDI) Who and/or what the observation is about
Observation.focus This element is included in summaries. 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
Observation.encounter This element is included in summaries. 0..1 Reference(Encounter) Healthcare event during which this observation is made
Observation.effective[x] This element must be supported. This element is included in summaries. C 0..1 (USCDI) Clinically relevant time/time-period for observation
Constraints: us-core-1
Observation.effective[x].effectiveDateTime dateTime This target must be supported.
Observation.effective[x].effectivePeriod Period
Observation.effective[x].effectiveTiming Timing
Observation.effective[x].effectiveInstant instant
Observation.issued This element is included in summaries. 0..1 instant Date/Time this version was made available
Observation.performer This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who is responsible for the observation
Observation.value[x] This element must be supported. This element is included in summaries. C 0..1 Susceptibility Test Result
Constraints: us-core-3, us-core-4
Observation.value[x].valueQuantity Quantity This type must be supported.
Observation.value[x].valueCodeableConcept CodeableConcept This type must be supported.
Observation.value[x].valueString string This target must be supported.
Observation.value[x].valueBoolean boolean
Observation.value[x].valueInteger integer
Observation.value[x].valueRange Range
Observation.value[x].valueRatio Ratio
Observation.value[x].valueSampledData SampledData
Observation.value[x].valueTime time
Observation.value[x].valueDateTime dateTime
Observation.value[x].valuePeriod Period
Observation.dataAbsentReason This element must be supported. C 0..1 CodeableConcept (USCDI) Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.interpretation This element must be supported. 0..* CodeableConcept Susceptibility Interpretation
Binding: ObservationInterpretationSusceptibility (3.0.0) (required)
Observation.note 0..* Annotation Comments about the observation
Observation.bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
Observation.method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
Observation.specimen This element must be supported. 1..1 Reference(eICR Organism Isolate Specimen) Organism isolate the susceptibility test was performed on
Observation.device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
Observation.referenceRange C 0..* BackboneElement Provides guide for interpretation
Constraints: obs-3
Observation.referenceRange.id 0..1 string Unique id for inter-element referencing
Observation.referenceRange.extension 0..* Extension Additional content defined by implementations
Observation.referenceRange.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.referenceRange.low C 0..1 SimpleQuantity Low Range, if relevant
Constraints: sqty-1
Observation.referenceRange.high C 0..1 SimpleQuantity High Range, if relevant
Constraints: sqty-1
Observation.referenceRange.type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
Observation.referenceRange.appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
Observation.referenceRange.age 0..1 Range Applicable age range, if relevant
Observation.referenceRange.text 0..1 string Text based reference range in an observation
Observation.hasMember This element is included in summaries. 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
Observation.derivedFrom This element is included in summaries. 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
Observation.component This element is included in summaries. 0..* BackboneElement Component results
Observation.component.id 0..1 string Unique id for inter-element referencing
Observation.component.extension 0..* Extension Additional content defined by implementations
Observation.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Observation.component.code This element is included in summaries. 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
Observation.component.value[x] This element is included in summaries. 0..1 Actual component result
Observation.component.value[x].valueQuantity Quantity
Observation.component.value[x].valueCodeableConcept CodeableConcept
Observation.component.value[x].valueString string
Observation.component.value[x].valueBoolean boolean
Observation.component.value[x].valueInteger integer
Observation.component.value[x].valueRange Range
Observation.component.value[x].valueRatio Ratio
Observation.component.value[x].valueSampledData SampledData
Observation.component.value[x].valueTime time
Observation.component.value[x].valueDateTime dateTime
Observation.component.value[x].valuePeriod Period
Observation.component.dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
Observation.component.interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
Observation.component.referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Clinical Result Observation Category 📦6.1.0 US Core v6.1
Observation.code Base extensible http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1280.3 Not State Unknown
Observation.dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.interpretation Base required ObservationInterpretationSusceptibility 📍3.0.0 THO v7.5
Observation.bodySite Base example SNOMED CT Body Structures 📦4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📦4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📦4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📦4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📦4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
sqty-1 error Observation.referenceRange.low, Observation.referenceRange.high The comparator is not used on a SimpleQuantity comparator.empty()
us-core-1 error Observation.effective[x] Datetime must be at least to day. $this is DateTime implies $this.toString().length() >= 10
us-core-2 error Observation If 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())
us-core-3 error Observation.value[x] SHALL use UCUM for coded quantity units. value.ofType(Quantity).system.empty() or value.ofType(Quantity).system = 'http://unitsofmeasure.org'
us-core-4 best practice Observation.value[x] SHOULD use Snomed CT for coded Results value.ofType(CodeableConcept).coding.system.empty() or value.ofType(CodeableConcept).coding.system = 'http://snomed.info/sct'

 

Other representations of profile: CSV, Excel, Schematron