HL7 FHIR Implementation Guide: Military Service History and Status Release 1 - US Realm | STU1, published by Cross Group Projects WG. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-military-service/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/military-service/StructureDefinition/military-service-episode | Version: 1.0.0 | |||
Active as of 2023-05-30 | Computable Name: MilitaryServiceEpisode |
Military Service Episode describes a patient/veterans overall experiences of a militiary employment. The profile references military deployments and occupations as well as military branche, seperation and discharge status. A patient/Veteran may have zero or more military service episodes. The episode documents the time spent in the military organization, the dischage status and reason, and a collection of deployment episodes
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 | Measurements and simple assertions | |
id | 1..1 | id | Logical id of this artifact | |
identifier | 0..1 | Identifier | Business Identifier for observation | |
basedOn | 0..0 | |||
partOf | 0..0 | |||
status | S | 1..1 | code | registered | preliminary | final | amended + |
category | ||||
coding | 0..* | 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: social-history | |
code | S | 1..1 | CodeableConcept | Type of observation (code / type) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
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: 87511-2 | |
subject | S | 1..1 | Reference(US Veteran) | Who and/or what the observation is about |
focus | 0..0 | |||
encounter | 0..0 | |||
effective[x] | 1..1 | Period | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
effectivePeriod | S | 1..1 | Period | Clinically relevant time/time-period for observation |
start | S | 1..1 | dateTime | Starting time with inclusive boundary |
end | S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
issued | 0..0 | |||
performer | 0..0 | |||
dataAbsentReason | 0..0 | |||
interpretation | 0..0 | |||
bodySite | 0..0 | |||
method | 0..0 | |||
specimen | 0..0 | |||
device | 0..0 | |||
referenceRange | 0..0 | |||
Slices for hasMember | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group Slice: Unordered, Open by profile:$this.resolve() | |
hasMember:DeploymentHistoryEpisode | S | 0..* | Reference(Deployment History Episode) | Related resource that belongs to the Observation group |
hasMember:MilitaryOccupation | S | 0..* | Reference(Military Occupation) | Related resource that belongs to the Observation group |
derivedFrom | 0..0 | |||
Slices for component | S | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code |
component:military-service-Military-Branch | 1..1 | BackboneElement | Component results | |
code | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
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: 85104-8 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Compensation and sector employment type | |
value[x] | S | 1..1 | CodeableConcept | Actual component result Slice: Unordered, Open by type:$this |
valueCodeableConcept | 1..1 | CodeableConcept | Actual component result Binding: Military Branch Value Set (extensible) | |
component:military-service-DischargeStatus | 0..1 | BackboneElement | Component results | |
code | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/military-service/CodeSystem/military-service-code-system | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 9B7095A70B024CD789A36E48A3936592 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Discharge Status | |
value[x] | 1..1 | CodeableConcept | Actual component result Slice: Unordered, Open by type:$this | |
valueCodeableConcept | S | 1..1 | CodeableConcept | Actual component result Binding: Discharge Status Value Set (extensible) |
component:military-service-SeparationReason | 0..1 | BackboneElement | Component results | |
code | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/military-service/CodeSystem/military-service-code-system | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 9CEAD6537D6A4F198549F70598B8F8BF | |
display | 1..1 | string | Representation defined by the system Fixed Value: Separation Reason | |
value[x] | 0..1 | CodeableConcept | Actual component result Slice: Unordered, Open by type:$this | |
valueCodeableConcept | S | 0..1 | CodeableConcept | Actual component result Binding: Separation Reason Value Set (extensible) |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.component:military-service-Military-Branch.valueCodeableConcept | extensible | MilitaryBranchVS |
Observation.component:military-service-DischargeStatus.valueCodeableConcept | extensible | DischargeStatusVS |
Observation.component:military-service-SeparationReason.valueCodeableConcept | extensible | SeparationReasonVS |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions |
id | Σ | 1..1 | id | Logical id of this artifact |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..1 | Identifier | Business Identifier for observation |
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
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: 87511-2 | |
subject | SΣ | 1..1 | Reference(US Veteran) | Who and/or what the observation is about |
Slices for effective[x] | Σ | 1..1 | Period | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this |
effective[x]:effectivePeriod | SΣ | 1..1 | Period | Clinically relevant time/time-period for observation |
start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary |
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
Slices for hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group Slice: Unordered, Open by profile:$this.resolve() |
hasMember:DeploymentHistoryEpisode | SΣ | 0..* | Reference(Deployment History Episode) | Related resource that belongs to the Observation group |
hasMember:MilitaryOccupation | SΣ | 0..* | Reference(Military Occupation) | Related resource that belongs to the Observation group |
Slices for component | SΣ | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern: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: LOINCCodes (example): Codes identifying names of simple observations. |
component:military-service-Military-Branch | Σ | 1..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: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
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: 85104-8 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Compensation and sector employment type | |
Slices for value[x] | SΣ | 1..1 | CodeableConcept | Actual component result Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | Σ | 1..1 | CodeableConcept | Actual component result Binding: Military Branch Value Set (extensible) |
component:military-service-DischargeStatus | Σ | 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: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/military-service/CodeSystem/military-service-code-system | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 9B7095A70B024CD789A36E48A3936592 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Discharge Status | |
Slices for value[x] | Σ | 1..1 | CodeableConcept | Actual component result Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | SΣ | 1..1 | CodeableConcept | Actual component result Binding: Discharge Status Value Set (extensible) |
component:military-service-SeparationReason | Σ | 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: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/military-service/CodeSystem/military-service-code-system | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 9CEAD6537D6A4F198549F70598B8F8BF | |
display | 1..1 | string | Representation defined by the system Fixed Value: Separation Reason | |
Slices for value[x] | Σ | 0..1 | CodeableConcept | Actual component result Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | SΣ | 0..1 | CodeableConcept | Actual component result Binding: Separation Reason Value Set (extensible) |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Observation.status | required | ObservationStatus |
Observation.code | example | Pattern: LOINC code 87511-2 |
Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
Observation.component:military-service-Military-Branch.code | example | Pattern: LOINC code 85104-8("Compensation and sector employment type") |
Observation.component:military-service-Military-Branch.value[x]:valueCodeableConcept | extensible | MilitaryBranchVS |
Observation.component:military-service-DischargeStatus.code | example | Pattern: 9B7095A70B024CD789A36E48A3936592("Discharge Status") |
Observation.component:military-service-DischargeStatus.value[x]:valueCodeableConcept | extensible | DischargeStatusVS |
Observation.component:military-service-SeparationReason.code | example | Pattern: 9CEAD6537D6A4F198549F70598B8F8BF("Separation Reason") |
Observation.component:military-service-SeparationReason.value[x]:valueCodeableConcept | extensible | SeparationReasonVS |
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 | Measurements and simple assertions | ||||
id | Σ | 1..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..1 | Identifier | Business Identifier for observation | ||||
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
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 | Σ | 0..* | 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: 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 | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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://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: 87511-2 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
subject | SΣ | 1..1 | Reference(US Veteran) | Who and/or what the observation is about | ||||
Slices for effective[x] | Σ | 1..1 | Period | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this | ||||
effective[x]:effectivePeriod | SΣ | 1..1 | Period | Clinically relevant time/time-period 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 | |||||
start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
value[x] | ΣC | 0..1 | Actual result | |||||
valueQuantity | Quantity | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueString | string | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueSampledData | SampledData | |||||||
valueTime | time | |||||||
valueDateTime | dateTime | |||||||
valuePeriod | Period | |||||||
note | 0..* | Annotation | Comments about the observation | |||||
Slices for hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group Slice: Unordered, Open by profile:$this.resolve() | ||||
hasMember:DeploymentHistoryEpisode | SΣ | 0..* | Reference(Deployment History Episode) | Related resource that belongs to the Observation group | ||||
hasMember:MilitaryOccupation | SΣ | 0..* | Reference(Military Occupation) | Related resource that belongs to the Observation group | ||||
Slices for component | SΣ | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern: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: LOINCCodes (example): Codes identifying names of simple observations. | ||||
value[x] | Σ | 0..1 | Actual component result | |||||
valueQuantity | Quantity | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueString | string | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueSampledData | SampledData | |||||||
valueTime | time | |||||||
valueDateTime | dateTime | |||||||
valuePeriod | Period | |||||||
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..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
component:military-service-Military-Branch | Σ | 1..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: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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://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: 85104-8 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Compensation and sector employment type | |||||
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] | SΣ | 1..1 | CodeableConcept | Actual component result Slice: Unordered, Closed by type:$this | ||||
value[x]:valueCodeableConcept | Σ | 1..1 | CodeableConcept | Actual component result Binding: Military Branch Value Set (extensible) | ||||
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..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
component:military-service-DischargeStatus | Σ | 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: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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://hl7.org/fhir/us/military-service/CodeSystem/military-service-code-system | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 9B7095A70B024CD789A36E48A3936592 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Discharge Status | |||||
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 | CodeableConcept | Actual component result Slice: Unordered, Closed by type:$this | ||||
value[x]:valueCodeableConcept | SΣ | 1..1 | CodeableConcept | Actual component result Binding: Discharge Status Value Set (extensible) | ||||
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..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
component:military-service-SeparationReason | Σ | 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: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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://hl7.org/fhir/us/military-service/CodeSystem/military-service-code-system | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 9CEAD6537D6A4F198549F70598B8F8BF | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Separation Reason | |||||
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 | ||||
value[x]:valueCodeableConcept | SΣ | 0..1 | CodeableConcept | Actual component result Binding: Separation Reason Value Set (extensible) | ||||
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..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Observation.language | preferred | CommonLanguages
| ||||
Observation.status | required | ObservationStatus | ||||
Observation.category | preferred | ObservationCategoryCodes | ||||
Observation.code | example | Pattern: LOINC code 87511-2 | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.component:military-service-Military-Branch.code | example | Pattern: LOINC code 85104-8("Compensation and sector employment type") | ||||
Observation.component:military-service-Military-Branch.value[x]:valueCodeableConcept | extensible | MilitaryBranchVS | ||||
Observation.component:military-service-Military-Branch.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component:military-service-Military-Branch.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.component:military-service-DischargeStatus.code | example | Pattern: 9B7095A70B024CD789A36E48A3936592("Discharge Status") | ||||
Observation.component:military-service-DischargeStatus.value[x]:valueCodeableConcept | extensible | DischargeStatusVS | ||||
Observation.component:military-service-DischargeStatus.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component:military-service-DischargeStatus.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.component:military-service-SeparationReason.code | example | Pattern: 9CEAD6537D6A4F198549F70598B8F8BF("Separation Reason") | ||||
Observation.component:military-service-SeparationReason.value[x]:valueCodeableConcept | extensible | SeparationReasonVS | ||||
Observation.component:military-service-SeparationReason.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component:military-service-SeparationReason.interpretation | extensible | ObservationInterpretationCodes |
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: 9 elements (2 nested mandatory elements)
Must-Support: 12 elements
Prohibited: 14 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 | Measurements and simple assertions | |
id | 1..1 | id | Logical id of this artifact | |
identifier | 0..1 | Identifier | Business Identifier for observation | |
basedOn | 0..0 | |||
partOf | 0..0 | |||
status | S | 1..1 | code | registered | preliminary | final | amended + |
category | ||||
coding | 0..* | 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: social-history | |
code | S | 1..1 | CodeableConcept | Type of observation (code / type) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
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: 87511-2 | |
subject | S | 1..1 | Reference(US Veteran) | Who and/or what the observation is about |
focus | 0..0 | |||
encounter | 0..0 | |||
effective[x] | 1..1 | Period | Clinically relevant time/time-period for observation Slice: Unordered, Open by type:$this | |
effectivePeriod | S | 1..1 | Period | Clinically relevant time/time-period for observation |
start | S | 1..1 | dateTime | Starting time with inclusive boundary |
end | S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
issued | 0..0 | |||
performer | 0..0 | |||
dataAbsentReason | 0..0 | |||
interpretation | 0..0 | |||
bodySite | 0..0 | |||
method | 0..0 | |||
specimen | 0..0 | |||
device | 0..0 | |||
referenceRange | 0..0 | |||
Slices for hasMember | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group Slice: Unordered, Open by profile:$this.resolve() | |
hasMember:DeploymentHistoryEpisode | S | 0..* | Reference(Deployment History Episode) | Related resource that belongs to the Observation group |
hasMember:MilitaryOccupation | S | 0..* | Reference(Military Occupation) | Related resource that belongs to the Observation group |
derivedFrom | 0..0 | |||
Slices for component | S | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code |
component:military-service-Military-Branch | 1..1 | BackboneElement | Component results | |
code | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
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: 85104-8 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Compensation and sector employment type | |
value[x] | S | 1..1 | CodeableConcept | Actual component result Slice: Unordered, Open by type:$this |
valueCodeableConcept | 1..1 | CodeableConcept | Actual component result Binding: Military Branch Value Set (extensible) | |
component:military-service-DischargeStatus | 0..1 | BackboneElement | Component results | |
code | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/military-service/CodeSystem/military-service-code-system | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 9B7095A70B024CD789A36E48A3936592 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Discharge Status | |
value[x] | 1..1 | CodeableConcept | Actual component result Slice: Unordered, Open by type:$this | |
valueCodeableConcept | S | 1..1 | CodeableConcept | Actual component result Binding: Discharge Status Value Set (extensible) |
component:military-service-SeparationReason | 0..1 | BackboneElement | Component results | |
code | 1..1 | CodeableConcept | Type of component observation (code / type) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/military-service/CodeSystem/military-service-code-system | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 9CEAD6537D6A4F198549F70598B8F8BF | |
display | 1..1 | string | Representation defined by the system Fixed Value: Separation Reason | |
value[x] | 0..1 | CodeableConcept | Actual component result Slice: Unordered, Open by type:$this | |
valueCodeableConcept | S | 0..1 | CodeableConcept | Actual component result Binding: Separation Reason Value Set (extensible) |
Documentation for this format |
Path | Conformance | ValueSet |
Observation.component:military-service-Military-Branch.valueCodeableConcept | extensible | MilitaryBranchVS |
Observation.component:military-service-DischargeStatus.valueCodeableConcept | extensible | DischargeStatusVS |
Observation.component:military-service-SeparationReason.valueCodeableConcept | extensible | SeparationReasonVS |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions |
id | Σ | 1..1 | id | Logical id of this artifact |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..1 | Identifier | Business Identifier for observation |
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
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: 87511-2 | |
subject | SΣ | 1..1 | Reference(US Veteran) | Who and/or what the observation is about |
Slices for effective[x] | Σ | 1..1 | Period | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this |
effective[x]:effectivePeriod | SΣ | 1..1 | Period | Clinically relevant time/time-period for observation |
start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary |
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
Slices for hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group Slice: Unordered, Open by profile:$this.resolve() |
hasMember:DeploymentHistoryEpisode | SΣ | 0..* | Reference(Deployment History Episode) | Related resource that belongs to the Observation group |
hasMember:MilitaryOccupation | SΣ | 0..* | Reference(Military Occupation) | Related resource that belongs to the Observation group |
Slices for component | SΣ | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern: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: LOINCCodes (example): Codes identifying names of simple observations. |
component:military-service-Military-Branch | Σ | 1..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: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
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: 85104-8 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Compensation and sector employment type | |
Slices for value[x] | SΣ | 1..1 | CodeableConcept | Actual component result Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | Σ | 1..1 | CodeableConcept | Actual component result Binding: Military Branch Value Set (extensible) |
component:military-service-DischargeStatus | Σ | 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: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/military-service/CodeSystem/military-service-code-system | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 9B7095A70B024CD789A36E48A3936592 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Discharge Status | |
Slices for value[x] | Σ | 1..1 | CodeableConcept | Actual component result Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | SΣ | 1..1 | CodeableConcept | Actual component result Binding: Discharge Status Value Set (extensible) |
component:military-service-SeparationReason | Σ | 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: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/military-service/CodeSystem/military-service-code-system | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 9CEAD6537D6A4F198549F70598B8F8BF | |
display | 1..1 | string | Representation defined by the system Fixed Value: Separation Reason | |
Slices for value[x] | Σ | 0..1 | CodeableConcept | Actual component result Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | SΣ | 0..1 | CodeableConcept | Actual component result Binding: Separation Reason Value Set (extensible) |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Observation.status | required | ObservationStatus |
Observation.code | example | Pattern: LOINC code 87511-2 |
Observation.component.code | example | LOINCCodes (a valid code from LOINC) |
Observation.component:military-service-Military-Branch.code | example | Pattern: LOINC code 85104-8("Compensation and sector employment type") |
Observation.component:military-service-Military-Branch.value[x]:valueCodeableConcept | extensible | MilitaryBranchVS |
Observation.component:military-service-DischargeStatus.code | example | Pattern: 9B7095A70B024CD789A36E48A3936592("Discharge Status") |
Observation.component:military-service-DischargeStatus.value[x]:valueCodeableConcept | extensible | DischargeStatusVS |
Observation.component:military-service-SeparationReason.code | example | Pattern: 9CEAD6537D6A4F198549F70598B8F8BF("Separation Reason") |
Observation.component:military-service-SeparationReason.value[x]:valueCodeableConcept | extensible | SeparationReasonVS |
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 | Measurements and simple assertions | ||||
id | Σ | 1..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..1 | Identifier | Business Identifier for observation | ||||
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
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 | Σ | 0..* | 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: 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 | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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://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: 87511-2 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
subject | SΣ | 1..1 | Reference(US Veteran) | Who and/or what the observation is about | ||||
Slices for effective[x] | Σ | 1..1 | Period | Clinically relevant time/time-period for observation Slice: Unordered, Closed by type:$this | ||||
effective[x]:effectivePeriod | SΣ | 1..1 | Period | Clinically relevant time/time-period 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 | |||||
start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
value[x] | ΣC | 0..1 | Actual result | |||||
valueQuantity | Quantity | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueString | string | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueSampledData | SampledData | |||||||
valueTime | time | |||||||
valueDateTime | dateTime | |||||||
valuePeriod | Period | |||||||
note | 0..* | Annotation | Comments about the observation | |||||
Slices for hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group Slice: Unordered, Open by profile:$this.resolve() | ||||
hasMember:DeploymentHistoryEpisode | SΣ | 0..* | Reference(Deployment History Episode) | Related resource that belongs to the Observation group | ||||
hasMember:MilitaryOccupation | SΣ | 0..* | Reference(Military Occupation) | Related resource that belongs to the Observation group | ||||
Slices for component | SΣ | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern: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: LOINCCodes (example): Codes identifying names of simple observations. | ||||
value[x] | Σ | 0..1 | Actual component result | |||||
valueQuantity | Quantity | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueString | string | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueSampledData | SampledData | |||||||
valueTime | time | |||||||
valueDateTime | dateTime | |||||||
valuePeriod | Period | |||||||
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..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
component:military-service-Military-Branch | Σ | 1..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: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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://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: 85104-8 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Compensation and sector employment type | |||||
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] | SΣ | 1..1 | CodeableConcept | Actual component result Slice: Unordered, Closed by type:$this | ||||
value[x]:valueCodeableConcept | Σ | 1..1 | CodeableConcept | Actual component result Binding: Military Branch Value Set (extensible) | ||||
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..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
component:military-service-DischargeStatus | Σ | 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: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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://hl7.org/fhir/us/military-service/CodeSystem/military-service-code-system | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 9B7095A70B024CD789A36E48A3936592 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Discharge Status | |||||
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 | CodeableConcept | Actual component result Slice: Unordered, Closed by type:$this | ||||
value[x]:valueCodeableConcept | SΣ | 1..1 | CodeableConcept | Actual component result Binding: Discharge Status Value Set (extensible) | ||||
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..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
component:military-service-SeparationReason | Σ | 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: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
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://hl7.org/fhir/us/military-service/CodeSystem/military-service-code-system | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 9CEAD6537D6A4F198549F70598B8F8BF | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Separation Reason | |||||
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 | ||||
value[x]:valueCodeableConcept | SΣ | 0..1 | CodeableConcept | Actual component result Binding: Separation Reason Value Set (extensible) | ||||
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..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Observation.language | preferred | CommonLanguages
| ||||
Observation.status | required | ObservationStatus | ||||
Observation.category | preferred | ObservationCategoryCodes | ||||
Observation.code | example | Pattern: LOINC code 87511-2 | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes | ||||
Observation.component.code | example | LOINCCodes (a valid code from LOINC) | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.component:military-service-Military-Branch.code | example | Pattern: LOINC code 85104-8("Compensation and sector employment type") | ||||
Observation.component:military-service-Military-Branch.value[x]:valueCodeableConcept | extensible | MilitaryBranchVS | ||||
Observation.component:military-service-Military-Branch.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component:military-service-Military-Branch.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.component:military-service-DischargeStatus.code | example | Pattern: 9B7095A70B024CD789A36E48A3936592("Discharge Status") | ||||
Observation.component:military-service-DischargeStatus.value[x]:valueCodeableConcept | extensible | DischargeStatusVS | ||||
Observation.component:military-service-DischargeStatus.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component:military-service-DischargeStatus.interpretation | extensible | ObservationInterpretationCodes | ||||
Observation.component:military-service-SeparationReason.code | example | Pattern: 9CEAD6537D6A4F198549F70598B8F8BF("Separation Reason") | ||||
Observation.component:military-service-SeparationReason.value[x]:valueCodeableConcept | extensible | SeparationReasonVS | ||||
Observation.component:military-service-SeparationReason.dataAbsentReason | extensible | DataAbsentReason | ||||
Observation.component:military-service-SeparationReason.interpretation | extensible | ObservationInterpretationCodes |
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: 9 elements (2 nested mandatory elements)
Must-Support: 12 elements
Prohibited: 14 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron