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
| 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.
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:
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.
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
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | USPublicHealthLaboratoryResultObservation | eICR Organism Susceptibility Observation Constraints: obs-6, obs-7, us-core-2 |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..1 | code | (USCDI+) Result Status Binding: ObservationStatus (required): Codes providing the status of an observation. | |
![]() ![]() |
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 | |
![]() ![]() ![]() |
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: | |
![]() ![]() |
1..1 | CodeableConcept | Susceptibility Test Binding: VSAC 2.16.840.1.113762.1.4.1280.3 (extensible) | |
![]() ![]() |
1..1 | Reference(US Public Health Patient) | (USCDI) Who and/or what the observation is about | |
![]() ![]() |
C | 0..1 | (USCDI) Clinically relevant time/time-period for observation Constraints: us-core-1 | |
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
Timing | |||
![]() ![]() ![]() |
instant | |||
![]() ![]() |
C | 0..1 | Susceptibility Test Result Constraints: us-core-3, us-core-4 | |
![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
string | |||
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() |
SampledData | |||
![]() ![]() ![]() |
time | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() |
C | 0..1 | CodeableConcept | (USCDI) Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() |
0..* | CodeableConcept | Susceptibility Interpretation Binding: ObservationInterpretationSusceptibility (3.0.0) (required) | |
![]() ![]() |
1..1 | Reference(eICR Organism Isolate Specimen) | Organism isolate the susceptibility test was performed on | |
Documentation for this format | ||||
| 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 |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | USPublicHealthLaboratoryResultObservation | eICR Organism Susceptibility Observation | |
![]() ![]() |
1..1 | CodeableConcept | Susceptibility Test Binding: VSAC 2.16.840.1.113762.1.4.1280.3 (extensible) | |
![]() ![]() |
1..1 | Reference(US Public Health Patient) | (USCDI) Who and/or what the observation is about | |
![]() ![]() |
0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Susceptibility Test Result | |
![]() ![]() |
0..* | CodeableConcept | Susceptibility Interpretation Binding: ObservationInterpretationSusceptibility (3.0.0) (required) | |
![]() ![]() |
1..1 | Reference(eICR Organism Isolate Specimen) | Organism isolate the susceptibility test was performed on | |
Documentation for this format | ||||
| 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 |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | USPublicHealthLaboratoryResultObservation | eICR Organism Susceptibility Observation Constraints: obs-6, obs-7, us-core-2 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | Business Identifier for observation | |||||
![]() ![]() |
0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | |||||
![]() ![]() |
0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | |||||
![]() ![]() |
1..1 | code | (USCDI+) Result Status Binding: ObservationStatus (required): Codes providing the status of an observation. | |||||
![]() ![]() |
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 | |||||
![]() ![]() ![]() |
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: | |||||
![]() ![]() |
1..1 | CodeableConcept | Susceptibility Test Binding: VSAC 2.16.840.1.113762.1.4.1280.3 (extensible) | |||||
![]() ![]() |
1..1 | Reference(US Public Health Patient) | (USCDI) Who and/or what the observation is about | |||||
![]() ![]() |
0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | |||||
![]() ![]() |
0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |||||
![]() ![]() |
C | 0..1 | (USCDI) Clinically relevant time/time-period for observation Constraints: us-core-1 | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() |
instant | |||||||
![]() ![]() |
0..1 | instant | Date/Time this version was made available | |||||
![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | |||||
![]() ![]() |
C | 0..1 | Susceptibility Test Result Constraints: us-core-3, us-core-4 | |||||
![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() |
SampledData | |||||||
![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
C | 0..1 | CodeableConcept | (USCDI) Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
![]() ![]() |
0..* | CodeableConcept | Susceptibility Interpretation Binding: ObservationInterpretationSusceptibility (3.0.0) (required) | |||||
![]() ![]() |
0..* | Annotation | Comments about the observation | |||||
![]() ![]() |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
![]() ![]() |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
![]() ![]() |
1..1 | Reference(eICR Organism Isolate Specimen) | Organism isolate the susceptibility test was performed on | |||||
![]() ![]() |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
![]() ![]() |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | Low Range, if relevant Constraints: sqty-1 | ||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | High Range, if relevant Constraints: sqty-1 | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
![]() ![]() ![]() |
0..1 | Range | Applicable age range, if relevant | |||||
![]() ![]() ![]() |
0..1 | string | Text based reference range in an observation | |||||
![]() ![]() |
0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | |||||
![]() ![]() |
0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | |||||
![]() ![]() |
0..* | BackboneElement | Component results | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | |||||
![]() ![]() ![]() |
0..1 | Actual component result | ||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() |
SampledData | |||||||
![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
![]() ![]() ![]() |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
Documentation for this format | ||||||||
| 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'
|
This structure is derived from USPublicHealthLaboratoryResultObservation
Summary
Mandatory: 1 element
Must-Support: 1 element
Structures
This structure refers to these other structures:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | USPublicHealthLaboratoryResultObservation | eICR Organism Susceptibility Observation Constraints: obs-6, obs-7, us-core-2 |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..1 | code | (USCDI+) Result Status Binding: ObservationStatus (required): Codes providing the status of an observation. | |
![]() ![]() |
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 | |
![]() ![]() ![]() |
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: | |
![]() ![]() |
1..1 | CodeableConcept | Susceptibility Test Binding: VSAC 2.16.840.1.113762.1.4.1280.3 (extensible) | |
![]() ![]() |
1..1 | Reference(US Public Health Patient) | (USCDI) Who and/or what the observation is about | |
![]() ![]() |
C | 0..1 | (USCDI) Clinically relevant time/time-period for observation Constraints: us-core-1 | |
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
Timing | |||
![]() ![]() ![]() |
instant | |||
![]() ![]() |
C | 0..1 | Susceptibility Test Result Constraints: us-core-3, us-core-4 | |
![]() ![]() ![]() |
Quantity | |||
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
string | |||
![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() |
Ratio | |||
![]() ![]() ![]() |
SampledData | |||
![]() ![]() ![]() |
time | |||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() |
C | 0..1 | CodeableConcept | (USCDI) Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
![]() ![]() |
0..* | CodeableConcept | Susceptibility Interpretation Binding: ObservationInterpretationSusceptibility (3.0.0) (required) | |
![]() ![]() |
1..1 | Reference(eICR Organism Isolate Specimen) | Organism isolate the susceptibility test was performed on | |
Documentation for this format | ||||
| 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 |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | USPublicHealthLaboratoryResultObservation | eICR Organism Susceptibility Observation | |
![]() ![]() |
1..1 | CodeableConcept | Susceptibility Test Binding: VSAC 2.16.840.1.113762.1.4.1280.3 (extensible) | |
![]() ![]() |
1..1 | Reference(US Public Health Patient) | (USCDI) Who and/or what the observation is about | |
![]() ![]() |
0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period | Susceptibility Test Result | |
![]() ![]() |
0..* | CodeableConcept | Susceptibility Interpretation Binding: ObservationInterpretationSusceptibility (3.0.0) (required) | |
![]() ![]() |
1..1 | Reference(eICR Organism Isolate Specimen) | Organism isolate the susceptibility test was performed on | |
Documentation for this format | ||||
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | USPublicHealthLaboratoryResultObservation | eICR Organism Susceptibility Observation Constraints: obs-6, obs-7, us-core-2 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | Business Identifier for observation | |||||
![]() ![]() |
0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | |||||
![]() ![]() |
0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | |||||
![]() ![]() |
1..1 | code | (USCDI+) Result Status Binding: ObservationStatus (required): Codes providing the status of an observation. | |||||
![]() ![]() |
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 | |||||
![]() ![]() ![]() |
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: | |||||
![]() ![]() |
1..1 | CodeableConcept | Susceptibility Test Binding: VSAC 2.16.840.1.113762.1.4.1280.3 (extensible) | |||||
![]() ![]() |
1..1 | Reference(US Public Health Patient) | (USCDI) Who and/or what the observation is about | |||||
![]() ![]() |
0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | |||||
![]() ![]() |
0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |||||
![]() ![]() |
C | 0..1 | (USCDI) Clinically relevant time/time-period for observation Constraints: us-core-1 | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() |
instant | |||||||
![]() ![]() |
0..1 | instant | Date/Time this version was made available | |||||
![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | |||||
![]() ![]() |
C | 0..1 | Susceptibility Test Result Constraints: us-core-3, us-core-4 | |||||
![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() |
SampledData | |||||||
![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
C | 0..1 | CodeableConcept | (USCDI) Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
![]() ![]() |
0..* | CodeableConcept | Susceptibility Interpretation Binding: ObservationInterpretationSusceptibility (3.0.0) (required) | |||||
![]() ![]() |
0..* | Annotation | Comments about the observation | |||||
![]() ![]() |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
![]() ![]() |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
![]() ![]() |
1..1 | Reference(eICR Organism Isolate Specimen) | Organism isolate the susceptibility test was performed on | |||||
![]() ![]() |
0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
![]() ![]() |
C | 0..* | BackboneElement | Provides guide for interpretation Constraints: obs-3 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | Low Range, if relevant Constraints: sqty-1 | ||||
![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | High Range, if relevant Constraints: sqty-1 | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
![]() ![]() ![]() |
0..1 | Range | Applicable age range, if relevant | |||||
![]() ![]() ![]() |
0..1 | string | Text based reference range in an observation | |||||
![]() ![]() |
0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | |||||
![]() ![]() |
0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | |||||
![]() ![]() |
0..* | BackboneElement | Component results | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | |||||
![]() ![]() ![]() |
0..1 | Actual component result | ||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() |
SampledData | |||||||
![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
![]() ![]() ![]() |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
Documentation for this format | ||||||||
| 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'
|
This structure is derived from USPublicHealthLaboratoryResultObservation
Summary
Mandatory: 1 element
Must-Support: 1 element
Structures
This structure refers to these other structures:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron