HL7 FHIR Implementation Guide: Military Service History and Status Release 1 - US Realm | STU1 Ballot
0.1.0 - STU1 Ballot

This page is part of the HL7 FHIR Implementation Guide for Military Service History and Status (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide

Veteran Status Verification and Confirmation - Operation

The Veteran Status Operation returns ‘true’ or ‘false’ based on the known veteran status of the patient. The API should be used as part of use cases needing general veteran status and not neccesarily be used as part of eligibilty.

Structures: Abstract Profiles

These are profiles on resources or data types that describe patterns used by other profiles, but cannot be instantiated directly. I.e. instances can conform to profiles based on these abstract profiles, but do not declare conformance to the abstract profiles themselves.

Employment History Episode

Employment history consists of a series Employment Episodes. In the past these episodes have been represented as Z-segments and added to various transactions to support social history determination, benefit, etc. This profile is intended to represent employment history for International use and it may be localized by HL7, IHE, and other profile developers. The Employment Episode profile of is the base profile for Military Service Episode profile and ODH Past or Present Job profile and other profiles intended to describe specific types of employment. This profile is marked as ‘constrainable’ because it’s intended to be reused to create additional profile, more specific, or localized to jurisdiction.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide

Deployment Episode

This profile definition similar to Combat Zone Period profile (url: http://hl7.org/fhir/us/odh/StructureDefinition/odh-CombatZonePeriod ) and includes the requirements specified in ZMH and Deployment Schema. The base profile reuses the pattern Combat Zone Period profilee and adds new components. However, since it’s intended to share ‘deployment’ information this profile is more generic that the specifics ODH.

Military Occupation

The profile is intended to reusee ODH PastOrPresentJob profile to apply it specifically to military jobs/occupations. The observation resource that conforms to this specification is referenced by Military Service Episode. However, due to tooling issues this profile is uses the abstract, base profile [Employment History Episode] (StructureDefinition-odh-EmploymentHistoryEpisode). A veteran may have several occupation during a single service episode.

Military Service Episode

A patient/Veteran may have zero or more military service episodes. The contents of this profile is based on the HL7 Version 2 ZMH segment and the ServiceHistoryEpisode schema specified in the current Veteran Verification API and it allows this API to migrate to FHIR and to be consistent with the prior work done by Center for Disease Control (CDC) National Institute for Occupational Safety and Health (NIOSH). A service history episode may reference zero or more Combat episodes. This profile is based on the default FHIR Observation profile but may reuse ODD Past or Present Job profile ( http://hl.org/fhir/us/odh/StructureDefinition-odh-PastOrPresentJob.html).

US Veteran

US Veteran whose veteran status was confirmed or is about to be confirmed. This profile extends US Core Patient profile and includes a [‘US Veteran Status’] (usveteranstatus) extension to hold additional coded or boolean information about the veteran status. This version of the profile specifies a boolean value but it’s conceivable that pilot implementaiton may decide to support more that one status to match the veteran verification state machine.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide

us-veteran-status

us-veteran-status is a boolean extension used to specify whether a patient was confirmed or verified to have Veteran status.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide

Combat Episode Mission Value Set

Example combat mission code; this is only an example data element that may be associated with a Deployment Episode, if needed.

Deployment Episode Type Value Set

Recommended deployment episeod type code - only the root concept of ‘Deployment Episode’ is needed for typical implementations.

Discharge Status Value Set

Discharge Status Value Set - this valuse set identifies gaps in SNOMED CT. The only concept currenty supported is that of ‘dishornorable’ discharge.

Military Branch Value Set

Military Branch Value Set - is a subset of the ODH Occupation value set.

Military Occupation Value Set

Military Occupation Value Set

Pay Grade Code Value Set

Pay Grade Code Value Set - is a subset of the OHD Supervisory Role value set. Its scope is limited to miliatry pay grade codes.

Separation Reason Value Set

Separation Reason Value Set contains concepts that are managed as a local extenions, subject to sumission to SNOMED CT.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide

SOLOR Military Service History and Status

Temporary extension holding concepts needed for this IG but no available in SNOMED and LOINC. https://logica.atlassian.net/wiki/spaces/SOLOR/pages/865271876/Military+Service+History+and+Status This coding system is represented as a local value set but it may be replaced to CodeSysten resource in the future. Reference: https://www.logicahealth.org/solutions/solor

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like

DeploymentEpisode3

DeploymentEpisode Example

DeploymentEpisode1

Deployment to Afghanistan

DeploymentEpisode2

Deployment to Iraq

MilitaryServiceEpisode1

Military Service

sam-share-ssgt-veteran

Sam Share: Veteran’s patient record