IL Core Implementation Guide
0.18.0 - draft
This page is part of the IL-Core IG (v0.18.0: draft-1 Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://fhir.health.gov.il/StructureDefinition/il-core-immunization-reaction-observation | Version: 0.18.0 | |||
Standards status: Trial-use | Maturity Level: 1 | Computable Name: ILCoreImmunizationReactionObservation |
Israel Core proposed constraints and extensions on the ImmunizationReactionObservation Resource
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ILCoreObservation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | ILCoreObservation | ILCore ImmunizationReactionObservation Profile | |
partOf | 0..* | Reference(ILCore Immunization Profile) | Part of referenced event | |
code | ||||
coding | 1..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 31044-1 | |
subject | 1..1 | Reference(ILCore Patient Profile) | Who and/or what the observation is about | |
value[x] | 1..1 | CodeableConcept | Actual result | |
Slices for value[x] | Content/Rules for all slices | |||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Actual result Binding: Immunization side-effect codes (extensible) | |
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (preferred) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.value[x]:valueCodeableConcept | extensible | ImmunizationSideEffectshttp://fhir.health.gov.il/ValueSet/immunization-side-effect from this IG | |
Observation.bodySite | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | ILCoreObservation | ILCore ImmunizationReactionObservation Profile obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
partOf | Σ | 0..* | Reference(ILCore Immunization Profile) | Part of referenced event |
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
category | S | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: IL Core Observation Codes (preferred) |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 31044-1 |
subject | SΣ | 1..1 | Reference(ILCore Patient Profile) | Who and/or what the observation is about |
Slices for value[x] | SΣC | 1..1 | CodeableConcept | Actual result Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | Actual result Binding: Immunization side-effect codes (extensible) il-obs-value-cc: SHOULD use SNOMED-CT or LOINC Answers for coded results |
value[x]:valueQuantity | ΣC | 0..1 | Quantity | Actual result il-obs-ucum: SHOULD use UCUM for coded quantity units |
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (preferred) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | |
Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | |
Observation.code | preferred | ILCoreObservationCodehttp://fhir.health.gov.il/ValueSet/il-core-observation-code from this IG | |
Observation.value[x]:valueCodeableConcept | extensible | ImmunizationSideEffectshttp://fhir.health.gov.il/ValueSet/immunization-side-effect from this IG | |
Observation.bodySite | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | ILCoreObservation | ILCore ImmunizationReactionObservation Profile obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present | ||||
id | Σ | 0..1 | id | 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): 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(ILCore CarePlan Profile | ILCore DeviceRequest Profile | ILCore ImmunizationRecommendation Profile | ILCore MedicationRequest Profile | ILCore Molecular Sequence | ILCore ServiceRequest Profile) | Fulfills plan, proposal or order | ||||
partOf | Σ | 0..* | Reference(ILCore Immunization Profile) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
category | S | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: IL Core Observation Codes (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 31044-1 | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
subject | SΣ | 1..1 | Reference(ILCore Patient Profile) | 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(ILCore Encounter Profile) | 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(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | ILCore CareTeam Profile | ILCore Patient Profile | ILCore RelatedPerson Profile) | Who is responsible for the observation | ||||
Slices for value[x] | SΣC | 1..1 | CodeableConcept | Actual result Slice: Unordered, Closed by type:$this | ||||
value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | Actual result Binding: Immunization side-effect codes (extensible) il-obs-value-cc: SHOULD use SNOMED-CT or LOINC Answers for coded results | ||||
value[x]:valueQuantity | ΣC | 0..1 | Quantity | Actual result il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. il-obs-not-performed: dataAbsentReason - if an IL-Core 'not-performed-reason' code is supplied, 'not performed' code MUST be supplied as well | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:not-performed-reason | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.health.gov.il/cs/il-core-not-performed-reason | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
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 (preferred) | |||||
method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (preferred): Methods for simple observations. | |||||
specimen | 0..1 | Reference(ILCore Specimen Profile) | Specimen used for this observation | |||||
device | 0..1 | Reference(ILCore Device Profile | DeviceMetric) | (Measurement) Device | |||||
referenceRange | C | 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 | C | 0..1 | SimpleQuantity | Low Range, if relevant il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
high | C | 0..1 | SimpleQuantity | High Range, if relevant il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
low | Σ | 0..1 | SimpleQuantity | Low limit Binding: CommonUCUMCodesForAge (required) | ||||
high | Σ | 0..1 | SimpleQuantity | High limit Binding: CommonUCUMCodesForAge (required) | ||||
text | 0..1 | string | Text based reference range in an observation | |||||
hasMember | Σ | 0..* | Reference(ILCore Observation Profile | ILCore QuestionnaireResponse Profile | MolecularSequence) | Related resource that belongs to the Observation group | ||||
derivedFrom | Σ | 0..* | Reference(ILCore DocumentReference Profile | ILCore ImagingStudy Profile | ILCore Media Profile | ILCore QuestionnaireResponse Profile | ILCore Observation Profile | ILCore Molecular Sequence) | Related measurements the observation is made from | ||||
component | Σ | 0..* | BackboneElement | Component results | ||||
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 | ||||
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: IL Core Observation Codes (preferred) | ||||
Slices for value[x] | Σ | 0..1 | Actual component result Slice: Unordered, Open by type:$this | |||||
valueQuantity | Quantity | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueString | string | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueSampledData | SampledData | |||||||
valueTime | time | |||||||
valueDateTime | dateTime | |||||||
valuePeriod | Period | |||||||
value[x]:valueQuantity | ΣC | 0..1 | Quantity | Actual component result il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | Actual component result Binding: IL Core Observation Value Codes (preferred) il-obs-value-cc: SHOULD use SNOMED-CT or LOINC Answers for coded results | ||||
dataAbsentReason | C | 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..* | BackboneElement | Provides guide for interpretation of component result | |||||
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 | C | 0..1 | SimpleQuantity | Low Range, if relevant il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
high | C | 0..1 | SimpleQuantity | High Range, if relevant il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
low | Σ | 0..1 | SimpleQuantity | Low limit Binding: CommonUCUMCodesForAge (required) | ||||
high | Σ | 0..1 | SimpleQuantity | High limit Binding: CommonUCUMCodesForAge (required) | ||||
text | 0..1 | string | Text based reference range in an observation | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | ||||
Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.code | preferred | ILCoreObservationCodehttp://fhir.health.gov.il/ValueSet/il-core-observation-code from this IG | ||||
Observation.value[x]:valueCodeableConcept | extensible | ImmunizationSideEffectshttp://fhir.health.gov.il/ValueSet/immunization-side-effect from this IG | ||||
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.bodySite | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Observation.method | preferred | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods from the FHIR Standard | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.referenceRange.age.low | required | CommonUCUMCodesForAgehttp://hl7.org/fhir/ValueSet/age-units from the FHIR Standard | ||||
Observation.referenceRange.age.high | required | CommonUCUMCodesForAgehttp://hl7.org/fhir/ValueSet/age-units from the FHIR Standard | ||||
Observation.component.code | preferred | ILCoreObservationCodehttp://fhir.health.gov.il/ValueSet/il-core-observation-code from this IG | ||||
Observation.component.value[x]:valueCodeableConcept | preferred | ILCoreObservationValuehttp://fhir.health.gov.il/ValueSet/il-core-observation-value from this IG | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.component.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.component.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.component.referenceRange.age.low | required | CommonUCUMCodesForAgehttp://hl7.org/fhir/ValueSet/age-units from the FHIR Standard | ||||
Observation.component.referenceRange.age.high | required | CommonUCUMCodesForAgehttp://hl7.org/fhir/ValueSet/age-units from the FHIR Standard |
This structure is derived from ILCoreObservation
Differential View
This structure is derived from ILCoreObservation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | ILCoreObservation | ILCore ImmunizationReactionObservation Profile | |
partOf | 0..* | Reference(ILCore Immunization Profile) | Part of referenced event | |
code | ||||
coding | 1..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 31044-1 | |
subject | 1..1 | Reference(ILCore Patient Profile) | Who and/or what the observation is about | |
value[x] | 1..1 | CodeableConcept | Actual result | |
Slices for value[x] | Content/Rules for all slices | |||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Actual result Binding: Immunization side-effect codes (extensible) | |
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (preferred) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.value[x]:valueCodeableConcept | extensible | ImmunizationSideEffectshttp://fhir.health.gov.il/ValueSet/immunization-side-effect from this IG | |
Observation.bodySite | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | ILCoreObservation | ILCore ImmunizationReactionObservation Profile obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
partOf | Σ | 0..* | Reference(ILCore Immunization Profile) | Part of referenced event |
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
category | S | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. |
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: IL Core Observation Codes (preferred) |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 31044-1 |
subject | SΣ | 1..1 | Reference(ILCore Patient Profile) | Who and/or what the observation is about |
Slices for value[x] | SΣC | 1..1 | CodeableConcept | Actual result Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | Actual result Binding: Immunization side-effect codes (extensible) il-obs-value-cc: SHOULD use SNOMED-CT or LOINC Answers for coded results |
value[x]:valueQuantity | ΣC | 0..1 | Quantity | Actual result il-obs-ucum: SHOULD use UCUM for coded quantity units |
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (preferred) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | |
Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | |
Observation.code | preferred | ILCoreObservationCodehttp://fhir.health.gov.il/ValueSet/il-core-observation-code from this IG | |
Observation.value[x]:valueCodeableConcept | extensible | ImmunizationSideEffectshttp://fhir.health.gov.il/ValueSet/immunization-side-effect from this IG | |
Observation.bodySite | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | ILCoreObservation | ILCore ImmunizationReactionObservation Profile obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present | ||||
id | Σ | 0..1 | id | 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): 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(ILCore CarePlan Profile | ILCore DeviceRequest Profile | ILCore ImmunizationRecommendation Profile | ILCore MedicationRequest Profile | ILCore Molecular Sequence | ILCore ServiceRequest Profile) | Fulfills plan, proposal or order | ||||
partOf | Σ | 0..* | Reference(ILCore Immunization Profile) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
category | S | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: IL Core Observation Codes (preferred) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 31044-1 | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
subject | SΣ | 1..1 | Reference(ILCore Patient Profile) | 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(ILCore Encounter Profile) | 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(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | ILCore CareTeam Profile | ILCore Patient Profile | ILCore RelatedPerson Profile) | Who is responsible for the observation | ||||
Slices for value[x] | SΣC | 1..1 | CodeableConcept | Actual result Slice: Unordered, Closed by type:$this | ||||
value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | Actual result Binding: Immunization side-effect codes (extensible) il-obs-value-cc: SHOULD use SNOMED-CT or LOINC Answers for coded results | ||||
value[x]:valueQuantity | ΣC | 0..1 | Quantity | Actual result il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
dataAbsentReason | C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. il-obs-not-performed: dataAbsentReason - if an IL-Core 'not-performed-reason' code is supplied, 'not performed' code MUST be supplied as well | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:not-performed-reason | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fhir.health.gov.il/cs/il-core-not-performed-reason | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
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 (preferred) | |||||
method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (preferred): Methods for simple observations. | |||||
specimen | 0..1 | Reference(ILCore Specimen Profile) | Specimen used for this observation | |||||
device | 0..1 | Reference(ILCore Device Profile | DeviceMetric) | (Measurement) Device | |||||
referenceRange | C | 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 | C | 0..1 | SimpleQuantity | Low Range, if relevant il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
high | C | 0..1 | SimpleQuantity | High Range, if relevant il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
low | Σ | 0..1 | SimpleQuantity | Low limit Binding: CommonUCUMCodesForAge (required) | ||||
high | Σ | 0..1 | SimpleQuantity | High limit Binding: CommonUCUMCodesForAge (required) | ||||
text | 0..1 | string | Text based reference range in an observation | |||||
hasMember | Σ | 0..* | Reference(ILCore Observation Profile | ILCore QuestionnaireResponse Profile | MolecularSequence) | Related resource that belongs to the Observation group | ||||
derivedFrom | Σ | 0..* | Reference(ILCore DocumentReference Profile | ILCore ImagingStudy Profile | ILCore Media Profile | ILCore QuestionnaireResponse Profile | ILCore Observation Profile | ILCore Molecular Sequence) | Related measurements the observation is made from | ||||
component | Σ | 0..* | BackboneElement | Component results | ||||
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 | ||||
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: IL Core Observation Codes (preferred) | ||||
Slices for value[x] | Σ | 0..1 | Actual component result Slice: Unordered, Open by type:$this | |||||
valueQuantity | Quantity | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueString | string | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueSampledData | SampledData | |||||||
valueTime | time | |||||||
valueDateTime | dateTime | |||||||
valuePeriod | Period | |||||||
value[x]:valueQuantity | ΣC | 0..1 | Quantity | Actual component result il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | Actual component result Binding: IL Core Observation Value Codes (preferred) il-obs-value-cc: SHOULD use SNOMED-CT or LOINC Answers for coded results | ||||
dataAbsentReason | C | 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..* | BackboneElement | Provides guide for interpretation of component result | |||||
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 | C | 0..1 | SimpleQuantity | Low Range, if relevant il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
high | C | 0..1 | SimpleQuantity | High Range, if relevant il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
low | Σ | 0..1 | SimpleQuantity | Low limit Binding: CommonUCUMCodesForAge (required) | ||||
high | Σ | 0..1 | SimpleQuantity | High limit Binding: CommonUCUMCodesForAge (required) | ||||
text | 0..1 | string | Text based reference range in an observation | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | ||||
Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.code | preferred | ILCoreObservationCodehttp://fhir.health.gov.il/ValueSet/il-core-observation-code from this IG | ||||
Observation.value[x]:valueCodeableConcept | extensible | ImmunizationSideEffectshttp://fhir.health.gov.il/ValueSet/immunization-side-effect from this IG | ||||
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.bodySite | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Observation.method | preferred | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods from the FHIR Standard | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.referenceRange.age.low | required | CommonUCUMCodesForAgehttp://hl7.org/fhir/ValueSet/age-units from the FHIR Standard | ||||
Observation.referenceRange.age.high | required | CommonUCUMCodesForAgehttp://hl7.org/fhir/ValueSet/age-units from the FHIR Standard | ||||
Observation.component.code | preferred | ILCoreObservationCodehttp://fhir.health.gov.il/ValueSet/il-core-observation-code from this IG | ||||
Observation.component.value[x]:valueCodeableConcept | preferred | ILCoreObservationValuehttp://fhir.health.gov.il/ValueSet/il-core-observation-value from this IG | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.component.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.component.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.component.referenceRange.age.low | required | CommonUCUMCodesForAgehttp://hl7.org/fhir/ValueSet/age-units from the FHIR Standard | ||||
Observation.component.referenceRange.age.high | required | CommonUCUMCodesForAgehttp://hl7.org/fhir/ValueSet/age-units from the FHIR Standard |
This structure is derived from ILCoreObservation
Other representations of profile: CSV, Excel, Schematron