Logica COVID-19 FHIR Profile Library IG
0.13.1 - ci-build
Logica COVID-19 FHIR Profile Library IG
0.13.1 - ci-build
Logica COVID-19 FHIR Profile Library IG - Local Development build (v0.13.1). See the Directory of published versions
A general structure for the observations of the presense or absence of underlying conditions.
The official URL for this profile is:
http://fhir.logicahealth.org/covid19/StructureDefinition/covid19-underlying-condition-observation-parent
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Summary
Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 2 elements
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | 0..* | Observation | This is an abstract profile Measurements and simple assertions | |
  value[x] | 0..0 | |||
 component | S | 0..* | BackboneElement | Component results |
  Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
 covid19-underlying-condition-category-code | 1..1 | CodeableConcept | Underlying Condition Category Code URL: http://fhir.logicahealth.org/covid19/StructureDefinition/covid19-underlying-condition-category-code | |
| covid19-underlying-condition-reference | 0..1 | Reference() | Underlying Condition Reference URL: http://fhir.logicahealth.org/covid19/StructureDefinition/covid19-underlying-condition-reference | |
 Slices for value[x] | 0..1 | CodeableConcept | Actual component result Slice: Unordered, Open by type:$this | |
 valueCodeableConcept | 0..1 | CodeableConcept | Actual component result Binding: Present, Absent, Unknown Value Set (extensible) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | I | 0..* | Observation | This is an abstract profile Measurements and simple assertions |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business Identifier for observation |
 basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order |
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
| focus | Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record |
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made |
  effective[x] | Σ | 0..1 | Clinically relevant time/time-period for observation | |
 effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| effectiveTiming | Timing | |||
| effectiveInstant | instant | |||
| issued | Σ | 0..1 | instant | Date/Time this version was made available |
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
| dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
| note | 0..* | Annotation | Comments about the observation | |
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
| method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |
| specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |
| device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |
| referenceRange | I | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| low | I | 0..1 | SimpleQuantity | Low Range, if relevant |
| high | I | 0..1 | SimpleQuantity | High Range, if relevant |
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |
| age | 0..1 | Range | Applicable age range, if relevant | |
| text | 0..1 | string | Text based reference range in an observation | |
| hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group |
| derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from |
| component | SΣ | 0..* | BackboneElement | Component results |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
| covid19-underlying-condition-category-code | 1..1 | CodeableConcept | Underlying Condition Category Code URL: http://fhir.logicahealth.org/covid19/StructureDefinition/covid19-underlying-condition-category-code | |
| covid19-underlying-condition-reference | 0..1 | Reference() | Underlying Condition Reference URL: http://fhir.logicahealth.org/covid19/StructureDefinition/covid19-underlying-condition-reference | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| Slices for value[x] | Σ | 0..1 | CodeableConcept | Actual component result Slice: Unordered, Closed by type:$this |
 value[x]:valueCodeableConcept | Σ | 0..1 | CodeableConcept | Actual component result Binding: Present, Absent, Unknown Value Set (extensible) |
| dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |
| Documentation for this format | ||||
This structure is derived from Observation
Summary
Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 2 elements
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 0..* | Observation | This is an abstract profile Measurements and simple assertions | |
| value[x] | 0..0 | |||
| component | S | 0..* | BackboneElement | Component results |
| Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
| covid19-underlying-condition-category-code | 1..1 | CodeableConcept | Underlying Condition Category Code URL: http://fhir.logicahealth.org/covid19/StructureDefinition/covid19-underlying-condition-category-code | |
| covid19-underlying-condition-reference | 0..1 | Reference() | Underlying Condition Reference URL: http://fhir.logicahealth.org/covid19/StructureDefinition/covid19-underlying-condition-reference | |
| Slices for value[x] | 0..1 | CodeableConcept | Actual component result Slice: Unordered, Open by type:$this | |
| valueCodeableConcept | 0..1 | CodeableConcept | Actual component result Binding: Present, Absent, Unknown Value Set (extensible) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | I | 0..* | Observation | This is an abstract profile Measurements and simple assertions |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Business Identifier for observation |
| basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order |
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event |
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about |
| focus | Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record |
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made |
| effective[x] | Σ | 0..1 | Clinically relevant time/time-period for observation | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| effectiveTiming | Timing | |||
| effectiveInstant | instant | |||
| issued | Σ | 0..1 | instant | Date/Time this version was made available |
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation |
| dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
| note | 0..* | Annotation | Comments about the observation | |
| bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
| method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |
| specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |
| device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |
| referenceRange | I | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| low | I | 0..1 | SimpleQuantity | Low Range, if relevant |
| high | I | 0..1 | SimpleQuantity | High Range, if relevant |
| type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |
| appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |
| age | 0..1 | Range | Applicable age range, if relevant | |
| text | 0..1 | string | Text based reference range in an observation | |
| hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group |
| derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from |
| component | SΣ | 0..* | BackboneElement | Component results |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
| covid19-underlying-condition-category-code | 1..1 | CodeableConcept | Underlying Condition Category Code URL: http://fhir.logicahealth.org/covid19/StructureDefinition/covid19-underlying-condition-category-code | |
| covid19-underlying-condition-reference | 0..1 | Reference() | Underlying Condition Reference URL: http://fhir.logicahealth.org/covid19/StructureDefinition/covid19-underlying-condition-reference | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| Slices for value[x] | Σ | 0..1 | CodeableConcept | Actual component result Slice: Unordered, Closed by type:$this |
| value[x]:valueCodeableConcept | Σ | 0..1 | CodeableConcept | Actual component result Binding: Present, Absent, Unknown Value Set (extensible) |
| dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. |
| interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
| referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet |
| Observation.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Observation.status | required | ObservationStatus |
| Observation.category | preferred | ObservationCategoryCodes |
| Observation.code | example | LOINCCodes |
| Observation.dataAbsentReason | extensible | DataAbsentReason |
| Observation.interpretation | extensible | ObservationInterpretationCodes |
| Observation.bodySite | example | SNOMEDCTBodyStructures |
| Observation.method | example | ObservationMethods |
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes |
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes |
| Observation.component.code | example | LOINCCodes |
| Observation.component.value[x]:valueCodeableConcept | extensible | PresentAbsentUnknownVS |
| Observation.component.dataAbsentReason | extensible | DataAbsentReason |
| Observation.component.interpretation | extensible | ObservationInterpretationCodes |
| Id | Path | Details | Requirements |
| obs-3 | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() |