HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1, STU 1.3 (Standard for Trial Use)
1.3.0 - STU 1.3
HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1, STU 1.3 (Standard for Trial Use)
1.3.0 - STU 1.3
This page is part of the Occupational Data for Health (ODH) FHIR IG (v1.3.0: STU 1.3 on FHIR R4) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/us/odh/StructureDefinition/odh-RetirementDate | Version: 1.3.0 | |||
| Active as of 2020-01-04 | Computable Name: RetirementDate | |||
Copyright/Legal: ©2020+ HL7 International Public Health Work Group. Package hl7.fhir.us.odh#1.0.0 based on FHIR 4.0.1. Generated 2020-01-08. Links: Home | QA Report | Search | Version History external | CC0 external | Propose a change external |
||||
A Date of Retirement Observation is a clinical statement about a self-reported date (at least year) that a person considers themselves to have ‘retired’. If present, the person has retired. A person can be both retired and employed; most often, a person would be retired from one job and employed in another job.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | 0..* | Observation | Retirement Date | |
  basedOn | 0..* | Reference(ServiceRequest) | The plan, proposal or order that is fulfilled in whole or in part by this observation | |
| partOf | 0..* | Reference(Procedure) | The larger procedure that this particular observation is a component or step | |
  category | 0..1 | CodeableConcept | Classification of type of observation | |
   Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | |
   coding:Fixed_social-history | Σ | 1..1 | Coding | Social History |
 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: social-history | |
| code | 1..1 | CodeableConcept | Type of observation (code / type) | |
| Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | |
| coding:Fixed_87510-4 | Σ | 1..1 | Coding | Date of Retirement |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 87510-4 | |
| subject | 1..1 | Reference(US Core Patient Profile) | The subject of an observation | |
| focus | 0..0 | |||
 effective[x] | 0..0 | |||
| performer | 0..* | Reference(Practitioner | Organization | US Core Patient Profile | RelatedPerson) | Who is responsible for the observation | |
 valueDateTime | 0..1 | dateTime | Actual result | |
| dataAbsentReason | 0..0 | |||
| interpretation | 0..1 | CodeableConcept | High, low, normal, etc. | |
| bodySite | 0..0 | |||
| method | 0..0 | |||
| specimen | 0..0 | |||
| device | 0..0 | |||
| referenceRange | 0..0 | |||
| hasMember | 0..0 | |||
| derivedFrom | 0..* | Reference(DocumentReference | Media | QuestionnaireResponse | Observation) | Related measurements the observation is made from | |
 component | 0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
| Observation.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
| Observation.component.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
| Observation.component.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | Observation | Retirement Date |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| basedOn | Σ | 0..* | Reference(ServiceRequest) | The plan, proposal or order that is fulfilled in whole or in part by this observation |
| partOf | Σ | 0..* | Reference(Procedure) | The larger procedure that this particular observation is a component or step |
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
 category | 0..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 value:code |
| coding:Fixed_social-history | Σ | 1..1 | Coding | Social History |
| 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: social-history |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code |
| coding:Fixed_87510-4 | Σ | 1..1 | Coding | Date of Retirement |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 87510-4 |
| subject | Σ | 1..1 | Reference(US Core Patient Profile) | The subject of an observation |
| performer | Σ | 0..* | Reference(Practitioner | Organization | US Core Patient Profile | RelatedPerson) | Who is responsible for the observation |
| Slices for value[x] | ΣC | 0..1 | Actual 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]:valueDateTime | ΣC | 0..1 | dateTime | Actual result |
| interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
| derivedFrom | Σ | 0..* | Reference(DocumentReference | Media | QuestionnaireResponse | Observation) | Related measurements the observation is made from |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.status | required | ObservationStatus |
| Observation.category | preferred | ObservationCategoryCodes |
| Observation.code | example | LOINCCodes (a valid code from LOINC) |
| Observation.interpretation | extensible | ObservationInterpretationCodes |
| Observation.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
| Observation.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
| Observation.component.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
| Observation.component.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
| 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() | |
| 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..* | Observation | Retirement Date | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
| basedOn | Σ | 0..* | Reference(ServiceRequest) | The plan, proposal or order that is fulfilled in whole or in part by this observation | ||||
| partOf | Σ | 0..* | Reference(Procedure) | The larger procedure that this particular observation is a component or step | ||||
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| category | 0..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 value:code | ||||
| coding:Fixed_social-history | Σ | 1..1 | Coding | Social History | ||||
| 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://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: social-history | ||||
| 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 | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| 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:code | ||||
| coding:Fixed_87510-4 | Σ | 1..1 | Coding | Date of Retirement | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 87510-4 | ||||
| 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 | Σ | 1..1 | Reference(US Core Patient Profile) | The subject of an observation | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer | Σ | 0..* | Reference(Practitioner | Organization | US Core Patient Profile | RelatedPerson) | Who is responsible for the observation | ||||
| Slices for value[x] | ΣC | 0..1 | Actual 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]:valueDateTime | ΣC | 0..1 | dateTime | Actual result | ||||
| interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note | 0..* | Annotation | Comments about the observation | |||||
| derivedFrom | Σ | 0..* | Reference(DocumentReference | Media | QuestionnaireResponse | Observation) | Related measurements the observation is made from | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Observation.language | preferred | CommonLanguages
| ||||
| Observation.status | required | ObservationStatus | ||||
| Observation.category | preferred | ObservationCategoryCodes | ||||
| Observation.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes | ||||
| Observation.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes | ||||
| Observation.component.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from Observation
Summary
Mandatory: 5 elements (4 nested mandatory elements)
Fixed Value: 4 elements
Prohibited: 10 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 0..* | Observation | Retirement Date | |
| basedOn | 0..* | Reference(ServiceRequest) | The plan, proposal or order that is fulfilled in whole or in part by this observation | |
| partOf | 0..* | Reference(Procedure) | The larger procedure that this particular observation is a component or step | |
| category | 0..1 | CodeableConcept | Classification of type of observation | |
| Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | |
| coding:Fixed_social-history | Σ | 1..1 | Coding | Social History |
| 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: social-history | |
| code | 1..1 | CodeableConcept | Type of observation (code / type) | |
| Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | |
| coding:Fixed_87510-4 | Σ | 1..1 | Coding | Date of Retirement |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 87510-4 | |
| subject | 1..1 | Reference(US Core Patient Profile) | The subject of an observation | |
| focus | 0..0 | |||
| effective[x] | 0..0 | |||
| performer | 0..* | Reference(Practitioner | Organization | US Core Patient Profile | RelatedPerson) | Who is responsible for the observation | |
| valueDateTime | 0..1 | dateTime | Actual result | |
| dataAbsentReason | 0..0 | |||
| interpretation | 0..1 | CodeableConcept | High, low, normal, etc. | |
| bodySite | 0..0 | |||
| method | 0..0 | |||
| specimen | 0..0 | |||
| device | 0..0 | |||
| referenceRange | 0..0 | |||
| hasMember | 0..0 | |||
| derivedFrom | 0..* | Reference(DocumentReference | Media | QuestionnaireResponse | Observation) | Related measurements the observation is made from | |
| component | 0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
| Observation.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
| Observation.component.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
| Observation.component.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | Observation | Retirement Date |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| basedOn | Σ | 0..* | Reference(ServiceRequest) | The plan, proposal or order that is fulfilled in whole or in part by this observation |
| partOf | Σ | 0..* | Reference(Procedure) | The larger procedure that this particular observation is a component or step |
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| category | 0..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 value:code |
| coding:Fixed_social-history | Σ | 1..1 | Coding | Social History |
| 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: social-history |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. |
| Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code |
| coding:Fixed_87510-4 | Σ | 1..1 | Coding | Date of Retirement |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 87510-4 |
| subject | Σ | 1..1 | Reference(US Core Patient Profile) | The subject of an observation |
| performer | Σ | 0..* | Reference(Practitioner | Organization | US Core Patient Profile | RelatedPerson) | Who is responsible for the observation |
| Slices for value[x] | ΣC | 0..1 | Actual 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]:valueDateTime | ΣC | 0..1 | dateTime | Actual result |
| interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |
| derivedFrom | Σ | 0..* | Reference(DocumentReference | Media | QuestionnaireResponse | Observation) | Related measurements the observation is made from |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Observation.status | required | ObservationStatus |
| Observation.category | preferred | ObservationCategoryCodes |
| Observation.code | example | LOINCCodes (a valid code from LOINC) |
| Observation.interpretation | extensible | ObservationInterpretationCodes |
| Observation.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
| Observation.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
| Observation.component.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes |
| Observation.component.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
| 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() | |
| 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..* | Observation | Retirement Date | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
| basedOn | Σ | 0..* | Reference(ServiceRequest) | The plan, proposal or order that is fulfilled in whole or in part by this observation | ||||
| partOf | Σ | 0..* | Reference(Procedure) | The larger procedure that this particular observation is a component or step | ||||
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| category | 0..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 value:code | ||||
| coding:Fixed_social-history | Σ | 1..1 | Coding | Social History | ||||
| 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://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: social-history | ||||
| 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 | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. | ||||
| 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:code | ||||
| coding:Fixed_87510-4 | Σ | 1..1 | Coding | Date of Retirement | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 87510-4 | ||||
| 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 | Σ | 1..1 | Reference(US Core Patient Profile) | The subject of an observation | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer | Σ | 0..* | Reference(Practitioner | Organization | US Core Patient Profile | RelatedPerson) | Who is responsible for the observation | ||||
| Slices for value[x] | ΣC | 0..1 | Actual 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]:valueDateTime | ΣC | 0..1 | dateTime | Actual result | ||||
| interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note | 0..* | Annotation | Comments about the observation | |||||
| derivedFrom | Σ | 0..* | Reference(DocumentReference | Media | QuestionnaireResponse | Observation) | Related measurements the observation is made from | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Observation.language | preferred | CommonLanguages
| ||||
| Observation.status | required | ObservationStatus | ||||
| Observation.category | preferred | ObservationCategoryCodes | ||||
| Observation.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes | ||||
| Observation.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes | ||||
| Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodes | ||||
| Observation.component.referenceRange.type | extensible | ObservationReferenceRangeMeaningCodes | ||||
| Observation.component.referenceRange.appliesTo | extensible | ObservationReferenceRangeAppliesToCodes |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from Observation
Summary
Mandatory: 5 elements (4 nested mandatory elements)
Fixed Value: 4 elements
Prohibited: 10 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International Public Health Work Group. Package hl7.fhir.us.odh#1.3.0 based on FHIR 4.0.1. Generated 2023-03-27
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change