Skip to content

Commit

Permalink
Merge pull request #475 from CDCgov/DoD-290-IG_create_orm_message_def…
Browse files Browse the repository at this point in the history 
…inition_for_guide

Create ORM Use Case Skeleton for Implementation Guide
  • Loading branch information
@tjohnson7021
tjohnson7021 authored Aug 22, 2023
2 parents 4ad84ba + 493a414 commit 962862e
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 17 deletions.
34 changes: 17 additions & 17 deletions ig/input/fsh/logical-adt-01.fsh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ Id: segment-msh-logical-model
Title: "MSH Segment"
Description: "The MSH Segment"
* segmentType 1..1 SU string "MSH"
* delimeters 1..1 SU string "The delimeters for the message"
* sendingApplication 1..1 SU string "The sending application"
* sendingFacility 1..1 SU string "The sending facility"
* receivingApplication 1..1 SU string "The receiving application"
* receivingFacility 1..1 SU string "The receiving facility"
* messageDateTime 1..1 SU string "The date and time the message was created"
* delimeters 1..1 SU string "MSH-1 The delimeters for the message"
* sendingApplication 1..1 SU string "MSH-3 The sending application"
* sendingFacility 1..1 SU string "MSH-4 The sending facility"
* receivingApplication 1..1 SU string "MSH-5 The receiving application"
* receivingFacility 1..1 SU string "MSH-6 The receiving facility"
* messageDateTime 1..1 SU string "MSH-7 The date and time the message was created"
* security 0..1 SU string "indicates if security features should be followed"
* messageType 1..1 SU string "The type of message"
* messageControlId 1..1 SU string "a control id for the message"
* processingId 1..1 SU string "the processing id"
* versionId 1..1 SU string "the HL7 version of this message"
* messageType 1..1 SU string "MSH-9 The type of message"
* messageControlId 1..1 SU string "MSH-10 a control id for the message"
* processingId 1..1 SU string "MSH-11 the processing id"
* versionId 1..1 SU string "MSH-12 the HL7 version of this message"
// there are other optional fields we might want to define

Logical: EVNSegment
Expand All @@ -41,17 +41,17 @@ Id: segment-pid-logical-model
Title: "PID Segment"
Description: "The PID Segment"
* segmentType 1..1 SU string "PID"
* setId 1..1 SU string "a sequence number"
* setId 1..1 SU string "PID-1 a sequence number"
* patientId 0..1 SU string "a patient id (retained for backward compatibility, but should be blank"
* patientIdList 1..1 SU string "a list of patient identifiers"
* patientIdList 1..1 SU string "PID-3 a list of patient identifiers"
* alternatePatientId 0..1 SU string "alternate patient id, should be blank"
* patientName 1..1 SU string "patient name"
* mothersMaidenName 0..1 SU string "mothers maiden name"
* birthDateTime 1..1 SU string "birth date and time"
* administrativeSex 1..1 SU string "administrative sex"
* patientName 1..1 SU string "PID-5 patient name"
* mothersMaidenName 0..1 SU string "PID-6 mothers maiden name"
* birthDateTime 1..1 SU string "PID-7 birth date and time"
* administrativeSex 1..1 SU string "PID-8 administrative sex"
* patientAlias 0..1 SU string "should be blank"
* race 1..1 SU string "race/ethnicity"
* patientAddress 1..1 SU string "patient address"
* patientAddress 1..1 SU string "PID-11 patient address"
* countyCode 0..1 SU string "retained for backward compatibility"
* homePhone 1..1 SU string "home phone number"
* businessPhone 0..1 SU string "business phone number"
Expand Down
59 changes: 59 additions & 0 deletions ig/input/fsh/logical-orm-O01.fsh
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
// defines the ORM-O01 (loosely) input that is expected for newborn screening

//TODO: lines 11-12; Do we want to cross refernce the MSH and PID Segments fron the ADT message, or should they be custom to the ORM?
//TODO: Check for correct fields for each segment
//TODO: We need proper cardinality for ORM segment fields

Logical: ORMO01
Id: orm-O01-logical-model
Title: "ORM-O01"
Description: "The expected input for ORM formatted data for the newborn screening ETOR workflow"
* MSH 1..1 SU MSHSegment "MSH segment"
* PID 1..1 SU PIDSegment "PID segment"
* ORC 1..* SU ORCSegment "ORC segment"
* OBR 1..* SU OBRSegment "OBR segment"
* OBX 1..* SU OBXSegment "OBX segment"

Logical: ORCSegment
Id: segment-orc-logical-model
Title: "ORC Segment"
Description: "The ORC Segment"
* orderControl 1..1 SU string "ORC-1 Order Control"
* ORCPlacerOrderNumber 1..1 SU string "ORC-2 Placer Order Number"
* fillerOrderNumber 1..1 SU string "ORC-3 Filler Order Number"
* placerGroupNumber 1..1 SU string "ORC-4 Placer Group Number"
* dateTimeOfTransaction 1..1 SU string "ORC-9 Date/Time of Transaction"
* orderingProvider 1..1 SU string "ORC-12 Ordering Provider"
* orderingFacilityName 1..1 SU string "ORC-11 prdering Facility Name"
// other optional fields

Logical: OBRSegment
Id: segment-obr-logical-model
Title: "OBR Segment"
Description: "The OBR Segment"
* setOBRId 1..1 SU string "OBR-1 Set ID"
* OBRplacerOrderNumber 1..1 SU string "OBR-2 Placer Order Number"
* fillerOrderNumber 1..1 SU string "OBR-3 Filler Order Number"
* universalServiceIdentifier 1..1 SU string "OBR-4 Universal Service Identifier"
* observationDateTime 1..1 SU string "OBR-7 Observation Date/Time"
* observationEndDateTime 1..1 SU string "OBR-8 Observation End Time"
* specimenID 1..1 SU string "OBR-15 or OBR-16 Specimen Id"
* specimenType 1..1 SU string "OBR-15 or OBR-16 Specimen Type"
* specimenCollectionDateTime 1..1 SU string "OBR-7 Specimen Collection Date/Time"
// other optional fields

Logical: OBXSegment
Id: segment-obx-logical-model
Title: "OBX Segment"
Description: "The OBX Segment"
* setOBXId 1..1 SU string "OBX-1 (1) Birthweight an identifier"
* valueType 1..1 SU string "OBX-2 A Value Type"
* observationIdentifier 1..1 SU string "OBX-3 Observation Identifier"
* observationSubID 1..1 SU string "OBX-4 (LOINC 54089-8) Observation Sub-ID"
* observationValue 1..1 SU string "OBX-5 (LOINC or 99MDH) Observation Value"
* units 1..1 SU string "OBX-6 Unit For Observation Value"
* observationResultStatus 1..1 SU string "OBX-11 Observation Result Status"
* dateTimeOfTheObservation 1..1 SU string "OBX-14 Date/time Of Observation"
* observationType 1..1 SU string "OBX-29 Observation Type"
* observationSubType 1..1 SU string "OBX-30 Observation Sub-type"
// other optional fields

0 comments on commit 962862e

Please sign in to comment.