Hospital-Community Lab Referral Cycle
1.1.0 - ci-build
This page is part of the LRC IG (v1.1.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://ig.fhir-il-community.org/LRC/StructureDefinition/lrc-result | Version: 1.1.0 | |||
Active as of 2024-08-12 | Computable Name: LrcResult |
תוצאת בדיקת מעבדה בודדת.
פרופיל המייצג תוצאת בדיקת מעבדה בודדת, באמצעות Observation. כל תוצאה בודדת שמתקבלת בקרב הארגון המבצע, נשלחת לארגון שיזם את ההפניה. התוצאות מייצגות את כל הבדיקות הבודדות, הן אלו שנשלחה עבורם הפניה בודדת והן אלו שנשלחה עבורם הפנייה של סוללה.
הפרופיל הנ"ל מתבסס על הפרופיל הישראלי: ILCore Observation. בנוסף להגדרות קארדינליות ושמירת הקשר לפרופילים נוספים של IL-Core, הפרופיל גם מגדיר:
להלן הסטאטוסים השונים של התוצאות:
final זהו ערך ברירת המחדל של התוצאה הבודדת. היא תמיד תיווצר כ- final
entered-in-error ישמש במקרה בו התקבלה תוצאה לא תקינה, למשל בעקבות תקלה טכנית. במקרים אלו, התוצאה השגויה תישלח גם כדי שהמטפל ידע שהתוצאה הספציפית חסרה במקבץ הבדיקות (על פי מידת הקריטיות, יתכן ויבקש השלמת הבדיקה בטרם הטיפול/ביקור), וגם כדי לדאוג לשלמות הדוח המסכם ושליחתו (בהיעדר תוצאה, הדוח המסכם לא יוכל להיסגר עם סטאטוס final). אותה התוצאה הבודדת "תסומן" עם הסטאטוס הייחודי לה, כך שהמטפל בביה"ח ידע שערך התוצאה אינו מהווה אינדיקציה להערכת מצב המטופל.
cancelled ישמש במידה וידרש ביטול תוצאה שכבר שודרה. תהליך העדכון בפועל יבוצע כפי שמקובל כיום בביה"ח ובקופה (יידוע המטופל, עדכון מערכות וכו).
רשימת ערכי Loinc אשר כוללת מקבץ קודי תוצאות עבור בדיקות מעבדה אפשריות. היא רלוונטית עבור אלמנט: Observation.code, בפרופיל: LRC Test Result.
הרשימה מוגדרת עם binding מסוג extensible, כלומר ניתן להרחיב את הרשימה לערכים נוספים, על פי הצורך. בתוך הרשימה נכללים גם קודים של תוצאות אשר משוייכות להפניות בודדות, וגם קודים של תוצאות אשר משוייכות לפאנל (לא קודי פאנל, אלא קודי התוצאות של הפאנל). זאת מכיוון שאופן השימוש בכל סוג של תוצאה עם ערך, הינו זהה וממומש באמצעות אותו הפרופיל (LRC Test Result). קודי הפאנלים מוגדרים ברשימת ערכים נפרדת.
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 Observation Profile | |||||
identifier | 1..* | Identifier | Business Identifier for observation | |||||
system | 1..1 | uri | The namespace for the identifier value | |||||
value | 1..1 | string | The value that is unique | |||||
basedOn | 0..1 | Reference(Lrc Lab Test Referral) | Fulfills plan, proposal or order | |||||
Slices for category | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:coding | |||||
category:hl7-lab | 1..1 | CodeableConcept | Classification of type of observation | |||||
Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |||||
coding:hl7 | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Laboratory | |||||
system | 1..1 | uri | Identity of the terminology system | |||||
code | 1..1 | code | Symbol in syntax defined by the system | |||||
code | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Lrc Result Codes (extensible)
| |||||
Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | |||||
coding:loinc-lab | 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 | |||||
subject | 0..1 | Reference(ILCore Patient Profile) | Who and/or what the observation is about | |||||
reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |||||
performer | 1..* | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | CareTeam | ILCore Patient Profile | ILCore RelatedPerson Profile) | Who is responsible for the observation | |||||
Slices for value[x] | Content/Rules for all slices | |||||||
value[x]:valueQuantity | 0..1 | Quantity | Actual result | |||||
system | 1..1 | uri | System that defines coded unit form | |||||
referenceRange | ||||||||
low | 1..1 | SimpleQuantity | Low Range, if relevant Binding: Common UCUM units (required) | |||||
system | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org | |||||
high | 1..1 | SimpleQuantity | High Range, if relevant Binding: Common UCUM units (required) | |||||
system | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org | |||||
Slices for component | 0..* | BackboneElement | Component results Slice: Unordered, Open by value:code | |||||
component:textual | 0..1 | BackboneElement | Component results | |||||
code | ||||||||
coding | 1..* | Coding | Code defined by a terminology system | |||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
code | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 117444000 | |||||
display | 0..1 | string | Representation defined by the system Required Pattern: Text value | |||||
value[x] | 1..1 | string | Actual component result | |||||
Slices for value[x] | Content/Rules for all slices | |||||||
value[x]:valueString | 1..1 | string | Actual component result | |||||
component:nominal | 0..1 | BackboneElement | Component results | |||||
code | ||||||||
coding | 1..* | Coding | Code defined by a terminology system | |||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
code | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 117362005 | |||||
display | 0..1 | string | Representation defined by the system Required Pattern: Nominal value | |||||
value[x] | 0..1 | CodeableConcept | Actual component result | |||||
Slices for value[x] | Content/Rules for all slices | |||||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Actual component result | |||||
coding | 1..* | Coding | Code defined by a terminology system | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Observation.code | extensible | LrcResultCodes
http://ig.fhir-il-community.org/LRC/ValueSet/lrc-result-codes from this IG | ||||
Observation.referenceRange.low | required | Common UCUM unitshttp://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard | ||||
Observation.referenceRange.high | required | Common UCUM unitshttp://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | ILCoreObservation | ILCore Observation 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 | ||||
identifier | Σ | 1..* | Identifier | Business Identifier for observation | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
basedOn | Σ | 0..1 | Reference(Lrc Lab Test Referral) | Fulfills plan, proposal or order | ||||
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:coding Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
category:hl7-lab | S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||
coding:hl7 | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Laboratory | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Lrc Result Codes (extensible)
| ||||
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||
coding:loinc-lab | Σ | 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 | ||||
subject | SΣ | 0..1 | Reference(ILCore Patient Profile) | Who and/or what the observation is about | ||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
performer | Σ | 1..* | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | CareTeam | ILCore Patient Profile | ILCore RelatedPerson Profile) | Who is responsible for the observation | ||||
Slices for value[x] | SΣC | 0..1 | Actual result Slice: Unordered, Closed 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 result il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
system | ΣC | 1..1 | uri | System that defines coded unit form | ||||
value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | Actual result Binding: IL Core Observation Value Codes (preferred) il-obs-value-cc: SHOULD use SNOMED-CT or LOINC Answers for coded results | ||||
Slices for component | Σ | 0..* | BackboneElement | Component results Slice: Unordered, Open by value:code | ||||
component:All Slices | Content/Rules for all slices | |||||||
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 | ||||
component:textual | Σ | 0..1 | BackboneElement | Component results | ||||
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) | ||||
coding | Σ | 1..* | Coding | Code defined by a terminology system | ||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 117444000 | ||||
display | Σ | 0..1 | string | Representation defined by the system Required Pattern: Text value | ||||
Slices for value[x] | Σ | 1..1 | string | Actual component result Slice: Unordered, Closed by type:$this | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
value[x]:valueString | Σ | 1..1 | string | Actual component result | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
value[x]:valueQuantity | ΣC | 0..1 | Quantity | Actual component result il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
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 | ||||
component:nominal | Σ | 0..1 | BackboneElement | Component results | ||||
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) | ||||
coding | Σ | 1..* | Coding | Code defined by a terminology system | ||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 117362005 | ||||
display | Σ | 0..1 | string | Representation defined by the system Required Pattern: Nominal value | ||||
Slices for value[x] | Σ | 0..1 | CodeableConcept | Actual component result Slice: Unordered, Closed by type:$this | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
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 | ||||
coding | Σ | 1..* | Coding | Code defined by a terminology system | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
value[x]:valueQuantity | ΣC | 0..1 | Quantity | Actual component result il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Observation.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 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.category:hl7-lab | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.code | extensible | LrcResultCodes
http://ig.fhir-il-community.org/LRC/ValueSet/lrc-result-codes from this IG | ||||
Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
Observation.value[x]:valueCodeableConcept | preferred | ILCoreObservationValuehttp://fhir.health.gov.il/ValueSet/il-core-observation-value | ||||
Observation.component.code | preferred | ILCoreObservationCodehttp://fhir.health.gov.il/ValueSet/il-core-observation-code | ||||
Observation.component.value[x]:valueCodeableConcept | preferred | ILCoreObservationValuehttp://fhir.health.gov.il/ValueSet/il-core-observation-value | ||||
Observation.component:textual.code | preferred | ILCoreObservationCodehttp://fhir.health.gov.il/ValueSet/il-core-observation-code | ||||
Observation.component:textual.value[x]:valueCodeableConcept | preferred | ILCoreObservationValuehttp://fhir.health.gov.il/ValueSet/il-core-observation-value | ||||
Observation.component:nominal.code | preferred | ILCoreObservationCodehttp://fhir.health.gov.il/ValueSet/il-core-observation-code | ||||
Observation.component:nominal.value[x]:valueCodeableConcept | preferred | ILCoreObservationValuehttp://fhir.health.gov.il/ValueSet/il-core-observation-value |
Id | Grade | Path(s) | Details | Requirements |
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() | |
il-obs-ucum | warning | Observation.value[x]:valueQuantity, Observation.component.value[x]:valueQuantity, Observation.component:textual.value[x]:valueQuantity, Observation.component:nominal.value[x]:valueQuantity | SHOULD use UCUM for coded quantity units : system.empty() or system = 'http://unitsofmeasure.org' | |
il-obs-value-cc | warning | Observation.value[x]:valueCodeableConcept, Observation.component.value[x]:valueCodeableConcept, Observation.component:textual.value[x]:valueCodeableConcept, Observation.component:nominal.value[x]:valueCodeableConcept | SHOULD use SNOMED-CT or LOINC Answers for coded results : coding.where(system='http://snomed.info/sct' and code.exists()).exists() OR coding.where(system='http://loinc.org' and code.startsWith('LA')).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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | ILCoreObservation | ILCore Observation 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 | Σ | 1..* | Identifier | Business Identifier for observation | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
basedOn | Σ | 0..1 | Reference(Lrc Lab Test Referral) | Fulfills plan, proposal or order | ||||
partOf | Σ | 0..* | Reference(ILCore MedicationAdministration Profile | ILCore MedicationDispense Profile | ILCore Procedure Profile | ILCore Immunization Profile | ILCore ImagingStudy Profile | ILCore MedicationStatement Profile) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:coding Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
category:hl7-lab | S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
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 | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||
coding:hl7 | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Laboratory | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
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 | ||||
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 | ||||
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Lrc Result Codes (extensible)
| ||||
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 | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||
coding:loinc-lab | Σ | 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 | ||||
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Σ | 0..1 | Reference(ILCore Patient Profile) | Who and/or what the observation is about | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
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 | Σ | 1..* | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | CareTeam | ILCore Patient Profile | ILCore RelatedPerson Profile) | Who is responsible for the observation | ||||
Slices for value[x] | SΣC | 0..1 | Actual result Slice: Unordered, Closed 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 result il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 1..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | Actual 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 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): Codes describing anatomical locations. May include laterality. | |||||
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 | 1..1 | SimpleQuantity | Low Range, if relevant Binding: Common UCUM units (required) il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
high | C | 1..1 | SimpleQuantity | High Range, if relevant Binding: Common UCUM units (required) il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
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 | MolecularSequence) | Related measurements the observation is made from | ||||
Slices for component | Σ | 0..* | BackboneElement | Component results Slice: Unordered, Open by value:code | ||||
component:All Slices | Content/Rules for all slices | |||||||
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 | |||||
component:textual | Σ | 0..1 | 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) | ||||
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..* | 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 | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 117444000 | ||||
display | Σ | 0..1 | string | Representation defined by the system Required Pattern: Text value | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
Slices for value[x] | Σ | 1..1 | string | Actual component result Slice: Unordered, Closed by type:$this | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
value[x]:valueString | Σ | 1..1 | string | Actual component result | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
value[x]:valueQuantity | ΣC | 0..1 | Quantity | Actual component result il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
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 | |||||
component:nominal | Σ | 0..1 | 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) | ||||
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..* | 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 | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 117362005 | ||||
display | Σ | 0..1 | string | Representation defined by the system Required Pattern: Nominal value | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
Slices for value[x] | Σ | 0..1 | CodeableConcept | Actual component result Slice: Unordered, Closed by type:$this | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
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 | ||||
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..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
value[x]:valueQuantity | ΣC | 0..1 | Quantity | Actual component result il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
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.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Observation.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type 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.category:hl7-lab | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.code | extensible | LrcResultCodes
http://ig.fhir-il-community.org/LRC/ValueSet/lrc-result-codes from this IG | ||||
Observation.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
Observation.value[x]:valueCodeableConcept | preferred | ILCoreObservationValuehttp://fhir.health.gov.il/ValueSet/il-core-observation-value | ||||
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.low | required | Common UCUM unitshttp://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard | ||||
Observation.referenceRange.high | required | Common UCUM unitshttp://hl7.org/fhir/ValueSet/ucum-common 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 | ||||
Observation.component.value[x]:valueCodeableConcept | preferred | ILCoreObservationValuehttp://fhir.health.gov.il/ValueSet/il-core-observation-value | ||||
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 | ||||
Observation.component:textual.code | preferred | ILCoreObservationCodehttp://fhir.health.gov.il/ValueSet/il-core-observation-code | ||||
Observation.component:textual.value[x]:valueCodeableConcept | preferred | ILCoreObservationValuehttp://fhir.health.gov.il/ValueSet/il-core-observation-value | ||||
Observation.component:textual.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component:textual.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.component:textual.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.component:textual.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.component:textual.referenceRange.age.low | required | CommonUCUMCodesForAgehttp://hl7.org/fhir/ValueSet/age-units from the FHIR Standard | ||||
Observation.component:textual.referenceRange.age.high | required | CommonUCUMCodesForAgehttp://hl7.org/fhir/ValueSet/age-units from the FHIR Standard | ||||
Observation.component:nominal.code | preferred | ILCoreObservationCodehttp://fhir.health.gov.il/ValueSet/il-core-observation-code | ||||
Observation.component:nominal.value[x]:valueCodeableConcept | preferred | ILCoreObservationValuehttp://fhir.health.gov.il/ValueSet/il-core-observation-value | ||||
Observation.component:nominal.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component:nominal.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.component:nominal.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.component:nominal.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.component:nominal.referenceRange.age.low | required | CommonUCUMCodesForAgehttp://hl7.org/fhir/ValueSet/age-units from the FHIR Standard | ||||
Observation.component:nominal.referenceRange.age.high | required | CommonUCUMCodesForAgehttp://hl7.org/fhir/ValueSet/age-units from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() | |
il-obs-not-performed | error | Observation.dataAbsentReason | dataAbsentReason - if an IL-Core 'not-performed-reason' code is supplied, 'not performed' code MUST be supplied as well : coding.where(system='http://fhir.health.gov.il/cs/il-core-not-performed-reason').exists() implies coding.where(system='http://terminology.hl7.org/CodeSystem/data-absent-reason' and code='not-performed').exists() | |
il-obs-ucum | warning | Observation.value[x]:valueQuantity, Observation.referenceRange.low, Observation.referenceRange.high, Observation.component.value[x]:valueQuantity, Observation.component.referenceRange.low, Observation.component.referenceRange.high, Observation.component:textual.value[x]:valueQuantity, Observation.component:textual.referenceRange.low, Observation.component:textual.referenceRange.high, Observation.component:nominal.value[x]:valueQuantity, Observation.component:nominal.referenceRange.low, Observation.component:nominal.referenceRange.high | SHOULD use UCUM for coded quantity units : system.empty() or system = 'http://unitsofmeasure.org' | |
il-obs-value-cc | warning | Observation.value[x]:valueCodeableConcept, Observation.component.value[x]:valueCodeableConcept, Observation.component:textual.value[x]:valueCodeableConcept, Observation.component:nominal.value[x]:valueCodeableConcept | SHOULD use SNOMED-CT or LOINC Answers for coded results : coding.where(system='http://snomed.info/sct' and code.exists()).exists() OR coding.where(system='http://loinc.org' and code.startsWith('LA')).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() |
This structure is derived from ILCoreObservation
Summary
Mandatory: 14 elements(9 nested mandatory elements)
Fixed: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ILCoreObservation
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | 0..* | ILCoreObservation | ILCore Observation Profile | |||||
identifier | 1..* | Identifier | Business Identifier for observation | |||||
system | 1..1 | uri | The namespace for the identifier value | |||||
value | 1..1 | string | The value that is unique | |||||
basedOn | 0..1 | Reference(Lrc Lab Test Referral) | Fulfills plan, proposal or order | |||||
Slices for category | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:coding | |||||
category:hl7-lab | 1..1 | CodeableConcept | Classification of type of observation | |||||
Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |||||
coding:hl7 | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Laboratory | |||||
system | 1..1 | uri | Identity of the terminology system | |||||
code | 1..1 | code | Symbol in syntax defined by the system | |||||
code | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Lrc Result Codes (extensible)
| |||||
Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | |||||
coding:loinc-lab | 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 | |||||
subject | 0..1 | Reference(ILCore Patient Profile) | Who and/or what the observation is about | |||||
reference | 1..1 | string | Literal reference, Relative, internal or absolute URL | |||||
performer | 1..* | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | CareTeam | ILCore Patient Profile | ILCore RelatedPerson Profile) | Who is responsible for the observation | |||||
Slices for value[x] | Content/Rules for all slices | |||||||
value[x]:valueQuantity | 0..1 | Quantity | Actual result | |||||
system | 1..1 | uri | System that defines coded unit form | |||||
referenceRange | ||||||||
low | 1..1 | SimpleQuantity | Low Range, if relevant Binding: Common UCUM units (required) | |||||
system | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org | |||||
high | 1..1 | SimpleQuantity | High Range, if relevant Binding: Common UCUM units (required) | |||||
system | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org | |||||
Slices for component | 0..* | BackboneElement | Component results Slice: Unordered, Open by value:code | |||||
component:textual | 0..1 | BackboneElement | Component results | |||||
code | ||||||||
coding | 1..* | Coding | Code defined by a terminology system | |||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
code | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 117444000 | |||||
display | 0..1 | string | Representation defined by the system Required Pattern: Text value | |||||
value[x] | 1..1 | string | Actual component result | |||||
Slices for value[x] | Content/Rules for all slices | |||||||
value[x]:valueString | 1..1 | string | Actual component result | |||||
component:nominal | 0..1 | BackboneElement | Component results | |||||
code | ||||||||
coding | 1..* | Coding | Code defined by a terminology system | |||||
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
code | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 117362005 | |||||
display | 0..1 | string | Representation defined by the system Required Pattern: Nominal value | |||||
value[x] | 0..1 | CodeableConcept | Actual component result | |||||
Slices for value[x] | Content/Rules for all slices | |||||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Actual component result | |||||
coding | 1..* | Coding | Code defined by a terminology system | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Observation.code | extensible | LrcResultCodes
http://ig.fhir-il-community.org/LRC/ValueSet/lrc-result-codes from this IG | ||||
Observation.referenceRange.low | required | Common UCUM unitshttp://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard | ||||
Observation.referenceRange.high | required | Common UCUM unitshttp://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | ILCoreObservation | ILCore Observation 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 | ||||
identifier | Σ | 1..* | Identifier | Business Identifier for observation | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
basedOn | Σ | 0..1 | Reference(Lrc Lab Test Referral) | Fulfills plan, proposal or order | ||||
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:coding Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
category:hl7-lab | S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||
coding:hl7 | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Laboratory | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Lrc Result Codes (extensible)
| ||||
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||
coding:loinc-lab | Σ | 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 | ||||
subject | SΣ | 0..1 | Reference(ILCore Patient Profile) | Who and/or what the observation is about | ||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
performer | Σ | 1..* | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | CareTeam | ILCore Patient Profile | ILCore RelatedPerson Profile) | Who is responsible for the observation | ||||
Slices for value[x] | SΣC | 0..1 | Actual result Slice: Unordered, Closed 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 result il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
system | ΣC | 1..1 | uri | System that defines coded unit form | ||||
value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | Actual result Binding: IL Core Observation Value Codes (preferred) il-obs-value-cc: SHOULD use SNOMED-CT or LOINC Answers for coded results | ||||
Slices for component | Σ | 0..* | BackboneElement | Component results Slice: Unordered, Open by value:code | ||||
component:All Slices | Content/Rules for all slices | |||||||
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 | ||||
component:textual | Σ | 0..1 | BackboneElement | Component results | ||||
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) | ||||
coding | Σ | 1..* | Coding | Code defined by a terminology system | ||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 117444000 | ||||
display | Σ | 0..1 | string | Representation defined by the system Required Pattern: Text value | ||||
Slices for value[x] | Σ | 1..1 | string | Actual component result Slice: Unordered, Closed by type:$this | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
value[x]:valueString | Σ | 1..1 | string | Actual component result | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
value[x]:valueQuantity | ΣC | 0..1 | Quantity | Actual component result il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
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 | ||||
component:nominal | Σ | 0..1 | BackboneElement | Component results | ||||
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) | ||||
coding | Σ | 1..* | Coding | Code defined by a terminology system | ||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 117362005 | ||||
display | Σ | 0..1 | string | Representation defined by the system Required Pattern: Nominal value | ||||
Slices for value[x] | Σ | 0..1 | CodeableConcept | Actual component result Slice: Unordered, Closed by type:$this | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
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 | ||||
coding | Σ | 1..* | Coding | Code defined by a terminology system | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
value[x]:valueQuantity | ΣC | 0..1 | Quantity | Actual component result il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Observation.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 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.category:hl7-lab | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.code | extensible | LrcResultCodes
http://ig.fhir-il-community.org/LRC/ValueSet/lrc-result-codes from this IG | ||||
Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
Observation.value[x]:valueCodeableConcept | preferred | ILCoreObservationValuehttp://fhir.health.gov.il/ValueSet/il-core-observation-value | ||||
Observation.component.code | preferred | ILCoreObservationCodehttp://fhir.health.gov.il/ValueSet/il-core-observation-code | ||||
Observation.component.value[x]:valueCodeableConcept | preferred | ILCoreObservationValuehttp://fhir.health.gov.il/ValueSet/il-core-observation-value | ||||
Observation.component:textual.code | preferred | ILCoreObservationCodehttp://fhir.health.gov.il/ValueSet/il-core-observation-code | ||||
Observation.component:textual.value[x]:valueCodeableConcept | preferred | ILCoreObservationValuehttp://fhir.health.gov.il/ValueSet/il-core-observation-value | ||||
Observation.component:nominal.code | preferred | ILCoreObservationCodehttp://fhir.health.gov.il/ValueSet/il-core-observation-code | ||||
Observation.component:nominal.value[x]:valueCodeableConcept | preferred | ILCoreObservationValuehttp://fhir.health.gov.il/ValueSet/il-core-observation-value |
Id | Grade | Path(s) | Details | Requirements |
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() | |
il-obs-ucum | warning | Observation.value[x]:valueQuantity, Observation.component.value[x]:valueQuantity, Observation.component:textual.value[x]:valueQuantity, Observation.component:nominal.value[x]:valueQuantity | SHOULD use UCUM for coded quantity units : system.empty() or system = 'http://unitsofmeasure.org' | |
il-obs-value-cc | warning | Observation.value[x]:valueCodeableConcept, Observation.component.value[x]:valueCodeableConcept, Observation.component:textual.value[x]:valueCodeableConcept, Observation.component:nominal.value[x]:valueCodeableConcept | SHOULD use SNOMED-CT or LOINC Answers for coded results : coding.where(system='http://snomed.info/sct' and code.exists()).exists() OR coding.where(system='http://loinc.org' and code.startsWith('LA')).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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | ILCoreObservation | ILCore Observation 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 | Σ | 1..* | Identifier | Business Identifier for observation | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
basedOn | Σ | 0..1 | Reference(Lrc Lab Test Referral) | Fulfills plan, proposal or order | ||||
partOf | Σ | 0..* | Reference(ILCore MedicationAdministration Profile | ILCore MedicationDispense Profile | ILCore Procedure Profile | ILCore Immunization Profile | ILCore ImagingStudy Profile | ILCore MedicationStatement Profile) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
Slices for category | S | 1..* | CodeableConcept | Classification of type of observation Slice: Unordered, Open by pattern:coding Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
category:hl7-lab | S | 1..1 | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | ||||
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 | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | ||||
coding:hl7 | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: laboratory | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Laboratory | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
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 | ||||
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 | ||||
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Lrc Result Codes (extensible)
| ||||
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 | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||
coding:loinc-lab | Σ | 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 | ||||
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Σ | 0..1 | Reference(ILCore Patient Profile) | Who and/or what the observation is about | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
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 | Σ | 1..* | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | CareTeam | ILCore Patient Profile | ILCore RelatedPerson Profile) | Who is responsible for the observation | ||||
Slices for value[x] | SΣC | 0..1 | Actual result Slice: Unordered, Closed 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 result il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 1..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | Actual 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 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): Codes describing anatomical locations. May include laterality. | |||||
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 | 1..1 | SimpleQuantity | Low Range, if relevant Binding: Common UCUM units (required) il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
high | C | 1..1 | SimpleQuantity | High Range, if relevant Binding: Common UCUM units (required) il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
unit | Σ | 0..1 | string | Unit representation | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
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 | MolecularSequence) | Related measurements the observation is made from | ||||
Slices for component | Σ | 0..* | BackboneElement | Component results Slice: Unordered, Open by value:code | ||||
component:All Slices | Content/Rules for all slices | |||||||
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 | |||||
component:textual | Σ | 0..1 | 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) | ||||
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..* | 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 | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 117444000 | ||||
display | Σ | 0..1 | string | Representation defined by the system Required Pattern: Text value | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
Slices for value[x] | Σ | 1..1 | string | Actual component result Slice: Unordered, Closed by type:$this | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
value[x]:valueString | Σ | 1..1 | string | Actual component result | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
value[x]:valueQuantity | ΣC | 0..1 | Quantity | Actual component result il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
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 | |||||
component:nominal | Σ | 0..1 | 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) | ||||
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..* | 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 | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 117362005 | ||||
display | Σ | 0..1 | string | Representation defined by the system Required Pattern: Nominal value | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
Slices for value[x] | Σ | 0..1 | CodeableConcept | Actual component result Slice: Unordered, Closed by type:$this | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
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 | ||||
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..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
Slices for value[x] | Content/Rules for all slices | |||||||
value[x]:valueQuantity | ΣC | 0..1 | Quantity | Actual component result il-obs-ucum: SHOULD use UCUM for coded quantity units | ||||
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.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Observation.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type 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.category:hl7-lab | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.code | extensible | LrcResultCodes
http://ig.fhir-il-community.org/LRC/ValueSet/lrc-result-codes from this IG | ||||
Observation.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
Observation.value[x]:valueCodeableConcept | preferred | ILCoreObservationValuehttp://fhir.health.gov.il/ValueSet/il-core-observation-value | ||||
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.low | required | Common UCUM unitshttp://hl7.org/fhir/ValueSet/ucum-common from the FHIR Standard | ||||
Observation.referenceRange.high | required | Common UCUM unitshttp://hl7.org/fhir/ValueSet/ucum-common 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 | ||||
Observation.component.value[x]:valueCodeableConcept | preferred | ILCoreObservationValuehttp://fhir.health.gov.il/ValueSet/il-core-observation-value | ||||
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 | ||||
Observation.component:textual.code | preferred | ILCoreObservationCodehttp://fhir.health.gov.il/ValueSet/il-core-observation-code | ||||
Observation.component:textual.value[x]:valueCodeableConcept | preferred | ILCoreObservationValuehttp://fhir.health.gov.il/ValueSet/il-core-observation-value | ||||
Observation.component:textual.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component:textual.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.component:textual.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.component:textual.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.component:textual.referenceRange.age.low | required | CommonUCUMCodesForAgehttp://hl7.org/fhir/ValueSet/age-units from the FHIR Standard | ||||
Observation.component:textual.referenceRange.age.high | required | CommonUCUMCodesForAgehttp://hl7.org/fhir/ValueSet/age-units from the FHIR Standard | ||||
Observation.component:nominal.code | preferred | ILCoreObservationCodehttp://fhir.health.gov.il/ValueSet/il-core-observation-code | ||||
Observation.component:nominal.value[x]:valueCodeableConcept | preferred | ILCoreObservationValuehttp://fhir.health.gov.il/ValueSet/il-core-observation-value | ||||
Observation.component:nominal.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component:nominal.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.component:nominal.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.component:nominal.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.component:nominal.referenceRange.age.low | required | CommonUCUMCodesForAgehttp://hl7.org/fhir/ValueSet/age-units from the FHIR Standard | ||||
Observation.component:nominal.referenceRange.age.high | required | CommonUCUMCodesForAgehttp://hl7.org/fhir/ValueSet/age-units from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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() | |
il-obs-not-performed | error | Observation.dataAbsentReason | dataAbsentReason - if an IL-Core 'not-performed-reason' code is supplied, 'not performed' code MUST be supplied as well : coding.where(system='http://fhir.health.gov.il/cs/il-core-not-performed-reason').exists() implies coding.where(system='http://terminology.hl7.org/CodeSystem/data-absent-reason' and code='not-performed').exists() | |
il-obs-ucum | warning | Observation.value[x]:valueQuantity, Observation.referenceRange.low, Observation.referenceRange.high, Observation.component.value[x]:valueQuantity, Observation.component.referenceRange.low, Observation.component.referenceRange.high, Observation.component:textual.value[x]:valueQuantity, Observation.component:textual.referenceRange.low, Observation.component:textual.referenceRange.high, Observation.component:nominal.value[x]:valueQuantity, Observation.component:nominal.referenceRange.low, Observation.component:nominal.referenceRange.high | SHOULD use UCUM for coded quantity units : system.empty() or system = 'http://unitsofmeasure.org' | |
il-obs-value-cc | warning | Observation.value[x]:valueCodeableConcept, Observation.component.value[x]:valueCodeableConcept, Observation.component:textual.value[x]:valueCodeableConcept, Observation.component:nominal.value[x]:valueCodeableConcept | SHOULD use SNOMED-CT or LOINC Answers for coded results : coding.where(system='http://snomed.info/sct' and code.exists()).exists() OR coding.where(system='http://loinc.org' and code.startsWith('LA')).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() |
This structure is derived from ILCoreObservation
Summary
Mandatory: 14 elements(9 nested mandatory elements)
Fixed: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron