Docstoc

HITSP-IIsc-Envelope-DataRequirements

Document Sample
HITSP-IIsc-Envelope-DataRequirements Powered By Docstoc
					              category class.attribute name (for name) name
                                                data item
level (a temporary number until we arrive a betterbackwards traceability; used only until category or class names are finali
            4 CORE Phase II envelope
                       4-1.datetime
            4 CORE Phase II envelope            datetime
                       4-1.processing
            4 CORE Phase II envelope mode code  processing mode code
                       4-1.envelope             envelope
            4 CORE Phase II envelope version identifier version identifier
                       4-1-payload.syntax identifier identifier
            4 CORE Phase II envelope            syntax
                       4-1-payload.identifier payload.identifier
            4 CORE Phase II envelope
                       4-1-payload.length
            4 CORE Phase II envelope            payload.length
                       4-1-payload.checksum payload.checksum
            4 CORE Phase II envelope

              4   security
              4            4-4-security.username security.username
                  CORE Phase II envelope
              4            4-4-security.password security.password
                  CORE Phase II envelope
              4            4-4-security.authentication certificate
                  CORE Phase II envelope           security.authentication certificate

              4 sender
                         4-2-sender.identifier
              4 CORE Phase II envelope              identifier

              4 receiver
                         4-3-receiver.identifier identifier
              4 CORE Phase II envelope

              4 error
                         4.8-1-error.code
              4 CORE Phase II envelope
                         4.8-1-error.text
              4 CORE Phase II envelope

            3     tbd (known in HL7 V2.6: file; NCPDP SCRIPT: transaction; NCPDP Telecommunication: transmission; X12: tran
            3     tbd      3-1.identifier           identifier
            3     tbd      3-1.datetime             datetime
            3     tbd                               processing
                           3-1.processing environment code environment code
3 (and/or 1?)     tbd                               acknowledgement requested code
                           3-1.acknowledgement requested code
            3     tbd      3-1.language code        language code
            3     tbd      3-1.status code          status code
            3     tbd                               envelope
                           3-1.envelope version identifier version identifier
            3     tbd      3-1.length               length
            3     tbd      3-1.checksum             checksum
            3     tbd      3-1.syntax identifier    syntax identifier
            3     tbd      3-1.profile identifier   profile identifier
            3     tbd      3-1.character set code character set code
            3     tbd      3-1.country code         country code
            3     tbd      3-1.group count          group count

              3   sender
              3   sender    3-2-sender.identifier identifier
              3   sender                             application
                            3-2-sender.application identifier identifier
              3   sender                             facility
                            3-2-sender.facility identifier identifier
              3   sender                             network address
                            3-2-sender.network address
              3   sender                             responsible identifier
                            3-2-sender.responsible organization organization identifier

Pg 1 of 148                                      IIsc-consolidated
                                             D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
              3 sender       3-2-sender.role code role code
              3 sender                               name
                             3-2-sender.organization organization name

              3   receiver
              3   receiver   3-3-receiver.identifier identifier
              3   receiver   3-3-receiver.application application
              3   receiver   3-3-receiver.facility    facility
              3   receiver                            network
                             3-3-receiver.network address address
              3   receiver                             organization identifier
                             3-3-receiver.responsibleresponsible organization identifier
              3   receiver   3-2-receiver.role code role code
              3   receiver   3-2-receiver.person identifier
              3   receiver   3-2-receiver.person name
              3   receiver   3-2-receiver.organization identifier
              3   receiver   3-2-receiver.organization name

              3 receiver criteria: place
                                                    circle
                targetArea3-3-receiver-criteria-place.circle
                                                    polygon
                           3-3-receiver-criteria-place.polygon
                                                    country
                           3-3-receiver-criteria-place.country
                                                    subdivision
                           3-3-receiver-criteria-place.subdivision
                                                    locCodeUN
                           3-3-receiver-criteria-place.locCodeUN

              3 security
              3 security     3-4-security.username username
              3 security     3-4-security.password password

              3 delimiters
              3 delimiters 10-1-delimiters.          (deferred to later)

              3 error
              3 error        3-5-error.code          code
              3 error        3-5-error.text          text


              2 group (known in HL7 V2.6: batch; X12: functional group)
              2 group     2-1.message count      message count


           1 1-1 (known in DICOM: DICOM Message; HL7 V2.6: message; NCPDP SCRIPT: message; NCPDP Telecommunic
           1 1-1       1-1.identifier         identifier
           1 1-1       1-1.datetime           datetime
1 (and 2?)   1-1       1-1.message type code message type code
1 (and 2?)   1-1       1-1.trigger event code
             1-1       1-1.internet address   internet address

              3 response
              3 response 9-1-response.identifier identifier

Pg 2 of 148                                       IIsc-consolidated
                                              D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                response code
              3 response 9-1-response.response code

              1 error
              1 error    8-1-error.code         code
              1 error    8-1-error.text         text




Pg 3 of 148                                   IIsc-consolidated
                                          D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
             definition                          - range
                                       domain specification - format                  - length: example usage(s)
                                                                          - length: minimum maximum value

             The date and time the message was sent                                                        auditing, trouble-shooting
             A code categorizing the mode of processing (e.g. real time, batch)                            to determine which processing
             An identifer that identifies the combination of the envelope standard and the version/release/etc. of the envelope standard
                                                                                                           message routing; efficient proc
             An identifer that uniquely identifies the combination of the standard and the version/release/etc. of the standard of the payl
             An identifier assigned by the sender that uniquely identifies the payload                     auditing, trouble-shooting
                                         (in bytes)
             The length of the payloadAlgorithm is SHA-1       Encoding is Hex                             to assist the receiver in identify
             A checksum computed on the payload                                                            to allow the receiver to verify t


             A username for the sender in the receiver's system                      50                      for authentication and authoriz
             A password for the sender in the receiver's system                      50                      for authorization purposes onl
             A certificate used by the receiver to authenticate the sender


             An identifier for the sender that's known by the receiver               50                      Message routing and processin


             An identifier for the receiver                                          50                      Message routing and processin


             A code depicting the error the receiver applied (to the what?)                1024              to allow the receiver to commu
             The text of the error the receiver detected                                                     to allow the receiver to commu

PDP Telecommunication: transmission; X12: transmission)
           An identifier assigned by the sender for "the whole schebang"                                  ? Used by the sender and recei
           The date and time the ?tbd was sent                                                            ? Audit
                                      production; test
           A code categorizing the sender's processing environment (e.g. production, test)                to determine which processing
                                                                                                          to
           A code categorizing the type of acknowledgement the sender is requesting the receiver to supplyinstruct the receiver what ty
           A code depicting the language of the payload                                                   ?
           A code depicting the status of the interaction (e.g. complete)                                 ?
                                                                                                          ? How the envelope standard
           An identifer that identifies the combination of the envelope standard and the version/release/etc. of to parse the envelope
           The length of the payload (in bytes)                                                           to assist the receiver in identify
           A checksum computed on the payload                                                             to allow the receiver to verify t
                                                                                              an identifier that the standard
                                                                                                          to provide the receiver the info
           An identifer that uniquely identifies the combination of the standard and the version/release/etc. ofrepresents NCPDP SCRIPT
           An indentifier for the profile the payload conforms to                                         to allow the receiver to determ
           A code depicting the character set of the payload (e.g. ASCII)                                 ?
           A code depicting the country of the country of origin for the message.                          to specify default elements, su
           A count of the number of groups included in the payload                                        similar to checksum, used by re


             An identifier for the sender that's known by the receiver                                      to allow the receiver to identify
             An identifier of the sender's application that produced the payload content                    ? to send or route the acknowl
             An identifier of the sender's facility that the payload applies to                             ? Organization; may not be nee
             An identifier of the sender's network                                                          ?
                                                                                                            ? may not be payload content
             An identifier of the organization that produced (or should "produced" be replaced by "is the source of") the needed if the sen

            Pg 4 of 148                                     IIsc-consolidated
                                                        D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
           A code categorizing the role of the sender                                                       ?
           The name of the sending organization


           An identifier for the receiver                                                                   to allow the receiver to determ
           An identifier for the receiver's application that the payload content is intended for            ? to route the message to the p
           An identifier for the receiver's facility that the payload is intended for                       ?
           An identifier for the receiver's network                                                         ?
           An identifier for the organization the the payload content is intended for                       ?
           A code categorizing the role of the receiver                                                     ?
           An identifer for the person who is th intended recipient                                         ?
           A name for the person who is the intended recipient                                              ?
           An identifer for the organization that is the intended recipient                                 ?
           A name for the organization that is the intended recipient                                       ?

           a container element for the geospatial or political area targeting of the message content         indicates the originator’s inten
                                                             1. Represented in the form "latitude, longitude, radius". (See Geospatial Note
           An enclosed geographic area within a given radius around a geographic point          38.26295, -122.07454 15
                                                             1. Represented by a by an ordered42,-124.2102 42,-120.1 39,-120 35.0,-114.
                                                                                                 set of vertices.
           An enclosed geographic area within a simple closed polygon defined space-delimited series of latitude, longitude pairs, with t
                                      The                                                       US
           an identifier for the country two-character ISO 3166-1 Country Code for the country concerned.
                                      The ISO 3166-2 designator forfirst two
                                                             1. The the administrative before the hyphen, are
                                                                                                California
           an identifier for the administrative subdivision (of the country?)characters,subdivision concerned. the two character ISO 316
                                      1. The                                                    USFFB (Fairfield, Alabama, USA), USSUU (F
           an identifier for the location two first digits are the two character ISO3166-1 Country Code for the country in which the pla


           A username for the sender in the receiver's system                                               for identification, authenticatio
           A password for the sender in the receiver's system                                               for authorization purposes onl

                                                                                                            to allow the receiver to correc




           A code depicting the error the receiver applied to the entire tbd
           A text description of the error the receiver applied to the entire tbd




           A count of the number of messages included in the payload                                        ?


NCPDP SCRIPT: message; NCPDP Telecommunication: transaction; X12: transaction set)
          An identifier assigned by the sender to the payload                                               to allow the sender to associat
          The date and time the payload content was created                                                 ?
          A code depicting the message type of the payload                                         NEWRX    to provide the receiver the info
          A code categorizing the event that resulted in the interaction                                    ?
          The URI of the document available for retrieval                                                   used by recipient to retrieved t


           An identifier assigned by the receiver to the response

           Pg 5 of 148                                      IIsc-consolidated
                                                        D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
A code categorizing the response (e.g. successful, error)                               to allow the receiver to commu


A code depicting the error the receiver applied (to the what?)                          to allow the receiver to commu
The text of the error the receiver applied (to the what?)                               to allow the receiver to commu




Pg 6 of 148                                    IIsc-consolidated
                                           D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                     datatype: o/m/c:      multipledependent dataor maximum number) rules/constraints
                                                    occurrences (y item (in
                                                           batch only (b)/online only
                                                                                    business        Note
            compound indicator analysis optional, mandatory, conditional list context) (o) domain model reference

 auditing, trouble-shootingdatetime m
                           code         m
 to determine which processing environment to route and apply to; resource allocation; transaction scheduling; message or transaction a
/etc. of the envelope standard          m
                           identifier m
 message routing; efficient processing; auditing; to provide the receiver the information to allow them to properly parse the payload
 auditing, trouble-shootingidentifier m
                            identifying if
 to assist the receiver in amount o any of the payload may be missing; efficient processing and resource allocation; auditing
                            verify the c (required for batch, not
 to allow the receiver tohash valueintegrity of the payload used for real time)          Checksum must be computed only on the payload


                       text                                    o
for authentication and authorization by the receiver, and auditing
                       text
for authorization purposes only by the receiver                o




                                 a
Message routing and processing bym receiver, transaction auditing


                                 a
Message routing and processing bym receiver, transaction auditing


                         communcate to the sender the type of error detected; to allow for error handling by the sender; troubleshooting
to allow the receiver tocode     c
                         communcate to the sender the description of the error detected or information to assist in resolving the error
to allow the receiver totext     c                                                    The text of the ErrorMessage must provide additio


                          identifier m
? Used by the sender and receiver to link response back to initial "message"; sequencing
                          datetime m
                          code         m
to determine which processing environment to apply to
                          what         of
to instruct the receiver code types o acknowledgements to send                                           we'll need to define acknowled
                          code         o
                          code         o
                          identifier m
? How to parse the envelope
                           identifying if
to assist the receiver in amount o any of the payload may be missing
                           verify the o
to allow the receiver tohash valueintegrity of the payload                                               CORE: Required for Batch, Not
                          the information
to provide the receiver identifier m to allow them to properly parse the payload
                           determine the
to allow the receiver toidentifier o constraints the payload should conform to
                          code         o                                                                 Note that multibyte character
                          code         o
 to specify default elements, such as currency denominations
                          count        o
similar to checksum, used by receiver to make certain the entire transmission has been received          is there a more generic term th

                                                                                                        Sender and Receiver informat
                         identify m
to allow the receiver toidentifierthe sender
                        identifier o
? to send or route the acknowledgement back to the proper instance of the application in cases when the sender has more than one; ma
                        identifier
? Organization; may not be neededoif the sender.identifier is unique
                        identifier o                            o
                        the sender.identifier is unique
? may not be needed if identifier o

            Pg 7 of 148                                    IIsc-consolidated
                                                       D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                          code     o
                                   o
                          name-organization

                                                                                                        consider if end recipient and in
                         determine they
to allow the receiver toidentifier m are the intended recipient                                         Sender and Receiver informat
                        to the proper
? to route the message identifier o instance of the application in cases when the receiver has more than one; may not be needed if the
                        identifier o
                        identifier o                          o                                         Maximum length should be lon
                        identifier o
                        code       o
                        identifier o
                        name-persono
                        identifier o
                                   o
                        name-organization

                                     o
 indicates the originator’s intent based on location targeting as to the dissemination of the message/information
122.07454 15
02 42,-120.1 39,-120 35.0,-114.6328 34.35,- 120.4418 38.9383,-123.817 42,-124.2102


field, Alabama, USA), USSUU (Fairfield, California, USA), GBFFD (Falfield, South Gloucestershire, UK); USA-SF

                                    o
                         text
for identification, authentication and authorization purposes only by the receiver      protected by transport layer SSL encryption
                         text
for authorization purposes only by the receiver                                         protected by transport layer SSL encryption

                                    o
to allow the receiver to correctly parse the payload




                                    o
                          count     o


                                    m
                        identifier o
to allow the sender to associate the receiver's response with the sent message        If the payload is being resent in the absence of con
                        datetime o
                        the information to allow them to identify the message type and to route the message assumes a comprehensive
to provide the receiver code        o                                                                      This
                        code        ?                           o                                          This assumes a comprehensive
                        internet address
                                    c
used by recipient to retrieved the document                     o

                                     m
                          identifier m

            Pg 8 of 148                                    IIsc-consolidated
                                                       D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                         communicate to the sender the success/failure of its processing of the payload
to allow the receiver tocode     m

                                             y       associated with response                          associated with responses onl
                         communicate to the sender the type of error detected;must be valued handling by the sender
to allow the receiver tocode     c                   either code and/or text to allow for error
                         communicate to the sender the description of thetext must be valued
to allow the receiver totext     c                   either code and/or error detected or information to assist in resolving the error




           Pg 9 of 148                                    IIsc-consolidated
                                                      D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                          CAQH-CORE Phase 2
                                       CAQH-CORE CDISC-Lab CDISC-Lab DICOM                       HL7-V2.6
            Mapping to Source data element(s): Rules Phase II Mapping notesMapping notesDICOM Mapping notes

                          Time Stamp
                          Processing Mode
                                        CORE
                          CORE Rule Version Phase II rules specify The CORE Rule version
                          Payload Type
                          Payload ID
                          Payload Length
                          Checksum
 computed only on the payload and not on the metadata. Used for batch; not used for real time.


                            User Name
                            Password
                            ??


                                           CORE Phase II rules specify A unique business entity identifier representing the message envelo
                            Sender Identifier


                                           CORE
                            Receiver Identifier Phase II rules specify this represents the next-hop receiver


                         Error Code
                         Error Message
orMessage must provide additional information describing how the Error can be resolved, and must not provide conflicting information fr


                                                                                  Message Id; Move Originator Message ID; Message ID B
                                                        File Creation Date and Time                       Date/Time of Message

 we'll need to define acknowledgement types if this remains an attribute in the envelope                       Accept Acknowledgment Type
                                                                                                               Principal Language Of Messag




 CORE: Required for Batch, Not used for Realtime
                                                        Model Version                                          Version ID
                                                                                                               Message Profile Identifier
                                                                                                               Character character delimiter
 Note that multibyte character sets (versus single byte character sets) present specific challenges (e.g. not using singleSet
                                                                                                               Country Code
 is there a more generic term than group; we need a better definition

 Sender and Receiver information might need to be ordered lists in order to allow for intermediaries to distribute or forward a messag
                                                                                            ?
                                                    Transmission Source ID Move Originator Application Entity Title
                                                                                                          Sending Application
                                                                                                          Sending Facility
                                                                                                          Sending Network Address
                                                                                                          Sending Responsible Organiza

            Pg 10 of 148                                    IIsc-consolidated
                                                        D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                     Transmission Source Name

consider if end recipient and intermediary recipient might be appropriate
Sender and Receiver information might need to be ordered lists in order to allow for intermediaries to distribute or forward a messag
                                                                                                         Receiving Application
                                                                                                         Receiving Facility
Maximum length should be long enough to accommodate IP address as well as an email address.              Receiving Network Address
                                                                                                         Receiving Responsible Organiz




                                                                                                        Security
port layer SSL encryption
port layer SSL encryption


                                                                                                        Field Separator; Encoding Cha




                                                                                                        Batch Message Count




                                                                                   Message ID, may be reused.
                                                                                                           message header
ing resent in the absence of confirmation of receipt to persistent storage, the same PayloadID Move Originator Message ID Message Con

                                                                                                       Message Type, part of
This assumes a comprehensive and robust code set is created. Otherwise, more than one attribute might be needed. For example, X12 u
                                                                              combination of service code and Affectedpart of
                                                                                                       Message Type, SOP Class UID
This assumes a comprehensive and robust code set is created. Otherwise, more than one attribute might be needed.




                                                                               Message ID Being Responded To


            Pg 11 of 148                                 IIsc-consolidated
                                                     D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                        Status                 Acknowledgment Code

associated with responses only




          Pg 12 of 148               IIsc-consolidated
                                 D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                      HL7-V3    HL7-V3 Mapping notesIHE-XDP Mapping notes - XDR Mapping notes
            HL7-V2.6 Mapping notes       IHE-XDP             IHE - XDR IHE       NDPDP-SCRIPT                NDPDP-SCRIPT Mapping n




presenting the message envelope creator




             The data elements in the FHS and FTS could be mapped to this level, but were not.
ator Message ID; Message ID Being Responded To                     MessageId                                  Which of these is correct?
                                                                                           Transaction control reference or Dialogue Re
 Date/Time of Message                                              Timestamp               UIB Date of initiation and Event Time; UIH Da
                        message.processingCode                                             UIB Test Indicator; UIH Test Indicator
 Accept Acknowledgment Type and Application Acknowledgment Type    AckRequested
 Principal Language Of Message

                                                                                           Syntax identifier and Syntax version number
                                              size                  size
                                              hash                  hash
                       message.versionCode                                                 Message type and Message version number
                       message.profileId
Message Profile Identifier                                          CPAId
Character Set
Country Code


istribute or forward a message.
                                                                    PartyId                Interchange Sender - Sender identification - l
Sending Application
Sending Facility
Sending Network Address
           not name

           Pg 13 of 148                                   IIsc-consolidated
                                                      D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                  Role




istribute or forward a message.                       IHE-XDP PartyId                   Interchange Recipient - Recipient ID - level o
                                            intendedRecipient definition appears to be imprecise
 Receiving Application
 Receiving Facility
 Receiving Network Address
             not name
                                                                  Role
                                                                  intendedRecipient
                                                                  intendedRecipient
                                                                  intendedRecipient
                                                                  intendedRecipient




                                HL7 definition is imprecise
                      message.securityText
                                HL7 definition is imprecise
                      message.securityText


Field Separator; Encoding Characters                                                     Component Data Element Separator; Data El




          The other data elements in the BHS and BTS could be mapped to this level, but were not.
Batch Message Count




                      message.id
message header Message Control ID and message acknowledgment Message Control ID          UIH Message Reference Number and UIT Me
                      message.creationTime
Message Type, part of                                                                    Message function
Message Type, part of                                        Action
                                           URI


                                                                                         Responder control reference

           Pg 14 of 148                                 IIsc-consolidated
                                                    D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
Acknowledgment Code




         Pg 15 of 148       IIsc-consolidated
                        D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                         NCPDP-telecom - Real Time
                                                                 NCPDP-telecom - Real OASIS-EDXL-DE-COMCARE Mapping note
          NCPDP-telecom - BatchNCPDP-telecom - Batch Mapping notes                    Time Mapping
                                                                                                ONC-CDT
                                                                           OASIS-EDXL-DE-COMCAREnotes




                                                                           distributionID; and part of distributionReference
          Required Transmission Header Record Batch Number and REQUIRED TRANSMISSION TRAILER RECORD
          Creation Date, Creation Time                                     dateTimeSent; and part of distributionReference
          File Type                                                        distributionStatus

                                                                             language

          Version /Release Number


                                           Transaction
and Message version number and Message release number Header Segment VERSION/RELEASE NUMBER; Response Header Segment VER




          Sender ID                                               SERVICE PROVIDER Segment SOFTWARE VENDOR/CERTIFICATIO
                                                                             Header ID QUALIFIER
                                          SERVICE PROVIDER ID andTransactionsenderID; and part of distributionReference




          Pg 16 of 148                                IIsc-consolidated
                                                  D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
           Receiver ID                       BIN NUMBER (and PROCESSOR CONTROL NUMBER, which may be empty);


                                                                                             ?
                                                                                  explicitAddressValue




                                                                                  target area
                                                                                  circle
                                                                                  polygon
                                                                                  country
                                                                                  subdivision
                                                                                  locCodeUN




           Required Transmission Header Record-Text Indicator - Start of Text; Required Transmission Header Record-Text Indicator - En

                                                                      a response file is sent back to the sender with a transmission typ




                                             Transaction Header Segment TRANSACTION COUNT; Response Header Segment TRANSAC




           Transaction Reference Number

                                             Transaction Header Segment TRANSACTION CODE; Response Header Segment




trol reference

           Pg 17 of 148                                  IIsc-consolidated
                                                     D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                Response Status Segment REJECT CODE
                   ? Is this correct
REQUIRED TRANSMISSION TRAILER RECORD Message




Pg 18 of 148                              IIsc-consolidated
                                      D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                     X12       X12     Outstanding Issues
            ONC-CDT Mapping notes Mapping notes




                                              arriving at a good name for this
                        ISA
rt of distributionReference Interchange Control Header Interchange Control Number; IEA Interchange Control Trailer Interchange Control
                        Interchange Date and Interchange Time
rt of distributionReference
                        Usage Indicator


                                            unless there's a mapping from a standard, remove this data item
                       ?                    NCPDP SCRIPT allows multiple identifiers
                                  2/23/2009 Rachel mentioned there is an interchange version. What segment and data element is that


                     Interchange Control Standards
Response Header Segment VERSION/RELEASE NUMBER Identifier and Interchange Control Version Number; GS Functional Group Header V
                                2/23/2009 Rachel mentioned transaction set version and industry profile guide is what would map to


                       IEA Interchange Control Trailer - Number of Included Functional Groups


                                             identifiers and identifier type
distributionReference Interchange ID Qualifier ISA05; I05 and Interchange Sender ID




            Pg 19 of 148                                  IIsc-consolidated
                                                      D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
may be empty);          Interchange ID Qualifier ISA07; I05 and Interchange Receiver ID




                                               is this for a different type of interaction where the message is sent to a router/switch tha




                                              this conflicts with the HITSP security and privacy committee's recommendations
                        Authorization Information and Authorization Information Qualifier or


                                              this belongs on a different "layer", similar to security
                       element separator; Component Element Separator; segment terminator
ader Record-Text Indicator - End of Text; TRANSACTION DETAIL DATA RECORD - Start of Text and End of Text ; REQUIRED TRANSMISSION

 sender with a transmission type of E which indicates the error




                                               arriving at a good name for this; does the envelope need to specify that there are contain
nse Header Segment TRANSACTION COUNT           definition of "message"


                                               arriving at a good name for this


 e Header Segment                              This tacitly assumes only one message type is present in the payload




            Pg 20 of 148                                    IIsc-consolidated
                                                        D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
               should this be in the payload rather than the envelope, at this level?




Pg 21 of 148               IIsc-consolidated
                       D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
ontrol Trailer Interchange Control Number




er; GS Functional Group Header Version / Release / Industry Identifier Code and GS Functional Group Header Responsible Agency Code
ofile guide is what would map to this data element. Which X12 segment and data element number does this refer to?




            Pg 22 of 148                                IIsc-consolidated
                                                    D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
age is sent to a router/switch that determines the appropriate receivers? Yes, per the ONC Common Data Transport document




ttee's recommendations




d to specify that there are contained groupings?




            Pg 23 of 148                               IIsc-consolidated
                                                   D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
at this level?




            Pg 24 of 148       IIsc-consolidated
                           D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
eader Responsible Agency Code
s this refer to?




           Pg 25 of 148             IIsc-consolidated
                                D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
Data Transport document




          Pg 26 of 148        IIsc-consolidated
                          D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
IIsc term                                     CORE Phase II DICOM          HL7 V2.6                            HL7 V3          NCPDP SCRIPT
                                              message
4: envelope for all other SDO envelopes and content
header                                        HTTP Header or SOAP Header
trailer
acknowledgement header, if different
acknowledgement error

3: the entire collection being sent as a group payload                     [file (or just a single message)]   ?[transmission] transaction
header                                                                     FHS-File Header Segment                             UIB-Interactive Interchange Contr
                                                                                                               HL7 Transmission Wrapper (either Batch Transmiss
trailer                                                                    FTS-File Trailer Segment                            UIZ-Interactive Interchange Contr
acknowledgement header, if different


2: a group of "related" "messages"                                         [batch]                             [batch]
header                                                                     BHS-Batch Header Segment            Batch Transmision Wrapper
trailer                                                                    BTS-Batch Trailer Segment


                                                               DICOM Messagemessage
1: "message": a single collection of data "processed" by the receiver as a unit                              message?      message
header                                                                           Header (PS 3.8)
                                                               Message ControlMSH-Message Header Segment                   UIH-Interactive Message Header
                                                                                                             Message Transmission Wrapper and Trigger Event
trailer                                                                                                                    UIT-Interactive Message Trailer
acknowledgement header, if different                                                                         ?
                                                                                MSA-Message Acknowledgement Segment
acknowledgement error                                                           ERR-Error Segment




Pg 27 of 148                                                                 D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                            SDO-structure-summary
                         NCPDP             OASIS X12
                                                  EDXL
           NCPDP Telecom - Batch Telecom - Real Time




           transmission transmission          interchange
                                              ISA-Interchange Control Header
           REQUIRED TRANSMISSION HEADER RECORD (00)
                                              IEA-Interchange Control Trailer
           REQUIRED TRANSMISSION TRAILER RECORD (99)




                                                  functional group
                                                  GS-Functional Group Header
                                                  GS-Functional Group Trailer


           transaction   transaction             transaction set
                         Transaction Header (G1) ST-Transaction Set Header
           TRANSACTION DETAIL DATA RECORD Segment
eractive Message Trailer                         SE-Transaction Set Trailer
                         Response Header Segment
                         Response Status Segment




           Pg 28 of 148                                                                D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                      SDO-structure-summary
SDO abbreviation                             source (reference within the file name)
                                                                       category
                   source document (from DataRequirements-Sources, D:document)                   data     alias(es) (includes presentationspecification
                                                                                       sub-category item name          definition domain label)
CDISC              Lab1-0-1-Specification.pdfp 13
                                                                                                 Model Version          The version of the CDISC Laboratory Dat
                                                                                                                        The
                                                                                                 File Creation Date and Timelocal date and time the data file wa
                                                                                                 Transmission Source IDThe ID of the organization that is the so
                                                                                                                        The
                                                                                                 Transmission Source Name Name of the organization that is the




Pg 29 of 148                                                                 D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                               DataReq-CDISC-Lab
             - range    - format                - length: example usage(s)
                                    - length: minimum maximum value              compound indicator analysis optional, mandatory, conditional (in list number) reference
                                                                                          datatype: o/m/c:                 dependent business rules/constraints
                                                                                                                                      data item context) model
                                                                                                                multiple occurrences (y or maximum  domain

n of the CDISC Laboratory Data Interchange Standard model indicating by definition which fields are contained within it.                        3-1.syntax identifier
                         This includes a Universal Time Offset plus/minus hours and minutes.
ate and time the data file was created at the central laboratory.                                                                               3-1.datetime
he organization that is the source of the data transmission.                                                                                    3-2-sender.identifier
of the organization that is the source of the data transmission.                                                                                3-2-sender.organization na




            Pg 30 of 148                                                                     D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                               DataReq-CDISC-Lab
          Note

3-1.syntax identifier
3-1.datetime
3-2-sender.identifier
3-2-sender.organization name




          Pg 31 of 148                       D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                               DataReq-CDISC-Lab
SDO abbreviation                          source (reference within the file name)
                                                                    category
                   source document (from DataRequirements-Sources, D:document)                data       alias(es) (includes presentationspecification
                                                                                    sub-category item name            definition domain label)
DICOM              08-07pu.doc                                                      C-STORE
                                                                                              Message ID(0000,0110)   identifies the operation
                                                                                              Affected SOP Class UIDspecifies the SOP Class for the storage
                                                                                                         (2200,0020)?
                                                                                              n/a (operation) Priority
                                                                                              Move Originator Application Entity Title
                                                                                              Move Originator Message ID
                                                                                              Data Set
                                                                                              Status                  the error or success notification for the

                                                                   response
                                                                                               Message ID Being Responded To




Pg 32 of 148                                                               D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                               DataReq-DICOM
             - range     - format               - length: example usage(s)
                                    - length: minimum maximum value          compound indicator analysis optional, mandatory, conditional (in list number) reference
                                                                                      datatype: o/m/c:                 dependent business rules/constraints
                                                                                                                                  data item context) model
                                                                                                            multiple occurrences (y or maximum  domain

 he operation                                                                                                                            No two identical values for the Messag
                                                                                                                                                   3-1.identifier
                                                                  to distinguish this operation from other notifications or operations that the DIMSE-service-provider may hav
he SOP Class for the storage


                                                                                                                                                   3-1.identifier

r success notification for the operation




            Pg 33 of 148                                                                 D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                             DataReq-DICOM
            Note

3-1.identifier




3-1.identifier




            Pg 34 of 148               D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                           DataReq-DICOM
SDO abbreviation              source (reference within the document) data item
                                                        category
                   source document (from DataRequirements-Sources, D: file name) name                                definition domain label)
                                                                                                        alias(es) (includes presentationspecification
HL7                           S 2.14.9 MSH message header segment, p 55-64
                   V26_CH02_Control.doc                 message header
                                                                       Field Separator                  00001        This field contains the separator between
                                                                       Encoding Characters              00002        This field contains two to four characters i
                                                                       Sending Application              00003        This field uniquely identifies the sending a
                                                                       Sending Facility                 00004        This field further describes the sending ap
                                                                       Receiving Application            00005        This field uniquely identifies the receiving
                                                                       Receiving Facility               00006        This field identifies the receiving applicatio
                                                                       Date/Time of Message             00007        This field contains the date/time that the
                                                                       Security                         00008        In some applications of HL7, this field is us
                                                                       Message Type                     00009        This field contains the message type, trigg
                                                                       Message Control ID               00010        This field contains a number or other iden
                                                                       Processing ID                    00011        This field is used to decide whether to pro
                                                                       Version ID                       00012        This field is matched by the receiving syste
                                                                       Sequence Number                  00013        A non null value in this field implies that th
                                                                       Continuation Pointer             00014        This field is used to define continuations in
                                                                       Accept Acknowledgment Type 00015              This field identifies the conditions under w
                                                                       Application Acknowledgment Type  00016                      AL: Always; NE: Never; ER: Erro
                                                                                                                     This field contains the conditions under w
                                                                       Country Code                     00017        This field contains the country of origin for
                                                                       Character Set                    00692        An HL7 message uses field MSH-18-charac
                                                                       Principal Language Of Message 00693           This field contains the principal language o
                                                                                                        01317
                                                                       Alternate Character Set Handling Scheme       When any alternative character sets are u
                                                                       Message Profile Identifier       01598        Sites may use this field to assert adherenc
                                                                       Sending Responsible Organization01823         Business organization that originated and
                                                                                                        0
                                                                       Receiving Responsible Organization1824        Business organization that is the intended
                                                                       Sending Network Address          01825        Identifier of the network location the mes
                                                                       Receiving Network Address        01826        Identifier of the network location the mes

                                                     message acknowledgment
                                                                    Acknowledgment Code
                               2.14.8 MSA message acknowledgment segment, p 53-54                 00018                              AA Original mode: Application
                                                                                                                        This field contains an acknowledgment co
                                                                    Message Control ID            00010                 This field contains the message control ID
                                                                    (obsolete) Text Message       00020                 n/a
                                                                    Expected Sequence Number      00021                 This optional numeric field is used in the s
                                                                                                  00022
                                                                    (obsolete) Delayed Acknowledgment Type              n/a
                                                                    (obsolete)Error Condition     00023                 n/a


Pg 35 of 148                                                                  D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                 DataReq-HL7-V2.6
                                                       Message Waiting Number          01827    If present, indicates the number of messag
                                                       Message Waiting Priority        01828                 H HighM MediumL Low
                                                                                                If present, indicates that the Sending Appl

                                      error response
               2.14.5 ERR error segment, p 46-50
                                                                                        00024
                                                       (obsolete) Error Code and Location       n/a
                                                       Error Location                   01812   Identifies the location in a message relate
                                                       HL7 Error Code                   01813                0 HL7 (communications) error
                                                                                                Identifies the Message accepted Success. O
                                                       Severity                         01814                W Warning Transaction succes
                                                                                                Identifies the severity of an application er
                                                       Application Error Code           01815   Application specific code identifying the sp
                                                       Application Error Parameter      01816   Additional information to be used, togethe
                                                       Diagnostic Information           01817   Information that may be used by help des
                                                       User Message                     01818   The text message to be displayed to the a
                                                       Inform Person Indicator          01819                PAT Inform (if anyone) Do NO
                                                                                                A code to indicate whopatientNPATshould
                                                       Override Type                    01820                EXTN Extension Override Ident
                                                                                                Identifies what type of override can be use
                                                       Override Reason Code             01821   Provides a list of potential override codes
                                                       Help Desk Contact Point          01822   Lists phone, e-mail, fax, and other relevan

                                       segment p 43    Batch
               2.14.2 BHS batch header batch header segment Field Separator           00081     This field contains the separator between
                                                       Batch
                                       batch header segment Encoding Characters       00082     This field contains the four characters in th
                                                       Batch
                                       batch header segment Sending Application       00083     This field uniquely identifies the sending a
                                                       Batch
                                       batch header segment Sending Facility          00084     This field contains the address of one of se
                                                       Batch
                                       batch header segment Receiving Application     00085     This field uniquely identifies the receiving
                                                       Batch
                                       batch header segment Receiving Facility        00086     This field identifies the receiving applicatio
                                                       Batch
                                       batch header segment Creation Date/Time        00087     This field contains the date/time that the
                                                       Batch
                                       batch header segment Security                  00088     In some applications of HL7, this field is us
                                                       Batch
                                       batch header segment Name/ID/Type              00089     This field can be used by the application p
                                                       Batch
                                       batch header segment Comment                   00090     This field is a comment field that is not fur
                                                       Batch
                                       batch header segment Control ID                00091     This field is used to uniquely identify a par
                                                       Reference Batch Control ID
                                       batch header segment                           00092     This field contains the value of BHS-11-bat
                                                       Batch
                                       batch header segment Sending Network Address 02271       Identifier of the network location the mes
                                                       Batch
                                       batch header segment Receiving Network Address 02272     Identifier of the network location the mes

                                         batch trailer segment Message Count
               2.14.3 BTS batch trailer segment            Batch                       00093    This field contains the count of the individ
                                                           Batch
                                         batch trailer segment Comment                 00090    This field is a comment field that is not fur


Pg 36 of 148                                               D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                              DataReq-HL7-V2.6
                                                          Batch
                                        batch trailer segment Totals                    00095   We encourage new users of this field to us

                                        file header      File
               2.14.6 FHS file header segment p 51 segment Field Separator              00067   This field has the same definition as the co
                                                         File
                                        file header segment Encoding Characters         00068   This field has the same definition as the co
                                                         File
                                        file header segment Sending Application         00069   This field has the same definition as the co
                                                         File
                                        file header segment Sending Facility            00070   This field has the same definition as the co
                                                         File
                                        file header segment Receiving Application       00071   This field has the same definition as the co
                                                         File
                                        file header segment Receiving Facility          00072   This field has the same definition as the co
                                                         File
                                        file header segment Creation Date/Time          00073   This field has the same definition as the co
                                                         File
                                        file header segment Security                    00074   This field has the same definition as the co
                                                         File
                                        file header segment Name/ID                     00075   This field can be used by the application p
                                                         File
                                        file header segment Header Comment              00076   This field contains the free text field, the u
                                                         File
                                        file header segment Control ID                  00077   This field is used to identify a particular fil
                                                         Reference File Control ID
                                        file header segment                             00078   This field contains the value of FHS-11-file
                                                         File
                                        file header segment Sending Network Address     02269   Identifier of the network location the mes
                                                         File
                                        file header segment Receiving Network Address   02270   Identifier of the network location the mes

                                          file trailer       File
               2.14.7 FTS file trailer segment p 52 segment Batch Count                 00079   This field contains the number of batches
                                                             File
                                          file trailer segment Trailer Comment          00080   The use of this free text field is not further




Pg 37 of 148                                                D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                               DataReq-HL7-V2.6
             - range     - format                - length: example usage(s)
                                     - length: minimum maximum value                compound indicator analysis
                                                                                             datatype:               domain model reference
                                                                                                                                Combined Envelope mapping
                                                                                                                                           Note
                                                                                                           o/m/c: optional, mandatory, conditional (in context)note

                                                1           1              MSH-2-encoding characters. As such itm
                                                                                                    n/a                        10-1-delimiters.        delimiter
ontains the separator between the segment ID and the first real field, in assembling and parsing the message serves as the separator and defines the character to be used as a sep
                                                2           4              in assembling and parsing the message
                                                                                                    n/a            m            and subcomponent separator. Best practice is to always in
ontains two to four characters in the following order: the component separator, repetition separator, escape character,10-1-delimiters.                delimiters
                                                         227
 niquely identifies the sending application among all other applications within the y               identifier                 3-2-sender.application identifier
                                                                                       network enterprise. The network enterprise consists of all those applications that participate in
                                                         227                           y            identifier                 3-2-sender.facility identifier
urther describes the sending application, MSH-3-sending application. With the promotion of this field to an HD data type, the usage has been broadened to include not just the se
                                                         227                           y            identifier                 3-3-receiver.application
 niquely identifies the receiving application among all other applications within the network enterprise. The network enterprise consists of all those applications that participate in
                                                         227                           y            identifier                 3-3-receiver.facility
dentifies the receiving application among multiple identical instances of the application running on behalf of different organizations. User-defined Table 0362 - Facility is used as th
                                                           the                                      datetime       m           3-1.datetime
ontains the date/time that the sending system created 24 message. If the time zone is specified, it will be used throughout the message as the default time zone.
                                                           40                                       text
 plications of HL7, this field is used to implement security features. Its use is not yet further specified.                   1-4-security.username or 1-4-security.password
                                                           15 ADT^A01^ADT_A01                       code(s)        m           1-1.message type code and 1-1.trigger type code
ontains the message type, trigger event, and the message structure ID for the message.Refer to HL7 Table 0076 - Message type for valid values for the messageeventcode. This tab
                                                         199                                        identifier     m           1-1.identifier
ontains a number or other identifier that uniquely identifies the message. The receiving system echoes this ID back to the sending system in the Message acknowledgment segme
                                                            3                                       code
  used to decide whether to process the message as defined in HL7 Application (level 7) Processing rules.          m           <none>
                                                           be         2.6                           code           m           3-1.syntax identifier
  matched by the receiving system to its own version to60 sure the message will be interpreted correctly. Beginning with Version 2.3.1, it has two additional "internationalization
                                                           15                                       sequence number             subsequent value.
 value in this field implies that the sequence number protocol is in use. This numeric field is incremented by one for each<none>
                                                         180                                        identifier
  used to define continuations in application-specific ways. Only the sender of a fragmented message values this field. <none>
                                                            2
dentifies the conditions under which accept acknowledgments are required to be returned in code                                Required for enhanced acknowledgment
                                                                                                    response to this message. 3-1.acknowledgement requested code mode. Refer to H
                                                             SU:
  AL: Always; NE: Never; ER: Error/reject conditions only; 2 ALSuccessful completion only           code                       3-1.acknowledgement requested code
                                                            3 USA                                   code                       3-1.country code
ontains the country of origin for the message. It will be used primarily to specify default elements, such as currency denominations. The values to be used are those of ISO 3166,. .
                                                           16 ASCII                                 code                       3-1.character set code
 ssage uses field MSH-18-character set to specify the character set(s) in use. Valid values for this field are specified in HL7 Table 0211, "Alternate Character Sets". MSH-18-characte
                                                         250
ontains the principal language of the message. Codes come from ISO 639.                             code                       3-1.language code
                                                           20 ISO 2022-1994                         code                       <none>
 alternative character sets are used (as specified in the second or later iterations of MSH-18 character sets), and if any special handling scheme is needed, this component is to spe
                                                         427                                          detailed                 3-1.profile identifier
use this field to assert adherence to, or reference, a message profile. Message profiles containidentifier explanations of grammar, syntax, and usage for a particular message or set
                                                         567
rganization that originated and is accountable for the content of the message.
                     organization name, identifier
                                                                                                                               3-2-sender.responsible organization and facilities (MSH.3
                                                                                                                                            not name
                                                                                    Currently, MSH provides fields to transmit both sending/receiving applicationsidentifier
                                                         567                                        organization name, identifier
                                                                                                                               3-3-receiver.responsible organization identifier
                                                                                                                                            not has the
rganization that is the intended receiver of the message and is accountable for acting on the data conveyed by the transaction.This field name same justification as the Sending R
                                                         227 Identified by an OID or text string identifier The reader is referred to the "Report from the Joint W3C/IETF URI Plannin
 f the network location the message was transmitted from.5123^25.152.27.69^DNS         y             (e.g., URI).                                      online
                                                                                                                               3-2-sender.network address only
                                                         227                           y            identifier                 3-3-receiver.network address only
                                                                                                                                                       online
 f the network location the message was transmitted to. Identified by an OID or text string (e.g., URL).This is analogous with the Sending Network Address, however in the receivin

                                            2          2 AA                                 code                       response.response codehis entire segment of data items is
                                                                                                                                             t
 AA Original mode: Application Accept - Enhanced mode: Application acknowledgment: AcceptAE Original mode: Application Error - Enhanced mode: Application acknowledgmen
                                                    199                                     identifier                 1-1.identifier
ontains the message control ID of the message sent by the sending system. It allows the sending system to associate this response with the message for which it is intended.
                                                                                            text                       n/a
                                                      15
al numeric field is used in the sequence number protocol.                                   sequence number            <none>
                                                                                                                       n/a
                                                                                                                       n/a


             Pg 38 of 148                                                                      D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                                  DataReq-HL7-V2.6
                                                    5           4                         the Requesting Application. These messages would thenonly to be retrieved via a q
indicates the number of messages the Acknowledging Application has waiting on a queue forquanity                   <none>               online need
 H HighM MediumL Low                      1         1H                                   code                      <none>               online only


                                                                                                                                                    this entire segment of data items is
                                                            warning or               y           identifier
 he location in a message related to the identified error,18 PID^4^1 message. If multiple repetitions are present, the error results from the values in a combination of places.
                                                         705 success. Used for systems that must always          m           3-5-error.code, 3-5-error.text
  0 Message accepted Success. Optional, as the AA conveys 0 (indicating message accepted) identifier return a status code.100 Segment sequence error Error: The message segm
                                                            2F                                   code            m
  W Warning Transaction successful, but there may issuesI Information Transaction was successful but includes information e.g., inform patientE Error Transaction was unsuccessfu
                                                         705                                      Application Error Code for 3-5-error.code, 3-5-error.text
n specific code identifying the specific error that occurred. Refer to User-Defined Table 0533 – code                                           If
                                                                                                                             suggested values.
 the message associated with the cod
                                                           80                                    text
 information to be used, together with the Application Error Code, to understand a particular error condition/warning/etc. This field can repeat to allow for up to 10 parameters.Ex
                                                        2048
 n that may be used by help desk or other support personnel to diagnose a problem.               text
                                                         250 from the actual error code and may provide more diagnostic information.
                                                                                                 text
 essage to be displayed to the application user. This differs This program is having trouble communicating with another system. Please contact the help desk.|
                                                           20 PAT
  PAT Inform patientNPAT Do NOT inform patientUSR Inform UserHD Inform help desk                 code
                                                         705 EXTN is being performed Override
                                                                                     y           code
  EXTN Extension Override Identifies an override where a service indicating Extensionfor longer than the ordered period of time.INLV Interval Override Identifies an override where
                                                         705                         y           code
 list of potential override codes that can be used to override enforcement of the application rule that generated the error. Refer to User-defined table 0519 - Override Reason for
                                                         652                         y
e, e-mail, fax, and other relevant numbers for helpdesk support related to the specified error.phone number, email address, +

                                                            1                                       n/a               m           The the separator FHT segments character to be used as
ontains the separator between the segment ID and the first real field, BHS-2-batch encoding characters. As such it serves as BHS, BTS, FHS,and defines thewere not mapped delibe
                                                            4                                       n/a               m
ontains the four characters in the following order: the component separator, repetition separator, escape characters, and subcomponent separator. Recommended values are ^~
                                                         227
 niquely identifies the sending application among all other applications within the y               identifier and name
                                                                                                                      o
                                                                                       network enterprise. The network enterprise consists of all those applications that participate in
                                                         227                           y             system. Absent other
                                                                                                                      o
ontains the address of one of several occurrences of the same application within the sending identifier and name considerations, the Medicare Provider ID might be used with a
                                                          other                        y            identifier and name
 niquely identifies the receiving applications among all227 applications within the network enterprise. The o         network enterprise consists of all those applications that participate i
                                                         227                           y            identifier and name
dentifies the receiving application among multiple identical instances of the application running on behalf of o      different organizations. See comments BHS-4-batch sending facility. E
                                                           the                                      datetime          o
ontains the date/time that the sending system created 24 message. If the time zone is specified, it will be used throughout the message as the default time zone.
                                                           40                                       text
 plications of HL7, this field is used to implement security features. Its use is not yet further specified.          o
                                                           20
an be used by the application processing the batch. It can have extra components if needed. identifier or code        o
  a comment field that is not further defined in the HL7 80protocol.                                text              o
                                                           20                                       identifier        o
  used to uniquely identify a particular batch. It can be echoed back in BHS-12-reference batch control ID if an answering batch is needed.
ontains the value of BHS-11-batch control ID when this 20                                           present if        o
                                                           batch was originally transmitted. Not identifier this batch is being sent for the first time. See definition for BHS-11-batch c
                                                         227                           y              (e.g., URI). The reader is referred to the "Report from the Joint W3C/IETF URI Planni
 f the network location the message was transmitted from. Identified by an OID or text stringidentifier and name      o                                  As with the Sending/Receiving Resp
                                                         227                           y            identifier and name
 f the network location the message was transmitted to. Identified by an OID or text string. (e.g., URL).This iso                                        This field should only in populated
                                                                                                                       analogous with the Sending Network Address, however be the receivi

ontains the count of the individual messages contained10 within the batch.                         count           o           2-1.message count
                                                        protocol.
 a comment field that is not further defined in the HL7 80                                         text            o           The BHS, BTS, FHS, FHT segments were not mapped delibe


             Pg 39 of 148                                                                         D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                                     DataReq-HL7-V2.6
                                                       100                                     count            o
age new users of this field to use the HL7 Version 2.3 data type of NM and to define it as "repeating." This field contains the batch total. If more than a single batch total exists, thi

                                                            1
as the same definition as the corresponding field in the MSH segment.                           n/a                m          The BHS, BTS, FHS, FHT segments were not mapped delibe
                                                            4
as the same definition as the corresponding field in the MSH segment.                           n/a                m
                                                          227
as the same definition as the corresponding field in the MSH segment.               y           identifier and nameo
                                                          227
as the same definition as the corresponding field in the MSH segment.               y           identifier and nameo
                                                          227
as the same definition as the corresponding field in the MSH segment.               y           identifier and nameo
                                                          227
as the same definition as the corresponding field in the MSH segment.               y           identifier and nameo
                                                            MSH
as the same definition as the corresponding field in the24 segment.                             datetime           o
                                                            MSH
as the same definition as the corresponding field in the40 segment.                             text               o
                                                           20
an be used by the application processing file. Its use is not further specified.                identifier or code o
                                                           80
ontains the free text field, the use of which is not further specified.                         text               o
                                                           20                                   identifier
 used to identify a particular file uniquely. It can be echoed back in FHS-12-reference file control ID.           o
                                                           20                                   identifier         o
ontains the value of FHS-11-file control ID when this file was originally transmitted. Not present if this file is being transmitted for the first time.
                                                          227                       y            (e.g., URI). The reader is referred to the "Report from the Joint W3C/IETF URI Planni
f the network location the message was transmitted from. Identified by an OID or text stringidentifier and name    o
                                                          227                       y           identifier and name
f the network location the message was transmitted to. Identified by an OID or text string. (e.g., URL).This iso    analogous with the Sending Network Address, however in the receivi

ontains the number of batches contained in this file.    10                                      count           o           The BHS, BTS, FHS, FHT segments were not mapped delibe
this free text field is not further specified.           80                                      text            o




            Pg 40 of 148                                                                        D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                                   DataReq-HL7-V2.6
urity.password
 gger event code




segment of data items is only used in acknowledgement messages




           Pg 41 of 148                                                       D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                 DataReq-HL7-V2.6
segment of data items is only used in acknowledgement messages




were not mapped deliberately.




e Sending/Receiving Responsible Organization, the Sending Network Address provides a more detailed picture of the source of the message. This information is lower than the ap
hould only be populated when the underlying communication protocol does not support identification receiving network locations.


were not mapped deliberately.


            Pg 42 of 148                                                                   D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                              DataReq-HL7-V2.6
were not mapped deliberately.




were not mapped deliberately.




           Pg 43 of 148                      D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                DataReq-HL7-V2.6
Pg 44 of 148                D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
               DataReq-HL7-V2.6
mation is lower than the application layer, but is often useful/necessary for routing and identification purposes. This field should only be populated when the underlying commun




           Pg 45 of 148                                                                    D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                              DataReq-HL7-V2.6
Pg 46 of 148                D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
               DataReq-HL7-V2.6
Pg 47 of 148                D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
               DataReq-HL7-V2.6
hen the underlying communication protocol does not support identification of sending network locations.




           Pg 48 of 148                                                                   D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                             DataReq-HL7-V2.6
        source document (from DataRequirements-Sources, D: file name)
SDO abbreviation    source (reference within the document) category                 data
                                                                          sub-category item name
                    Note: frequently when groups of data items were used in multiple places, they were documented just
                    Note: the category column is frequently used to indicate the hierarchy of groups of data items
HL7                 ballot
        V3 Jan 2009 (start): Specification Infrastructure/Messaging/Transmission Infrastructure/s 2.4.6 Message Transmi
                                                           Send Message Payload
                                                           message                  message.id
                                                                                    message.creationTime
                                                                                    message.securityText
                                                                                    message.responseModeCode
                                                                                    message.versionCode
                                                                                    message.interactionId
                                                                                    message.profileId
                                                                                    message.processingCode
                                                                                    message.processingModeCode
                                                                                    message.acceptAckCode
                                                                                    message.sequenceNumber
                                                           receiver
                                                                                    CommunicationFunction.typeCode
                                                                                    CommunicationFunction.telecom
                    (start): Device hierarchy              receiver/device
                                                                                    device.classCode
                                                                                    device.determinerCode
                                                                                    device.id
                                                                                    device.name
                                                                                    device.desc
                                                                                    device.existenceTime
                                                                                    device.telecom
                                                                                    device.manufacturerModelName
                                                                                    device.softwareName
                                                                          -receiver-device-agent
                                                           receiver/device/agent
                                                                                    asAgent/Role.classCode
                                                                          -receiver-device-agent-organization
                                                           receiver/device/agent/organization
                                                                                    representedOrganization.classCode
                                                                                    representedOrganization.determinerCode
                                                                                    representedOrganization.id
                                                                                    representedOrganization.name
                                                                                    representedOrganization.telecom
                                                           receiver/device/agent/organization/notificationParty
                                                                          -receiver-device-agent-organization-contactpartyrol
                    HL7 CMET (start): R_NotificationPartyContact COCT_MT040203UV01
                                                                                    classCode
                                                                                    id
                                                                                    code
                                                                                    addr
                                                                                    telecom
                                                           either (a) or (b) below, but not both, must be present, when rece
                                                           (a) receiver/device/agent/organization/notificationParty/organiz
                                                                          -receiver-device-agent-organization-contactparty-or
                                                                                    (includes
                    include 1. HL7 CMET: E_OrganizationContact COCT_MT150003UV03 all the data elements as listed els

                                                         (b) receiver/device/agent/organization/notificationParty/person
                                                                      -receiver-device-agent-organization-contactparty-pe
                      HL7 CMET (start): E_PersonContact COCT_MT030203UV

Pg 49 of 148                                  DataReq-HL7-V3
                                          D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                         classCode
                                                                         determinerCode
                                                                         id
                                                                         name
                                                                         telecom
                                                                         administrativeGenderCode
                                                                         birthTime
                                                                         addr
                                                               -receiver-device-agent-organization-contactparty-pe
                                                                         languageCommunication
                                                  (b) receiver/device/agent/organization/notificationParty/person
                                                                         languageCode
                                                                         modeCode
                                                                         proficiencyLevelCode
                                                                         preferenceInd
               HL7 CMET (end): E_PersonContact COCT_MT030203UV
               HL7 CMET (end): R_NotificationPartyContact COCT_MT040203UV01

               (end): Device hierarchy
                                                                         asLocatedEntity
                                                   receiver/device/LocatedEntity
                                                                         asLocatedEntity/Role.classCode
                                                   receiver/device/LocatedEntity/Place
                                                                         location/Place.classCode
                                                                         location/Place.determinerCode
                                                                         location/Place.id
                                                                         location/Place.name
                                                                         location/Place.telecom

                                                   respondTo
                                                                         CommunicationFunction.typeCode
                                                                         CommunicationFunction.telecom
                                                   respondTo/Device      (includes all the same data elements as ab

                                                   sender
                                                                         typeCode
                                                                         telecom
                                                   sender/Device         (includes all the same data elements as ab

                                                    attentionLineattentionLine
                                                                          attentionLine.keyWordText
                                                                          attentionLine.value
                                                    attachment attachment
                                                                          attachment.id
                                                                          attachment.text
               (end): Specification Infrastructure/Messaging/Transmission Infrastructure/s 2.4.6 Message Transmis

                                                      controlActProcess aka Trigger Event Control Act
                                                                  controlActProcess
               (start): Specification Infrastructure/Messaging/Message Control Act Infrastructure (Domain)/Trigger
                                                      ControlActProcess
                                                                            classCode

Pg 50 of 148                          DataReq-HL7-V3
                                  D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                         moodCode
                                                                         id
                                                                         code
                                                                         text
                                                                         effectiveTime
                                                                         priorityCode
                                                                         reasonCode
                                                                         languageCode

                                                  Overseer
                                                                     typeCode
                                                                     contextControlCode
                                                                     noteText
                                                                     time
                                                                     modeCode
                                                                     signatureCode
                                                                     signatureText
                                                                     (includes all
               include 5. HL7 CMET: R_AssignedPersonUniversal COCT_MT090100UV01the data elements as listed els

                                                  authorOrPerformer
                                                                         typeCode
                                                                         contextControlCode
                                                                         noteText
                                                                         time
                                                                         modeCode
                                                                         signatureCode
                                                                         signatureText

                                                                      participationChoice: none to may of either
                                                                      (includes all
               include 5. HL7 CMET: R_AssignedPersonUniversal COCT_MT090100UV01the data elements as listed els
                                                                      (includes all
               include 4. HL7 CMET: R_AssignedDeviceUniversal COCT_MT090300UV01the data elements as listed els

                                                  dataEnterer
                                                                     typeCode
                                                                     contextControlCode
                                                                     time
                                                                     (includes all
               include 5. HL7 CMET: R_AssignedPersonUniversal COCT_MT090100UV01the data elements as listed els

                                                  informationRecipient
                                                                     typeCode
                                                                     contextControlCode
                                                                     time
                                                                     (includes all
               include 5. HL7 CMET: R_AssignedPersonUniversal COCT_MT090100UV01the data elements as listed els

                                                  subject
                                                                         typeCode
                                                                         contextConductionInd

Pg 51 of 148                          DataReq-HL7-V3
                                  D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                              act (class representing the payload)

                                                      reasonOf
                                                                       typeCode
                                                                       contextConductionInd
               include 8. HL7 CMET: A_DetectedIssueUniversal COCT_MT900000UV
                                                  reasonOf/DetectedIssue

               (end): Specification Infrastructure/Messaging/Message Control Act Infrastructure (Domain)/Trigger E

               below here is just HL7 CMETs, listed in alphabetical order (e.g. A_... followed by E_... followed by R_...)

               1. HL7 CMET (start): E_OrganizationContact COCT_MT150003UV03
                                                   organization
                                                                        classCode
                                                                        determinerCode
                                                                        id
                                                                        code
                                                                        name
                                                   organization/ContactParty
                                                                        classCode
                                                                        id
                                                                        code
                                                                        addr
                                                                        telecom
                                                   organization/ContactParty/person
                                                                        classCode
                                                                        determinerCode
                                                                        name
               1. HL7 CMET (end): E_OrganizationContact [contact] COCT_MT150003UV03


               2. HL7 CMET (start): E_OrganizationUniversal COCT_MT070000UV01
                                                   Organization
                                                                      classCode
                                                                      determinerCode
                                                                      id
                                                                      code
                                                                      name
                                                                      desc
                                                                      statusCode
                                                                      telecom
                                                                      addr
                                                                      standardIndustyClassCode

                                                      Organization/OrganizationContains
                                                                           classCode

Pg 52 of 148                            DataReq-HL7-V3
                                    D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                        id
                                                                        code
                                                                        statusCode
                                                                        effectiveTime
                                                  Organization/OrganizationContains/Organization
                                                                        (includes all the data elements as listed in
                                                  Organization/OrganizationPartOf
                                                                        classCode
                                                                        id
                                                                        code
                                                                        statusCode
                                                                        effectiveTime
                                                  Organization/OrganizationContains/Organization
                                                                        (includes all the data elements as listed in
                                                  Organization/ContactParty
                                                                        classCode
                                                                        id
                                                                        code
                                                                        addr
                                                                        telecom
                                                  Organization/ContactParty/Person
                                                                        classCode
                                                                        determinerCode
                                                                        name
               include 6. HL7 CMET: R_LocationLocatedEntityUniversal COCT_MT070000UV01
                                                                        (includes all the data elements as listed els
                                                  Organization/ContactParty/Person/R_LocationLocatedEntityUniv
               2. HL7 CMET (end): E_OrganizationUniversal COCT_MT070000UV01


               3. HL7 CMET (start): R_AssignedDevice[contact] COCT_RM090309UV
                                                   AssignedDevice
                                                                        classCode
                                                                        id
                                                                        code
                                                                        addr
                                                                        telecom
                                                   AssignedDevice/Device
                                                                        device.classCode
                                                                        device.determinerCode
                                                                        device.id
                                                                        device.manufacturerModelName
                                                                        device.softwareName
                                                   Device/OrganizationContact
                                                                        (includes
               include 1. HL7 CMET: E_Organization[contact] COCT_MT1500003UV all the data elements as listed els
                                                   AssignedDevice/Device/Organization
               3. HL7 CMET (end): R_AssignedDevice[contact] COCT_RM090309UV2.5

               4. HL7 CMET (start): R_AssignedDeviceUniversal COCT_MT090300UV01

Pg 53 of 148                           DataReq-HL7-V3
                                   D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                  assigned device
                                                                         classCode
                                                                         id
                                                                         code
                                                                         addr
                                                                         telecom
                                                                         effectiveTime
                                                                         certificateText
                                                   assigned device/device
                                                                         classCode
                                                                         determinerCode
                                                                         manufacturerModelName
                                                                         softwareName
                                                   assigned device/device/RoleOther
                                                                         classCode
                                                                         id
                                                                         (includes
               include 2. HL7 CMET: E_OrganizationUniversal COCT_MT070000UV01 all the data elements as listed els

                                                  assigned device/device/RoleOther/organization
                                                  assigned device/device/Member
                                                                        classCode
                                                                        id
                                                                        code
                                                                        addr
                                                                        telecom
                                                                        statusCode
                                                                        effectiveTime
                                                  assigned device/device/Member/Group
                                                                        classCode
                                                                        determinerCode
                                                                        id
                                                                        code
                                                                        name
                                                                        desc

                                                  location              (includes all the data
               include 6. HL7 CMET: R_LocationLocatedEntityUniversal COCT_MT070000UV01 elements as listed els
                                                  assigned device/device/LocationLocatedEntity

                                                  assigned device/device/LanguageCommunication
                                                                        languageCode
                                                                        modeCode
                                                                        proficiencyLevelCode
                                                                        preferenceInd
                                                  assigned device/device/LicensedEntity
                                                                        classCode
                                                                        id
                                                                        code

Pg 54 of 148                          DataReq-HL7-V3
                                  D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                         effectiveTime
                                                                         (includes
               include 1. HL7 CMET: E_OrganizationContact COCT_MT150003UV03 all the data elements as listed els
                                                   assigned device/device/LicensedEntity/organization
               4. HL7 CMET (end): R_AssignedDeviceUniversal COCT_MT090300UV01


               5. HL7 CMET (start): R_AssignedPersonUniversal COCT_MT090100UV01
                                                   AssignedPerson
                                                                     classCode
                                                                     id
                                                                     code
                                                                     addr
                                                                     telecom
                                                                     effectiveTime
                                                                     certificateText

                                                              assignedPrincipalChoiceList
                                                  AssignedPerson/Person
                                                              Person
                                                                       classCode
                                                                       determinerCode
                                                                       name

                                                   AssignedPerson/Person/LicensedEntity
                                                               asLicensedEntity
                                                                        classCode
                                                                        id
                                                                        code
                                                                        effectiveTime
                                                                        (includes
               include 1. HL7 CMET: E_OrganizationContact COCT_MT150003UV03 all the data elements as listed els

                                                  AssignedPerson/Person/LicensedEntity/organization

                                                  AssignedPerson/Person/Member
                                                                      classCode
                                                                      id
                                                                      code
                                                                      addr
                                                                      telecom
                                                                      statusCode
                                                                      effectiveTime
                                                                      group
                                                  AssignedPerson/Person/Member/group
                                                                      classCode
                                                                      determinerCode
                                                                      id
                                                                      code
                                                                      name

Pg 55 of 148                          DataReq-HL7-V3
                                  D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                           desc

                                                   AssignedPerson/Person/RoleOther
                                                                       classCode
                                                                       id
                                                                       (includes
               include 2. HL7 CMET: E_OrganizationUniversal COCT_MT070000UV01 all the data elements as listed els
                                                   AssignedPerson/Person/RoleOther/organization

                                                                        (includes all the data
               include 6. HL7 CMET: R_LocationLocatedEntityUniversal COCT_MT070000UV01 elements as listed els
                                                  AssignedPerson/Person/R_LocationLocatedEntity

                                                    AssignedPerson/Person/languageCommunication
                                                                languageCommunication
                                                                         languageCode
                                                                         modeCode
                                                                         proficiencyLevelCode
                                                                         preferenceInd

               include 2. HL7 CMET: E_OrganizationUniversal              (includes all the data elements as listed els
                                                   AssignedPerson/organization
                                                               (group related to Overseer)
               5. HL7 CMET (end): R_AssignedPersonUniversal COCT_MT090100UV01


               6. HL7 CMET (start): R_LocationLocatedEntityUniversal COCT_MT070000UV01
                                                   LocatedEntity
                                                                        classCode
                                                                        id
                                                                        addr
                                                                        telecom
                                                                        statusCode
                                                                        effectiveTime

               6.1 HL7 CMET (start): E_Place [universal] COCT_MT710000UV
                                                    LocatedEntity/Place
                                                                        classCode
                                                                        determinerCode
                                                                        id
                                                                        code
                                                                        name
                                                                        desc
                                                                        addr
                                                                        directionsText
                                                                        positionText

                                                    LocatedEntity/Place/LocatedEntityPartOf
                                                                asLocatedEntityPartOf
                                                                         classCode

Pg 56 of 148                           DataReq-HL7-V3
                                   D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                       id
                                                  LocatedEntity/Place/LocatedEntityPartOf/Place
                                                                       (includes all the data elements as listed in

                                                  LocatedEntity/Place/LocatedEntityHasParts
                                                              locatedEntityHasParts
                                                                       classCode
                                                                       id
                                                  LocatedEntity/Place/LocatedEntityHasParts/Place
                                                                       (includes all the data elements as listed in

                                                   LocatedEntity/Place/LocatedEntity
                                                                        classCode
                                                   LocatedEntity/Place/LocatedEntity/subjectOf
                                                                        typeCode
               6.1.1. HL7 CMET (start): A_SpacialCoordinateUniversal COCT_MT960000UV
                                                   LocatedEntity/Place/LocatedEntity/subjectOf/Position
                                                               Position
                                                                        classCode
                                                                        moodCode
                                                                        id
                                                                        code
                                                                        text
                                                                        effectiveTime
                                                                        activityTime
                                                                        value
                                                   LocatedEntity/Place/LocatedEntity/subjectOf/Position/compone
                                                                        typeCode
                                                                        contextControlCode
                                                                        contextConductionInd
                                                   PositionAccuracy
                                                                        classCode
                                                                        moodCode
                                                                        code
                                                                        value

                                                  LocatedEntity/Place/LocatedEntity/subjectOf/Position/compone
                                                                       typeCode
                                                                       contextControlCode
                                                                       contextConductionInd
                                                                       sequenceNumber
                                                  PositionCoordinate
                                                                       classCode
                                                                       moodCode
                                                                       code
                                                                       text
                                                                       value

Pg 57 of 148                          DataReq-HL7-V3
                                  D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                         methodCode
                                                  LocatedEntity/Place/LocatedEntity/subjectOf/Position/device
                                                                         typeCode
                                                                         contextControlCode
               include 3. HL7 CMET: R_AssignedDevice[contact] COCT_RM090309UV
                                                                         (includes all the data elements as listed els
                                                  LocatedEntity/Place/LocatedEntity/subjectOf/Position/device
                                                                         typeCode
                                                                         contextControlCode
               include 3. HL7 CMET: R_AssignedDevice[contact] COCT_RM090309UV
                                                                         (includes all the data elements as listed els
                                                  LocatedEntity/Place/LocatedEntity/subjectOf/Position/author
                                                                         typeCode
                                                                         contextControlCode
               include 7. HL7 CMET: R_AssignedPerson[identified/informational] COCT_RM090108UV

               6.1.1. HL7 CMET (end): A_SpacialCoordinateUniversal COCT_MT960000UV
               6.1 HL7 CMET (end): E_Place [universal] COCT_MT710000UV
               6. HL7 CMET (end): R_LocationLocatedEntity [universal] COCT_MT070000UV01

               7. HL7 CMET (start): R_AssignedPerson[identified/informational] COCT_RM090108UV
                                                   AssignedPerson
                                                                        classCode
                                                                        id
                                                                        code
                                                                        addr
                                                                        telecom

                                                    AssignedPerson/Person
                                                                        classCode
                                                                        determinerCode
                                                                        name

               7.1 HL7 CMET (start): E_OrganizationInformational COCT_MT150007UV
                                                   AssignedPerson/Person/organization
                                                               organization
                                                                         classCode
                                                                         determinerCode
                                                                         id
                                                                         code
                                                                         name
                                                   AssignedPerson/Person/organization
                                                               contactParty
                                                                         classCode
                                                                         id
                                                                         code
                                                                         addr

Pg 58 of 148                           DataReq-HL7-V3
                                   D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                       telecom
                                                  AssignedPerson/Person/organization/contactPerson
                                                              contactPerson
                                                                       classCode
                                                                       determinerCode
                                                                       name
               7.1 HL7 CMET (end): E_OrganizationInformational COCT_MT150007UV
               7. HL7 CMET (end): R_AssignedPerson[identified/informational] COCT_RM090108UV


               8. HL7 CMET (start): A_DetectedIssueUniversal COCT_MT900000UV
                                                   DetectedIssue
                                                                        classCode
                                                                        moodCode
                                                                        id
                                                                        code
                                                                        text
                                                                        value
                                                   DetectedIssue/mitigatedBy
                                                               mitigatedBy
                                                                        typeCode
                                                                        contextConductionInd
                                                   DetectedIssue/mitigatedBy/detectedIssueManagement
                                                                        classCode
                                                                        moodCode
                                                                        code

                                                  DetectedIssue/triggerFor
                                                                        typeCode
                                                                        contextConductionInd
                                                                        negationInd
                                                  DetectedIssue/triggerFor/actOrderRequired
                                                                        classCode
                                                                        moodCode
                                                                        code
                                                                        effectiveTime
                                                  DetectedIssue/triggerFor/actOrderRequired/subject
                                                                        typeCode
                                                  DetectedIssue/triggerFor/actOrderRequired/subject/role
                                                                        classCode
                                                                        code
               8. HL7 CMET (end): A_DetectedIssue A_DetectedIssueUniversal COCT_MT900000UV




Pg 59 of 148                          DataReq-HL7-V3
                                  D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                         definition        domain specification - format - length: minimum maximum value
             alias(es) (includes presentation label) - range                         - length: example usage(s)
aces, they were documented just once, at the end in numbered sequence. In HL7 these are referred to as Common Message Element Type
 y of groups of data items
ructure/s 2.4.6 Message Transmission (MCCI_RM002100UV) Message Transmission Wrapper

                   A unique identifier for this transmission (mandatory). It will never be reused in time, nor will it be used by another
 creationTime      The time that the transmission was created, as opposed to the time of some event that the message/batch may be
 securityText      specified for applications to implement security features for a transmission (optional). Its use is not further specifie
 responseModeCode Identifies the timing and delivery method of the Application Response Transmission as required by the initiating sys
 versionCode       The HL7 version used by the sending system (optional); matched by the receiving system to its own version to be su
 interactionId     The identification of the unique information interchange. The attribute values are derived from the HL7 MDF intera
                   The identification of one or more message profiles (optional). The sender indicates that the message conforms to t
 processingCode    defines whether the message is part of a production, training, or debugging system.
 processingModeCodedefines whether the message is being sent in current processing (the usual mode), archive mode, initial load mode,
 acceptAckCode     identifies the conditions under which accept acknowledgements are required to be returned in response to this me
 sequenceNumber    provided for implementing the sequence number protocol (incremented by one for each subsequent value assignm

icationFunction.typeCode                   constant: RCV                                                         n/a
icationFunction.telecom

                                           constant: DEV                                                         n/a
eterminerCode                              constant: INSTANCE                                                    n/a




 istenceTime

anufacturerModelName
ftwareName

 Role.classCode                           constant: AGNT                                                         n/a
gent-organization      the organization for which the sender receiver device is acting as an agent
 tedOrganization.classCode                constant: ORG                                                          n/a
 tedOrganization.determinerCode           constant: INSTANCE                                                     n/a
 tedOrganization.id
 tedOrganization.name
 tedOrganization.telecom
                       the contact
gent-organization-contactpartyroleparty for the organization for which the receiver device is acting as an agent; (contains contact informa
                                          constant: CON




both, must be present, when receiver/device/agent/organization/notificationParty above is valued
                       identifies a party (person or organization) acting as a contact party on behalf of a person or organization (scoper)
 all the data elements as listed elsewhere for this HL7 CMET)

                      A subtype of LivingSubject representing a human being
gent-organization-contactparty-person

            Pg 60 of 148                                    DataReq-HL7-V3
                                                        D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                           constant: PSN
                     Structural attribute; this is a "person" entity                                            n/a
                                           constant: INSTANCE
                     Structural attribute; this is a specific person                                            n/a
                     Identifier(s) for this person. Note that these identifiers can only be used for matching purposes since no scoping org
                     Name(s) for this person
                     Telecommunication address(es) for communicating with this person
rativeGenderCode     A value representing the gender (sex) of this person. Note: this attribute does not include terms related to clinical g
                     The date and time this person was born. This could be an exact moment such as January 1, 1960 @ 03:00:00 EST or
                     Address(es) for corresponding with this person
Communication        A language communication capability of the focal person
                     A value representing a language for which the focal person has some level of proficiency for written or spoken com
                     A value representing the person's method of expression of this language Examples: expressed spoken, expressed w
cyLevelCode          A value representing the person's level of proficiency in this language. Examples: excellent, good, fair, poor
                     An indicator specifying whether or not this language is preferred by the focal person for the associated mode




dEntity/Role.classCode                  constant: LOCE                                                         n/a

Place.classCode                         constant: PLC                                                          n/a
Place.determinerCode                    constant: INSTANCE                                                     n/a


Place.telecom


icationFunction.typeCode                constant: RSP                                                          n/a
icationFunction.telecom
 all the same data elements as above under receiver/Device hierarchy)


                                        constant: SND                                                          n/a

all the same data elements as above under receiver/Device hierarchy)                                           destination for accept-leve


Line.keyWordText




ucture/s 2.4.6 Message Transmission (MCCI_RM002100UV) Message Transmission Wrapper

                     the trigger event control act wrapper

                                        constant: CACT

           Pg 61 of 148                                   DataReq-HL7-V3
                                                      D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                      The x_ActMoodIntentEvent domain has been defined for this attribute to specify actual and intended events.
                      The identifier that has been designated for the control act or notification.
                      The code indicates the Trigger Event of the act or the notification that has been sent. The values are derived from t
                      The text attribute can be used to convey a textual or multimedia description of the Act.
                      The date and time on which the control act or notification was composed and authorized for transmission, i.e. the d
                      A code, or a set of codes, that identifies the circumstances in which the event happened, shall happen, is planned t
                      A code specifying the motivation, cause, or rationale of the Act. The reasonCode should only be used for common r
                      The primary language in which this Act statement is specified, particularly the language of the text attribute.

                      There are zero to many overseers for a control act. In some cases but by no means all, it is relevant to record inform




                      An assigned role is for in which the agent is an Entity acting in the employ of an organization. The focus is on funct
all the data elements as listed elsewhereone this HL7 CMET)                                                     n/a

                      There are zero to many parties recorded as author or performer for a control act.The author of an act is the person




tionChoice: none to may of either one (but not noth) of the following HL7 CMET: R_AssignedPerson or HL7 CMET: R_AssignedDeviceUnive
                       An assigned role is for in which the agent is an Entity acting in the employ of an organization. The focus is on funct
 all the data elements as listed elsewhereone this HL7 CMET)
 all the data elements as listed elsewhere for this HL7 CMET)

                      If relevant, the party who enters data associated with the control act may be recorded. It is possible for multiple pa




                      An assigned role is for in which the agent is an Entity acting in the employ of an organization. The focus is on funct
all the data elements as listed elsewhereone this HL7 CMET)

                      There are zero to many designated information recipients for a control act. These are the parties who are intended




                      An assigned role is for in which the agent is an Entity acting in the employ of an organization. The focus is on funct
all the data elements as listed elsewhereone this HL7 CMET)

                      The control act has zero to many subject acts. Note that multiple subject acts should be of the same type (for easy

onductionInd

            Pg 62 of 148                                    DataReq-HL7-V3
                                                        D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
representing the payload)


                                            constant: RSN                                                        n/a
onductionInd           If true, associations in the control act are conducted across the reason to the DetectedIssueEvent




nfrastructure (Domain)/Trigger Event Control Act MCAI_HD700200UV (found in unziptohere/html/domains/uvai/editable/MCAI_RM7

llowed by E_... followed by R_...)


                       identifies a party (person or organization) acting as a contact party on behalf of a person or organization (scoper)
                                            constant: ORG                                                         n/a
                                            constant: INSTANCE                                                    n/a




                                          constant: ORG




                                          constant: PSN                                                          n/a
                                          constant: INSTANCE                                                     n/a




IndustyClassCode




            Pg 63 of 148                                    DataReq-HL7-V3
                                                        D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
ains/Organization
 all the data elements as listed in this section above just in the category Organization)




ains/Organization
 all the data elements as listed in this section above just in the category Organization)

                                           constant: CON




                                           constant: PSN                                                        n/a
                                           constant: INSTANCE                                                   n/a


all the data elements as listed elsewhere for this HL7 CMET)




                                           constant: DEV                                                        n/a
eterminerCode                              constant: INSTANCE                                                   n/a

anufacturerModelName
ftwareName
all the data elements as listed elsewhere for this HL7 CMET)




                       supports messages related to an assigned provider, as a device. An assigned role is one in which the agent is an Ent

            Pg 64 of 148                                     DataReq-HL7-V3
                                                         D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                          constant: ASSIGNED




                      Device (PrincipalChoiceList)
                                         constant: DEV
                                         constant: INSTANCE
turerModelName


                                          constant: ROL

 all the data elements as listed elsewhere for this HL7 CMET)

her/organization

                                          constant: MBR




                                          constant: RGRP
                                          constant: INSTANCE




 all the data elements as listed elsewhere for this HL7 CMET)
nLocatedEntity

geCommunication


cyLevelCode


                                          constant: LIC




            Pg 65 of 148                                      DataReq-HL7-V3
                                                          D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
 all the data elements as listed elsewhere for this HL7 CMET)
dEntity/organization




                       An assigned role is one in which the agent is an Entity acting in the employ of an organization. The focus is on funct

                                          constant: ASSIGNED                                                     n/a




                                          constant: PERSON                                                       n/a
                                          constant: INSTANCE                                                     n/a




                                          constant: LIC                                                          n/a




all the data elements as listed elsewhere for this HL7 CMET)

dEntity/organization


                                          constant: MBR                                                          n/a




                                          constant: RGRP                                                         n/a
                                          constant: INSTANCE                                                     n/a




            Pg 66 of 148                                      DataReq-HL7-V3
                                                          D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                         constant:                                                           n/a

all the data elements as listed elsewhere for this HL7 CMET)
her/organization

all the data elements as listed elsewhere for this HL7 CMET)
tionLocatedEntity

geCommunication

                      A value representing a language for which the focal person has some level of proficiency for written or spoken com
                      A value representing the person's method of expression of this language Examples: expressed spoken, expressed w
cyLevelCode           A value representing the person's level of proficiency in this language. Examples: excellent, good, fair, poor
                      An indicator specifying whether or not this language is preferred by the focal person for the associated mode

all the data elements as listed elsewhere for this HL7 CMET)
                      represented organization




                                         constant: PLC
                                         constant: INSTANCE




                                         constant: LOCE

           Pg 67 of 148                                   DataReq-HL7-V3
                                                      D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
tityPartOf/Place
 all the data elements as listed in this section above just in the category LocatedEntity/Place)

tityHasParts

                                           constant: LOCE

tityHasParts/Place
 all the data elements as listed in this section above just in the category LocatedEntity/Place)


                                           constant: LOCE
tity/subjectOf
                                           constant: SBJ

tity/subjectOf/Position




tity/subjectOf/Position/component2


onductionInd




tity/subjectOf/Position/component1


onductionInd




               Pg 68 of 148                                    DataReq-HL7-V3
                                                           D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
tity/subjectOf/Position/device


                       used to identify the reference DB,or other device used to obtain a position or coordinate. Allows identification of th
 all the data elements as listed elsewhere for this HL7 CMET)
tity/subjectOf/Position/device


                       used to identify the reference DB,or other device used to obtain a position or coordinate. Allows identification of th
 all the data elements as listed elsewhere for this HL7 CMET)
tity/subjectOf/Position/author


CT_RM090108UV




CT_RM090108UV

                                          constant: ASSIGNED




                      assigned person
                                          constant: PSN
                                          constant: INSTANCE


                      represented organization




            Pg 69 of 148                                    DataReq-HL7-V3
                                                        D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
ation/contactPerson




CT_RM090108UV




                           constant: ALRT
                           constant: EVN




                           constant: MITGT
onductionInd
ectedIssueManagement
                           constant: ACT




                           constant: TRIG
onductionInd

derRequired
                           constant: ACT
                           constant: RQO


derRequired/subject
                           constant: SBJ
derRequired/subject/role
                           constant: ROL                                          patient, help desk, user

T_MT900000UV




           Pg 70 of 148                        DataReq-HL7-V3
                                           D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                    datatype: o/m/c:     multiple occurrences (y or maximum
                                                    dependent business rules/constraints
                                                               data item context) model
                                                                             domain   Combined Envelope mapping note
                                                                                               Note
          compound indicator analysis optional, mandatory, conditional (in list number) reference
mon Message Element Types (CMET).




                          identifier application. As such, it can serve to reliably allow an acknowledgment transmission to refer to the tran
r will it be used by another sending m                                                 1-1.identifier
                          datetime m
 the message/batch may be describing.                                                  1-1.datetime
                          text
ts use is not further specified at thisotime.                                          3-4-security.username, 3-4-security.password
                          code         m
 equired by the initiating system. ResponseModeCode can have one of three values: I (Immediate, the receiver should act as if the Sender
                          code         o                                               version indicates the
m to its own version to be sure the transmission will be interpreted correctly. This 3-1.syntax identifier publication "package" as a whole.
                          identifier m
ed from the HL7 MDF interaction names, examples include "POLB_IN100100" and "COMT_IN300652". The receiver responsibilities, includ
                          identifier o            y                                    3-1.profile identifier
 the message conforms to these message profiles; a receiving system may use this to correctly validate and interpret the message.
                          code         m                                               3-1.processing environment code
                          code
 ve mode, initial load mode, restorem   from archive mode, etc.
                           message. The value of this attribute is constrained to NE for accept-level acknowledgements, and ER for all other
 rned in response to thiscode          m
                          sequence o
h subsequent value assignment). number
                                       m
                          code         m
                                       o
                          telcommunications address

                         code        m                                                                    online only
                         code        m                                                                    online only
                         identifier m            y                                                        online only
                                     o           y
                         name (other than person, organization)                                           online only
                         text        o                                                                    online only
                         amount (of otime)                                                                online only
                                     o           y
                         telcommunications address                                                        online only
                                     o
                         name (other than person, organization)                                           online only
                                     o
                         name (other than person, organization)                                           online only
                                     o
                         code        m
                                     o
                         code        m
                         code        m
                         identifier m            y
                                     o
                         organization name       y
                                     o           y
                         telcommunications address
                                     o
 ; (contains contact information either for a person or for a department at the organization)
                         code        c
                         identifier c            y
                         code        o
                         address     o/c         y                                                        either address or telecom must b
                                     o/c         y
                         telcommunications address                                                        either address or telecom must b

n or organization (scoper)          o                                                                     either the E_OrganizationContac
                                                                                                          HL7 V3 and NCPDP-Telecom-Rea
                        n/a         o

            Pg 71 of 148                                    DataReq-HL7-V3
                                                        D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                         code        c
                         code        c
                          organization
urposes since no scopingidentifier c or status y information is included.
                         person name c           y                      either name or administrativeGenderCodr, or birthTime must be va
                                     o           y
                         telcommunications address                      either telecom or addr must be valued
                         code        o                                  either name or administrativeGenderCodr, multiple observations in
de terms related to clinical gender which is a complex physiological, genetic and sociological concept that requiresor birthTime must be va
                         datetime o
y 1, 1960 @ 03:00:00 EST or an approximate date such as January 1960.   either name or administrativeGenderCodr, or birthTime must be va
                         address     o           y                      either telecom or addr must be valued
                                     o           y
                         code        c
y for written or spoken communication. Examples: Spanish, Italian, German, English, American Sign
                         code        o
ressed spoken, expressed written, expressed signed, received spoken, received written, received signed
ent, good, fair, poor    code        o
 the associated mode indicator o




                                   o
                        code       c
                                   o
                        code       c
                        code       c
                        identifier c         y
                                   o         y
                        name (other than person, organization)
                                   o         y
                        telcommunications address

                                 o           y
                        code     c
                                 o
                        telcommunications address
                                                                                                         online only


                         code      m
                                   o
                         telcommunications address
                                   m
 destination for accept-level acknowledgement interactions                                               online only

                                   o          y
                        text       c
                                   o
                        <could be any datatype>
                                   o          y
                        identifier c
                                   c
                        encoded data


                                                                                                         Most of Trigger Event Control Ac
                        n/a        m
                        code       m

            Pg 72 of 148                                   DataReq-HL7-V3
                                                       D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
 and intended events. code            m
                           identifier o          y
                           code       o
 e values are derived from the MDF, examples include "COMT_TE200200" or "QURX_TE100001". The codeSystem identifies the HL7 organ
                           text       o
                           datetime o
 d for transmission, i.e. the date and time the event occurred that triggered the interaction. This date and time will normally differ from th
                           code       o          y
d, shall happen, is planned to happen, or requested to happen. The default value is R for routine.
                           code       o
 only be used for common reasons that are not y  related to a prior Act or any other condition expressed in Acts. Example reasons that might
 of the text attribute. code          o

                           n/a        o          y
 t is relevant to record information about a person who oversees the work of the acts' author or performer. This is particularly relevant in i
                           code       m
                           code       o
                           text       o
                                      o
                           amount of time
                           code       o
                           code       o
                           text       o
               m           y

                          n/a        o          y
 thor of an act is the person who takes responsibility for its creation. This could be the doctor who orders a test or the public health profes
                          code       m
                          code       o
                          text       o
                                     o
                          amount of time
                          code       o
                          code       o
                          text       o

                          n/a
MET: R_AssignedDeviceUniversal
                          n/a         c
 ation. The focus is on functional role on behalf of the organization,
                          n/a         c

                           n/a          provide data entry.
 It is possible for multiple parties to o          y
                           code         m
                           code         y
                                        y
                           amount of time
                           n/a          m
 ation. The focus is on functional role on behalf of the organization,

                          n/a         o          y
 e parties who are intended to receive the information that is included in the message. Information recipients are differentiated from mess
                          code        m
                          code        y
                                      y
                          amount of time
                          n/a         m
 ation. The focus is on functional role on behalf of the organization,

                         n/a        o          m
  of the same type (for easy and reasonable binding in the XML ITS). This class provides an entry point into the data structure that is conve
                         code       m
                         indicator o

             Pg 73 of 148                                     DataReq-HL7-V3
                                                          D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                      n/a         m                 10

                      n/a         o         y
                      code
                      indicator
                      n/a         o         y


/uvai/editable/MCAI_RM700200UV.htm)




                        n/a
n or organization (scoper)         m                                                              either the E_OrganizationContac
                        code       m
                        code       m
                        identifier m         y
                        code       o
                                   o
                        organization name    y
                                   c         y                   either addr or telecom in ContactParty or the ContactParty/Person
                        code       m
                        identifier o         y
                        code       c
                        address    c         y
                                   o         y
                        telcommunications address
                        n/a        o
                        code       m
                        code       m
                        person namec         y




                               m
                      code     m
                      code     m
                      code     m           y
                      code     o
                               o
                      name-organization    y
                      text     o
                      code     o
                               o
                      telcommunications address
                      address  o           y
                      code     o

                                  o         y
                      code        m

           Pg 74 of 148                                 DataReq-HL7-V3
                                                    D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                       identifier   o          y
                       code         o
                       code         o
                       datetime     o
                                    o

                                    o          y
                       code         m
                       identifier   o          y
                       code         o
                       code         o
                       datetime     o
                                    o

                                  o         y
                       code       o
                       identifier o         y
                       code       o
                       address    o         y                                                             either address or telecom must b
                                  o         y
                       telcommunications address                                                          either address or telecom must b
                                  o
                       code       m
                       code       m
                       person nameo         y
                                  o




                       code       m                                    either add, telecom, or the Device must be valued
                       identifier m         y
                       code       o
                       address    o         y
                                  o         y
                       telcommunications address
                                  o
                       code       m                                                                       online only
                       code       m                                                                       online only
                       identifier o         y                                                             online only
                                  o
                       name (other than person, organization)                                             online only
                                  o
                       name (other than person, organization)                                             online only




n which the agent is an Entity action in the employ of an organization. The focus is on the functional role on behalf of the organization.

           Pg 75 of 148                                     DataReq-HL7-V3
                                                        D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                      m
           code       m
           identifier o         y
           code       o
           address    o         y
                      o         y
           telcommunications address
           datetime o
           text       o
                      o
           code       m
           code       m
           name-othero
           name-othero
                      o         y
           code       m
           identifier m         y
                      o


                      o         y
           code       m
           identifier o         y
           code       o
                      o         y
                      o         y
           telcommunications address
           code       o
                      o
                      m
           code       m
           code       m
           identifier o
           code       o
           name-othero
           text       o

                       o




           code       o
           code       o
           code       o
           indicator  o
                      o        y
           code       m
           identifier o        y
           code       o

Pg 76 of 148                               DataReq-HL7-V3
                                       D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                   o
                                   o




                         n/a         m          of
ation. The focus is on functional role on behalfy the organization,
                                     m
                         code        m
                         identifier o           y
                         code        o
                         address     o          y
                                     o          y
                         telcommunications address
                         datetime o
                         encoded datao

                                 o
                                 o
                                 ?
                       code      m
                       code      m
                                 m
                       person name            y


                                  o           y
                       code       c
                       identifier o           y
                       code       o
                       datetime o
                                  o




                                  o         y
                       code       m
                       identifier o         y
                       code       o
                       address    o         y
                                  o         y
                       telcommunications address
                       code       o
                       datetime o
                                  m
                       code       m
                       code       m
                       identifier o         y
                       code       o
                                  o
                       organization name    y

           Pg 77 of 148                                    DataReq-HL7-V3
                                                       D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                       text        o

                                  o           y
                       code       m
                       identifier m           y
                                  o
                                  o

                                   o
                                   o


                                   o          y
                         code      o
y for written or spoken communication. Examples: Spanish, Italian, German, English, American Sign
                         code      o
ressed spoken, expressed written, expressed signed, received spoken, received written, received signed
ent, good, fair, poor    code      o
 the associated mode indicator o

                                   o
                                   o




                                  m
                       code       m
                       identifier o         y
                       address    o         y
                                  o         y
                       telcommunications address
                       code       o
                       datetime o

                                  o
                                  o
                       code       m
                       code       m
                       identifier o           y                      one of id, addr, telecom, location (sic) must be valued
                       code       o
                       name-othero            y
                       text       o
                       address    o
                       text       o
                       text       o

                                   o          y

                                   m

            Pg 78 of 148                                  DataReq-HL7-V3
                                                      D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
           code         o    o
                        m
                        m

                        o    y

           code       m
           identifier o      o
                      m
                      m

                        o
           code         m

           code         m
                        o?   y


           code         m
           code         m
           identifier   o
           code         o
           text         o
           datetime     o
           datetime     o
           ?            o
           o?
           code         m
           code         o
                        o
                        o
           code         m
           code         m
           code         o
           ?            o

           o?        y
           code      m
           code      o
           indicator o
                     o
           sequence number

           code         m
           code         m
           code         o
           text         o
           ?            o

Pg 79 of 148                         DataReq-HL7-V3
                                 D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                         code        o
                         o?
                         code        m
                         code        o
                                     o         y
e. Allows identification of the Reference DB name, version, manufacturer, etc.

                       o?
                                     m
                         code        o
                         code        o         y
e. Allows identification of the Reference DB name, version, manufacturer, etc.

                                    o
                       code         m
                       code         o
                                    o




                                                                     either addr or telecom or assignee must be valued
                       code       m
                       identifier m         y
                       code       o
                       address    o         y
                                  o         y
                       telcommunications address

                                 o
                       code      m
                       code      m
                                 m
                       name-person            y

                                    o
                                                                     one of id, code, name must be valued

                       code       m
                       code       m
                       identifier o           y
                       code       o
                                  o
                       name-organization      y
                                  m           y
                                                                     addr, telecom or ContactPerson must be valued
                       code         m
                       identifier   o         y
                       code         o
                       address      o         y

           Pg 80 of 148                                    DataReq-HL7-V3
                                                       D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                 o          y
                       telcommunications address
                                 o
                                 o
                       code      m
                       code      m
                                 m
                       name-person          y




                       code         m
                       code         m
                       identifier   o
                       code         o
                       text         o
                       text?        o


                       code         m
                       indicator    o                           must equal false
                                    o      y
                       code         m
                       code         m
                       code         o


                       code     m
                       indicatoro
                       indicatoro
                                o          y
                       code     m
                       code     m
                       code     o
                       datetime o

                       code         m

lp desk, user          code         m      y
                       code         o




            Pg 81 of 148                               DataReq-HL7-V3
                                                   D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
, 3-4-security.password




online only
online only
online only
online only
online only
online only
online only
online only
online only




either address or telecom must be valued
either address or telecom must be valued

either the E_OrganizationContactor or the E_PersonContact must be valued
HL7 V3 and NCPDP-Telecom-RealTime have same concept (help desk phone)



              Pg 82 of 148                             DataReq-HL7-V3
                                                   D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
derCodr, or birthTime must be valued

derCodr, or birthTime must be valued
derCodr, or birthTime must be valued




online only




online only




Most of Trigger Event Control Act, the below data items, is likely not applicable to the envelope




              Pg 83 of 148                                 DataReq-HL7-V3
                                                       D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
Pg 84 of 148       DataReq-HL7-V3
               D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
 either the E_OrganizationContactor or the E_PersonContact must be valued




Party or the ContactParty/Person must be valued




           Pg 85 of 148                                 DataReq-HL7-V3
                                                    D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
either address or telecom must be valued
either address or telecom must be valued




 must be valued




online only
online only
online only
online only
online only




e on behalf of the organization.

              Pg 86 of 148                     DataReq-HL7-V3
                                           D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
Pg 87 of 148       DataReq-HL7-V3
               D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
Pg 88 of 148       DataReq-HL7-V3
               D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
(sic) must be valued




           Pg 89 of 148       DataReq-HL7-V3
                          D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
Pg 90 of 148       DataReq-HL7-V3
               D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
e must be valued




must be valued




            Pg 91 of 148       DataReq-HL7-V3
                           D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
SDO abbreviation                          source (reference within the file name)
                                                                    category                  data
                   source document (from DataRequirements-Sources, D:document) sub-category item name               definition domain label)
                                                                                                       alias(es) (includes presentationspecification
IHE                IHE_ITI-TF_supp_XDP_PC_2006-06-06.pdf
                                                                    XDSDocumentEntry Attribute
                   p 25                                                                       hash                  When used in the Register Document Se
                                                                                              size                  When used in the Register Document Se
                                                                                              URI                   When used in the Register Document Se
                                                                                              appears               Represents the organization(s) and/or p
                                                                                  intendedRecipient to be semi-structured




Pg 92 of 148                                                                D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                               DataReq-IHE-XDP
             - range     - format               - length: example usage(s)
                                    - length: minimum maximum value               compound indicator analysis optional, mandatory, conditional (in list number) reference
                                                                                           datatype: o/m/c:                 dependent business rules/constraints
                                                                                                                                       data item context) model
                                                                                                                 multiple occurrences (y or maximum  domain


                                                            da39a3ee5e6b4b0d3255bfef95601890afd80709
                                                                                                hash value                                                 3-1.checksum
d in the Register Document Set transaction, this contains the hash key of the XDS Document itself This value is used by the recipient for detecting the improper resubmission of Do
                                                                                                count                                                      3-1.length
d in the Register Document Set transaction, this contains the size in bytes of the byte stream that was provided in the Register and Provide Transaction and stored by the XDS Docu
                                                                                                internet address
d in the Register Document Set transaction, this contains the URI of the XDS Document to be used for retrieval. If this attribute is received in a Provide and Register Document Set
                                                                                                                                                           3-3-receiver.identifier
  the organization(s) and/or person(s) the Document Source intends the Submission Set is for. This attribute may be multi-valued. Each entry should include one organization, one p




            Pg 93 of 148                                                                      D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                                 DataReq-IHE-XDP
         Note


3-1.checksum

         Assume the URI of a document belongs in the payload rather than the envelope.
         This mapping could be improved with a more precise definition of the IHE-XDP data item(s)




         Pg 94 of 148                                                                   D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                           DataReq-IHE-XDP
SDO abbreviation                          source (reference within the file name)
                                                                    category                  data
                   source document (from DataRequirements-Sources, D:document) sub-category item name                  definition domain label)
                                                                                                          alias(es) (includes presentationspecification
IHE - XDR          IHE XDR
                                                                    ebXML Message 25          header                   Identification of the message sender (its
                                          Table 3.15.4.1-1 ebXML Message Header p Header; The PartyId of the message, in /SOAP:Envelope/ SOAP:Header/eb:M
                                                                                              Role                                  see http://www.ihe.net/role
                                                                                                                       String indicating the authorized role of t
                                                                                              PartyId                  email address of intended recipient (per
                                                                                              Role                                  http://www.ihe.net/roles/it
                                                                                                                       the authorized role of the receiver
                                                                                              CPAId                    Identification of a Collaboration Protoco
                                                                                              ConversationId           In the absence of a local trading partner
                                                                                              Service                               value: Service
                                                                                              Action                                value: submitObjects
                                                                                              MessageId                A unique message identifier generated b
                                                                                              Timestamp                Time that the message header was crea
                                                                                              DuplicateElimination an indicator that duplicates should be e
                                                                                              Description              Description of the Submission Set (equiv
                                                                                              AckRequested             indicate that the repository shall acknow

                                                                   message; List of 33           hash                 the hash SOAP:Body/eb:Manifest/eb:R
                                            Document Metadata Attribute Definition preferences to document, in /SOAP:Envelope/key of the XDS Document itsel
                                                                                                 size                 the size in bytes of the byte stream that
                                                                                                 URI                  the URI of the XDS Document to be used
                                                                                                 intendedRecipient    the organization(s) or person(s) the Doc




Pg 95 of 148                                                                 D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                DataReq-IHE-XDR
             - range     - format               - length: example usage(s)
                                    - length: minimum maximum value             compound indicator analysis optional, mandatory, conditional (in list number)
                                                                                         datatype: o/m/c:      multiple occurrences (y or maximum
                                                                                                                          dependent business rules/constraints
                                                                                                                                     data item context)

 on of the message sender (its email address, preceded by mailto:)                            email address
  see http://www.ihe.net/roles/iti/xds/DocumentSource                                         internet address
 ess of intended recipient (person or organization)                                           email address
                                                                                              code
  http://www.ihe.net/roles/iti/xds/DocumentRepository for the Document Repository and http://www.ihe.net/roles/iti/xds/DocumentRecipient for the Document Recipient(s)
                                                                                              identifier
 on of a Collaboration Protocol Agreement between the sender and receiver. If there is no CPA, this element shall be the concatenation of eb:From/eb:PartyId and the eb:To/eb:P
                                                                                              identifier
 nce of a local trading partner agreement, shall be CCYYMMDD-HHMMSS-mmmmm based upon the sending ebXML message generation.
  value: Service                                                                              code
  value: submitObjects                                                                        code
                          either a concatenation of message elements to create a globally unique identifier, or a single message element if that element is globally unique.
message identifier generated by the sender:                                                   identifier
                           created
 he message header wasXMLSchema dateTime format            2004-12-25T23:50:50                datetime
 r that duplicates should be eliminated                                                       indicator
n of the Submission Set (equivalent to the XDSSubmissionSet.comments attribute).              text
 at the repository shall acknowledge the message                                              code?

ey of the XDS Document itself                                         used by the recipient for detecting the
                                                                                             hash
                                                         da39a3ee5e6b4b0d3255bfef95601890afd80709 improper resubmission of Documents
bytes of the byte stream that was provided                     3654                          count
the XDS Document to be used for retrieval                                                    specification text
                                                         DOC00001.TXT, or DOC0000P/DOC0000P1.XML, or http://www.ihe.net
                                                         Fair Clinic^L^716|^Wel^Marcus^^^Dr^MD and Value>|12345^John^Smith^^^Dr^MD</rim:Value><rim:Value>Main Ho
 ation(s) or person(s) the Document Source intends the Submission Set to be for y                                 y
                                                                                             person name or organization name or person identifier or organization identifier




            Pg 96 of 148                                                                    D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                               DataReq-IHE-XDR
domain model reference         Note

3-2-sender.identifier
3-2-sender.role code
3-3-receiver.identifier
3-2-receiver.role code
3-1.profile identifier
? What is this; seemed like 3-1.identifier, but that's what MessageId is
?
1-1.trigger event code

3-1.datetime
? n/a
?
                           This element has the following attributes: SOAP:mustUnderstand="1" eb:version="2.0" eb:signed="false"
3-1.acknowledgement requested code

3-1.checksum
3-1.length
? n/a represents payload location
3-2-receiver.person identifier and 3-2-receiver.person name and 3-2-receiver.organization identifier and 3-2-receiver.organization name




Pg 97 of 148                                                                      D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                     DataReq-IHE-XDR
            source               source (reference within the filesub-category data item name
                                                category           name)
SDO abbreviation document (from DataRequirements-Sources, D:document)
NCPDP                            p 87
            NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                    Segment HEADER
                                                UIB INTERACTIVE INTERCHANGE CONTROLCode
                                 p 87
            NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                    Syntax identifier
                                                UIB INTERACTIVE INTERCHANGE CONTROL HEADER
                                 p 87
            NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                    Syntax version number
                                                UIB INTERACTIVE INTERCHANGE CONTROL HEADER
                                 p 88
            NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                    Transaction control
                                                UIB INTERACTIVE INTERCHANGE CONTROL HEADER reference
                                 p 88
            NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                    Initiator reference
                                                UIB INTERACTIVE INTERCHANGE CONTROL HEADER identifier
                                 p 88
            NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                    Controlling agency,
                                                UIB INTERACTIVE INTERCHANGE CONTROL HEADER coded
                                 p 89
            NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                    Interchange Sender
                                                UIB INTERACTIVE INTERCHANGE CONTROL HEADER - Sender identification - level one
                                 p 89
            NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                    Level one identification code qualifier
                                                UIB INTERACTIVE INTERCHANGE CONTROL HEADER
                                 p 90
            NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                    Sender identification
                                                UIB INTERACTIVE INTERCHANGE CONTROL HEADER - level two
                                 p 90
            NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                    Sender identification
                                                UIB INTERACTIVE INTERCHANGE CONTROL HEADER - level three
                                 p 90
            NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                    Interchange Recipient - Recipient ID - level one
                                                UIB INTERACTIVE INTERCHANGE CONTROL HEADER
                                 p 91
            NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                    Level one identification code qualifier
                                                UIB INTERACTIVE INTERCHANGE CONTROL HEADER
                                 p 91
            NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                    Interchange Recipient - Recipient ID - level two
                                                UIB INTERACTIVE INTERCHANGE CONTROL HEADER
                                 p 91
            NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                    Interchange Recipient - Recipient ID - level three
                                                UIB INTERACTIVE INTERCHANGE CONTROL HEADER

                                    p 91
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                Date of initiation
                                                  UIB INTERACTIVE INTERCHANGE CONTROL HEADER
                                    p 91
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                Event Time
                                                  UIB INTERACTIVE INTERCHANGE CONTROL HEADER
                                    p 91
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                Test Indicator
                                                  UIB INTERACTIVE INTERCHANGE CONTROL HEADER

                                    p 128
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                Interchange Control
                                                  UIZ INTERACTIVE INTERCHANGE CONTROL TRAILER Count

                                    p 92
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                Segment code
                                                  UIH INTERACTIVE MESSAGE HEADER
                                    p 92
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                Message type
                                                  UIH INTERACTIVE MESSAGE HEADER
                                    p 92
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                Message version number
                                                  UIH INTERACTIVE MESSAGE HEADER
                                    p 92
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                Message release number
                                                  UIH INTERACTIVE MESSAGE HEADER
                                    p 92
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                Message function
                                                  UIH INTERACTIVE MESSAGE HEADER
                                    p 92
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                Association assigned code
                                                  UIH INTERACTIVE MESSAGE HEADER
                                    p 93
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                Message Reference Number
                                                  UIH INTERACTIVE MESSAGE HEADER
                                    p 93
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                Dialogue Reference - Initiator control reference
                                                  UIH INTERACTIVE MESSAGE HEADER
                                    p 93
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                Initiator reference identifier
                                                  UIH INTERACTIVE MESSAGE HEADER
                                    p 93
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                Controlling Agency, Coded
                                                  UIH INTERACTIVE MESSAGE HEADER
                                    p 93
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                Responder control reference
                                                  UIH INTERACTIVE MESSAGE HEADER
                                    p 93
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                Date
                                                  UIH INTERACTIVE MESSAGE HEADER of initiation


Pg 98 of 148                                                             D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                          DataReq-NCPDP-SCRIPT
                                    p 93
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                 Event
                                                   UIH INTERACTIVE MESSAGE HEADER time
                                    p 94
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                 Test
                                                   UIH INTERACTIVE MESSAGE HEADER Indicator

               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                  Message Reference Number
                                                   UIT INTERACTIVE MESSAGE TRAILER
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf                                  Number of Segments in Message
                                                   UIT INTERACTIVE MESSAGE TRAILER

                                                   UNA
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf p 63, 86 SERVICE STRING ADVICE   Component Data Element Separator
                                                   UNA
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf p 63, 86 SERVICE STRING ADVICE   Data Element Separator
                                                   UNA
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf p 63, 86 SERVICE STRING ADVICE   Decimal Notation
                                                   UNA
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf p 63, 86 SERVICE STRING ADVICE   Release Indicator
                                                   UNA
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf p 63, 86 SERVICE STRING ADVICE   Repetition Separator
                                                   UNA
               NCPDP_SCRIPT_Imp_Guide_v8.1.pdf p 63, 86 SERVICE STRING ADVICE   Segment Terminator




Pg 99 of 148                                                              D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                           DataReq-NCPDP-SCRIPT
             definition
alias(es) (includes presentation label)domain specification - range                                 - length: example usage(s) compound indicator
                                                                             - format - length: minimum maximum value
ØØØ-SØ19-Ø1-ØØ13                       Value UIB
Ø1Ø-SØØ1-Ø1-ØØØ1                       Value UNOA
Ø1Ø-SØØ1-Ø2-ØØØ2                       Value Ø
             Trace number. This reference is generated from the initial 1-2-sender. When a STATUS or ERROR message is generated as a response, the response transa
Ø3Ø-S3Ø3-Ø1-Ø3Ø6
             This reference field may be used as a secondary identifier, based on trading partner agreements or need of the originating system.
Ø3Ø-S3Ø3-Ø2-Ø3Ø3
             This reference field may be used as a tertiary identifier, based on trading partner agreements or need of the originating system.
Ø3Ø-S3Ø3-Ø3-ØØ51
             This field                NCPDP Provider ID Number; Clinic ID; Prescriber ID; Mailbox ID; Mutually Defined; of format
Ø6Ø-SØØ2-Ø1-ØØØ4contains the identification number of the 1-2-sender. It will contain the NCPDP Provider ID NumberCM the pharmacy, the Clinic ID of the prescrib
             This field                P = Pharmacy; C = Clinic; M = Mailbox; D = Prescriber; ZZZ = Mutually Defined; format: CM
Ø6Ø-SØØ2-Ø2-ØØØ7qualifies the interchange 1-2-sender.
             This field is used for    format: C
Ø6Ø-SØØ2-Ø3-ØØØ8; Passwordthe sender's password to the recipient's system. It is recommended that passwords be used for security checking and to validate iden
             This field
Ø6Ø-SØØ2-Ø4-ØØ4Ømay be used for a secondary level of identification of the sender, based on trading partner agreements.
             This field
Ø7Ø-SØØ3-Ø1-ØØ1Øcontains the identification number of the recipient. It will contain the NCPDP Provider ID Number of the pharmacy, the Clinic ID of the prescribe
             This field                P = Pharmacy; C = ID.
Ø7Ø-SØØ3-Ø2-ØØØ7qualifies the interchange recipient Clinic; M = Mailbox; D = Prescriber; ZZZ = Mutually Defined; format: C
             May be used as a secondary identification of the recipient. May be used to identify the switch.
Ø7Ø-SØØ3-Ø3-ØØ14                       format: C
             May be used as a tertiary format: C
Ø7Ø-SØØ3-Ø4-ØØ44                       identification of the recipient.

         The date
Ø8Ø-S3ØØ-Ø1-ØØ17of the interchange.                                    CCYYMMDD
         The time
Ø8Ø-S3ØØ-Ø2-Ø114 of the interchange.                                   HHMMSS,S
                                  See External Code List
1ØØ-ØØ35 Indicates whether the transaction is test or live.

Ø2Ø-ØØ36 Number of messages per interchange. The count of UIH-UIT occurrences.

ØØØ-SØ19-Ø1-ØØ13
Ø1Ø-S3Ø6-Ø1-Ø329                 Value: SCRIPT
Ø1Ø-S3Ø6-Ø2-Ø316                 Value: ØØ8
Ø1Ø-S3Ø6-Ø3-Ø318                 Value: ØØ1
         (payload
Ø1Ø-S3Ø6-Ø4-Ø326 identifier)     Values: NEWRX, REFREQ, REFRES, RXFILL, GETMSG, VERIFY, STATUS, PASCHG, ERROR, RXCHG, CHGRES, CANRX, CANRES, RXHREQ
         the highest
Ø1Ø-S3Ø6-Ø6-ØØ57 version and release the sender is capable of handling.
Ø2Ø-ØØ62 Rx Number or Unique ID from doctor. This field contains a reference number for the Message, which may be the Prescription Number or Patient Folio num
         Trace number assigned byformat: CM This field may be used as a trace number for the Message. It is a reference field which can uniquely identify at any p
Ø3Ø-SØ32-Ø1-Ø3ØØ                  1-2-sender.
         This field
Ø3Ø-SØ32-Ø2-Ø3Ø3 may be used as a trace number between trading partners.
         This field
Ø3Ø-SØ32-Ø3-ØØ51 may be used as a trace number between trading partners.
         This field
Ø3Ø-SØ32-Ø4-Ø3Ø4 may be used as a trace number between trading partners.
         Date of the
Ø5Ø-S3ØØ-Ø1-ØØ17 message.                                             CCYYMMDD


Pg 100 of 148                                                                 D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                               DataReq-NCPDP-SCRIPT
         Time of the
Ø5Ø-S3ØØ-Ø2-Ø314 message.                                                HHMMSS,S
                                 Values: test or live.
Ø6Ø-ØØ35 Indicates whether the message is See External Code List

Ø1Ø-ØØ62 (same as UIH Message Reference Number)
Ø2Ø-ØØ74 This is the count of the number of segments in the message including the UIH and UIT.

Ø1Ø-Ø1     used to separate the sub-elements of a composite data element                                                  delimiter; in assembling and parsing the messa
Ø1Ø-Ø2     used to separate data elements within a segment                                                                delimiter; in assembling and parsing the messa
Ø1Ø-Ø3     specifies the characters used for a decimal point                                                              delimiter; in assembling and parsing the messa
Ø1Ø-Ø4                                                      in                                            +:’?            in user data in Level A syntax. It

           used when the value of a delimiter may appear
 the data. To release any of the characters
 appearingdelimiter; in assembling and parsing theimmedMUST messa
Ø1Ø-Ø5                                                                                                                    delimiter; in assembling and Use count messa
           used to separate repetitions of a data element.This separator indicates that the next item is a repetition of the previous item. Where theparsing the colum
Ø1Ø-Ø6                                                                                                                     segment.
           used to terminate all segments. A data element separator must not be used after the last data element in adelimiter; in assembling and parsing the messa




Pg 101 of 148                                                                   D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                 DataReq-NCPDP-SCRIPT
datatype: analysis             multiple occurrences (y or maximum
                                          dependent business rules/constraints
                                                     data item context) model
                                                                   domain
                     o/m/c: optional, mandatory, conditional (in list number) reference                                       Note
                                                                                                  Combined Envelope mapping note
code                 m                                             n/a                                                        artifact of encoding method: not include
identifier           m                                             3-1.envelope version identifier                            ?
identifier           m                                             3-1.envelope version identifier                            ?
identifier           m                                             3-1.identifier
identifier           c                                             <none>
identifier           c                                             3-2-sender.identifier
identifier           m                                             3-2-sender.identifier
                                          Interchange Sender - Sender identification - level one and Level one identification code qualifier are valued as a group
code                 m                                             3-2-sender.identifier           and Level one identification code
                                          Interchange Sender - Sender identification - level one capturing the type of identifier qualifier are valued as a group
text                 c                                             <none>
identifier           c                                             <none>
identifier           m                                              Recipient ID - level one
                                          Interchange Recipient -3-3-receiver.identifier and Level one identification code qualifier are valued as a group
code                 m                                              Recipient ID - level one      capturing the type of code qualifier are valued as a group
                                          Interchange Recipient -3-3-receiver.identifier and Level one identificationidentifier
identifier           c                                             <none>
identifier           c                                             <none>

date                 c                                             3-1.datetime
time                 c                                             3-1.datetime
code                 c                                             3-1.processing environment code

count                                                              1-1.message count

n/a                  m                                             n/a                                                       artifact of encoding method: not include
identifier           m                                             3-1.syntax identifier
identifier           m                                             3-1.syntax identifier
identifier           m                                             3-1.syntax identifier
identifier           m                                             1-1.message type code
specification text   c                                             <none>
identifier           c                                             1-1.identifier
identifier                                                         3-1.identifier
identifier                                                         3-1.identifier
identifier                                                         ?don't understand meaning; is this just another possible sender identifier for the message?
identifier                                                         9-1-delimiters.identifier
date                                                               3-1.datetime                 The difference between the UIH and UIB event date


Pg 102 of 148                                                                  D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                DataReq-NCPDP-SCRIPT
time                          3-1.datetime                 The difference between the UIH and UIB time
code                                                       Can
                              3-1.processing environment code you have a UIH Test Indicator indicating Production and UIB Tes

identifier      m             1-1.identifier
                    Must be the same value as in UIH ØØ62.
count           m             <none>

n/a             m             10-1-delimiters.
n/a             m             10-1-delimiters.
n/a             m             10-1-delimiters.?                                      where does this belong?
n/a             m             10-1-delimiters.
n/a             m             10-1-delimiters.
n/a             m             10-1-delimiters.




Pg 103 of 148                              D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                            DataReq-NCPDP-SCRIPT
encoding method: not included in class diagram




encoding method: not included in class diagram




tifier for the message?

UIB event date


            Pg 104 of 148                                       D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                 DataReq-NCPDP-SCRIPT
cating Production and UIB Test Indicator indicating Test for one message and Production for another message?




s this belong?




            Pg 105 of 148                                                                D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                          DataReq-NCPDP-SCRIPT
        source document (from DataRequirements-Sources, D: file name) item name
SDO abbreviation                             category sub-category
                         source (reference within the document) data                        definition          label)      - range
                                                                               alias(es) (includes presentation domain specification - format
NCPDP NCPDP Telcom Batch 1.2 (excerpt)
                                         6.2 Required Transmission Header Record
                                                                               88Ø-K4
                                                                   Text Indicator           Start of Text       (STX ) = X'Ø2'
                                                                               7Ø1
                                                                   Segment Identifier                           ØØ = File Control (header)
                                                                               88Ø-K6
                                                                   Transmission Type                            T = Transaction, R = Response, E = Error
                                                                   Sender ID 88Ø-K1
                                                                   Batch Number8Ø6-5C
                                                                               88Ø-K2
                                                                   Creation Date                                                        CCYYMMDD
                                                                               88Ø-K3
                                                                   Creation Time                                                        HHMM
                                                                   File Type 7Ø2                                P = production, T = test
                                                                               1Ø2-A2
                                                                   Version /Release Number  Version/Release of Header Data
                                                                   Receiver ID 88Ø-K7
                                                                               88Ø-K4
                                                                   Text Indicator           End of Text         (ETX) = X'Ø3'

                                            6.3 TRANSACTION DETAIL DATA RECORD
                                                                                88Ø-K4
                                                                    Text Indicator         Start of Text         (STX ) = X'Ø2'
                                                                                7Ø1
                                                                    Segment Identifier                           G1 = Detail Data Record
                                                                                 Reference Number
                                                                    Transaction88Ø-K5
                                                                    <NCPDP Data Record>
                                                                                88Ø-K4
                                                                    Text Indicator                               (ETX) = X'Ø3'

                                            6.4 REQUIRED TRANSMISSION TRAILER RECORD
                                                                               88Ø-K4
                                                                   Text Indicator                                (STX ) = X'Ø2'
                                                                               7Ø1
                                                                   Segment Identifier                            99 = File Trailer
                                                                   Batch Number8Ø6-5C
                                                                   Record Count      751
                                                                   Message 5Ø4-F4
                                                                               88Ø-K4
                                                                   Text Indicator                                (ETX) = X'Ø3'




Pg 106 of 148                                                                D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                          DataReq-NCPDP-Telecom-Batch
                        - length: example usage(s)
            - length: minimum maximum value                   datatype: o/m/c:
                                                     compound indicator analysis optional, mandatory, conditional (in list number) reference
                                                                                    multiple occurrences (y or maximum
                                                                                               dependent business rules/constraints
                                                                                                          data item context) model
                                                                                                                        domain   Note

                                                               n/a                                                   n/a
                                1 X'Ø2'                        delimiter                                             10-1-delimiters.
                                2                              identifier                                            n/a 3-1.
sponse, E = Error               1                              code                                                              For E=Error, just header
                                                                                                                     n/a 3-1., 9-1-response., 8-1-error. and trailer rec
                               24                              identifier                                            3-2-sender.identifier
                                                                                                          To be defined by processor/switch.
                                7                              identifier                                            3-1.identifier Is this correct
                                                                                                          Matches Trailer        ?
CCYYMMDD                        8                              date                                                  3-1.datetime
                                4                              time                                                  3-1.datetime
                                1                              code                                                  3-1.processing environment code
                                2                              identifier                                            3-1.envelope version identifier
                               24                              identifier                                            3-3-receiver.identifier
                                                                                                          To be defined by processor/switch.
                                1 X'Ø3'                        delimiter                                             10-1-delimiters.

                                                               n/a                                                   n/a
                                1 X'Ø2'                        delimiter                                             10-1-delimiters.
                                2                              identifier                                            n/a
                      1Ø                                       identifier                                            1-1.identifier
                      varies                                   n/a                                                   n/a
                                1 X'Ø3'                        delimiter                                             10-1-delimiters.

                                                               n/a                                                  n/a
                                1 X'Ø2'                        delimiter                                            10-1-delimiters.
                                2                              identifier                                           n/a
                                7                              identifier                                           3-1.identifier
                                                                                                          Matches header        ?same question as above for Required
                      1Ø                                       count                                                none        total number of detail records in the b
                               35                              text                                                             ?
                                                                                                                    8-1-error.textTo what does Message apply to: the
                                1 X'Ø3'                        delimiter                                            10-1-delimiters.




           Pg 107 of 148                                                             D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                  DataReq-NCPDP-Telecom-Batch
r, just header and trailer records, no content records




stion as above for Required Transmission Header Record Batch Number
 er of detail records in the batch, including header and trailer records
does Message apply to: the entire transmission; could it be an error message if the Transmission Type value is E?




            Pg 108 of 148                                                                   D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                         DataReq-NCPDP-Telecom-Batch
                                        source (reference within the file name)
                                                                  category                   data
SDO abbreviation source document (from DataRequirements-Sources, D:document) sub-category item name
NCPDP                                   p 3, Request Segments:
                 NCPDP Telecommunication Standard (excerpt) Transaction Header Segment
                                                                                  TransactionBIN NUMBER
                                                                  Transmission Request        Header Segment
                                                                                             VERSION/RELEASE NUMBER
                                                                                             TRANSACTION CODE
                                                                                             PROCESSOR CONTROL NUMBER
                                                                                             TRANSACTION COUNT
                                                                                             SERVICE PROVIDER ID QUALIFIER
                                                                                             SERVICE PROVIDER ID
                                                                                             DATE OF SERVICE
                                                                                             SOFTWARE VENDOR/CERTIFICATION ID

                                         p 9, Response Segments: Response Header Segment
                                                                                  Response Header Segment NUMBER
                                                                  Transmission Response     VERSION/RELEASE
                                                                                            TRANSACTION CODE
                                                                                            TRANSACTION COUNT
                                                                                            HEADER RESPONSE STATUS
                                                                                            SERVICE PROVIDER ID QUALIFIER
                                                                                            SERVICE PROVIDER ID
                                                                                            DATE OF SERVICE

                                         p 10, Response Status Segment (not included since not part of envelope)
                                                                                   Response Status Segment
                                                                  Transmission Response        SEGMENT IDENTIFICATION
                                                                                               TRANSACTION RESPONSE STATUS
                                                                                               AUTHORIZATION NUMBER
                                                                                               REJECT COUNT
                                                                                               REJECT CODE
                                                                                               REJECT FIELD OCCURRENCE INDICATOR
                                                                                               APPROVED MESSAGE CODE COUNT
                                                                                               APPROVED MESSAGE CODE
                                                                                               ADDITIONAL MESSAGE INFORMATION COUNT
                                                                                               ADDITIONAL MESSAGE INFORMATION QUALIFIER
                                                                                               ADDITIONAL MESSAGE INFORMATION
                                                                                               ADDITIONAL MESSAGE INFORMATION CONTINUITY


Pg 109 of 148                                                          D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                   DataReq-NCPDP-Telecom-RealTime
                                                      HELP DESK PHONE NUMBER QUALIFIER
                                                      HELP DESK PHONE NUMBER
                                                      TRANSACTION REFERENCE NUMBER
                                                      INTERNAL CONTROL NUMBER
                                                      URL




Pg 110 of 148                       D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                DataReq-NCPDP-Telecom-RealTime
             definition domain label)
                                   - range
alias(es) (includes presentationspecification - format               - length: example usage(s)
                                                         - length: minimum maximum value                        datatype: o/m/c:      multiple occurrences (y or
                                                                                                       compound indicator analysis optional, mandatory, conditio

1Ø1-A1                                                      flf
           Card Issuer ID or Bank ID Number used for network routing             6                                 identifier m
1Ø2-A2                                                      flf                  2 Data Dictionary
           Code uniquely identifying the transmission syntax and corresponding51; D0                               identifier m
1Ø3-A3     Transaction Code Code identifying the type of flftransaction          2 B1; B2; B3; P1; E1              code        m
1Ø4-A4     Number assigned by the processor                 flf                 10                                 identifier m (per specs; o per Teresa)
1Ø9-A9                 1 to 4      1-4
           Count of transactions in the transmission        flf                  1                                 count       m
2Ø2-B2                 01 (NPI), 07 (NCPDP ID), 08 (State License), 12 (DEA) 2 01
                                                            flf
           Code qualifying the ‘Service Provider ID’ (2Ø1-B1)                                                      code        m
2Ø1-B1     ID assigned to a pharmacy or provider            flf                 15                                 identifier m
4Ø1-D1                                                      flf                  8                                 date        m
           Identifies date the prescription was filled or professional service rendered or subsequent payer began coverage following Part A expiration in a long-term
11Ø-AK                                                      flf                 10
           ID assigned by the switch or processor to identify the software source                                  identifier m


1Ø2-A2                                                 flf
           see same data item in Transaction Header Segment                                                                   m
1Ø3-A3                                                 flf
           see same data item in Transaction Header Segment                                                                   m
1Ø9-A9                                                 flf
           see same data item in Transaction Header Segment                                                                   m
5Ø1-F1                                                 flf
                     “A “ for transmission "accepted"; “R “ for transmission "rejected"
                                      m
2Ø2-B2                                                 flf
           see same data item in Transaction Header Segment                                                                   m
2Ø1-B1                                                 flf
           see same data item in Transaction Header Segment                                                                   m
4Ø1-D1                                                 flf
           see same data item in Transaction Header Segment                                                                   m


111-AM                                                                                                                        m
112-AN                                                                                                                        m
5Ø3-F3                                                                                                                        c
51Ø-FA                                                                                                                        c
511-FB                                                                                                                        c
546-4F                                                                                                                        c
547-5F                                                                                                                        c
548-6F                                                                                                                        c
13Ø-UF                                                                                                                        c
132-UH                                                                                                                        c
526-FQ                                                                                                                        c
131-UG                                                                                                                        c


Pg 111 of 148                                                                 D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                          DataReq-NCPDP-Telecom-RealTime
549-7F                                                                                                                        c
55Ø-8F                                                                                                                        c
88Ø-K5                                                                                                                        c
           A reference number assigned by the provider to each of the data records in the batch or real-time transactions. The purpose of this number is to facilitate
993-A7                                                                                                                        c
987-MA                                                                                                                        c




Pg 112 of 148                                                                 D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                          DataReq-NCPDP-Telecom-RealTime
                     data item list
                                 domain model
                                           Combined Envelope mapping note
                                                       Note
           dependent business rules/constraints reference

                                 3-3-receiver.identifier
                                 3-1.syntax identifier
                                 1-1.message type code
cs; o per Teresa)                3-3-receiver.identifier assigned by the processor of the claim and is an identifier only meaningful to them
                                 2-1.message count
                                 3-2-sender.identifier
             SERVICE PROVIDER ID QUALIFIER and SERVICE PROVIDER ID are valued as a group
                                 3-2-sender.identifier
             SERVICE PROVIDER ID QUALIFIER and SERVICE PROVIDER ID are valued as a group
                                 <none>      payload data, not envelope data
                                 ?                       Transaction Header Segment SOFTWARE VENDOR/CERTIFICATION ID is the identifier for the pharmacy that is sending t


                                 3-1.syntax identifier
                                 1-1.message type code
                                             does the
                                 2-1.message count response have groups?

                               3-3-receiver.identifier
           SERVICE PROVIDER ID QUALIFIER and SERVICE PROVIDER ID are valued as a group
                               3-3-receiver.identifier
           SERVICE PROVIDER ID QUALIFIER and SERVICE PROVIDER ID are valued as a group
                               <none>     payload data, not envelope data


                                 n/a
                                             ? Is this correct
                                 9-1-delimiters.response code
                                 ?
                                 <none>
                                             ? Which one is correct?
                                 8-1-error.code or 9-1-delimiters.response code
                                 <none>
                                 <none>
                                 <none>
                                 ?
                                 ?
                                 ?
                                 ?


           Pg 113 of 148                                                               D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                   DataReq-NCPDP-Telecom-RealTime
                ?   HL7 V3 and NCPDP-Telecom-RealTime have same concept (help desk phone)
                ?   HL7 V3 and NCPDP-Telecom-RealTime have same concept (help desk phone)
                ?
                ?
                ?




Pg 114 of 148                                      D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                               DataReq-NCPDP-Telecom-RealTime
e pharmacy that is sending the transaction.




            Pg 115 of 148                                         D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                              DataReq-NCPDP-Telecom-RealTime
SDO abbreviation                          source (reference within the file name)
                                                                    category             data
                   source document (from DataRequirements-Sources, D:document) sub-category item name             definition domain label)
                                                                                                     alias(es) (includes presentationspecification
OASIS                                     p 10
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution
                                          p 12
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     distributionID           The unique identifier of this distribution
                                          p 12
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     senderID                 The unique identifier of the 1-2-sender.
                                          p 12
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     dateTimeSent             The date and time the distribution mess
                                          p 13
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     distributionStatus                   Value must message.
                                                                                                                  The actionability of thebe one of:a. Actu
                                          p 13
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     distributionType                     1. Value must be
                                                                                                                  The function of the message.one of:a. R
                                          p 14
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     combindedConfidentiality             1. The <combindedConfiden
                                                                                                                  Confidentiality of the combined distribu
                                          p 14
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     language                             Valid language not necessar
                                                                                                                  The primary language (but values are su
                                          p 15
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     senderRole                           1. role of the sender, as val
                                                                                                                  The functionalThe list and associated it m
                                          p 15
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     valueListUrn             <see above: senderRole>
                                          p 15
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     value                    <see above: senderRole>
                                          p 16
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     recipientRole                        1. role of the recipient, val
                                                                                                                  The functionalThe list and associatedas it
                                          p 16
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     valueListUrn             <see above: recipientRole>
                                          p 16
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     value                    <see above: recipientRole>
                                          p 17
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     keyword                              1. The list and associated val
                                                                                                                  The topic related to the distribution me
                                          p 17
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     valueListUrn             <see above : keyword>
                                          p 17
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     value                    <see above : keyword>
                                          p 17
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution                                           to previous distribution m
                                                                                         distributionReference A referenceThea<distributionID> and <se
                                          p 17
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     distributionID           The <distributionID> and <senderID> an
                                          p 17
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     senderID                 The <distributionID> and <senderID> an
                                          p 17
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     dateTimeSent             The <distributionID> and <senderID> an
                                          p 18
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     explicitAddress          The identifier of an explicit recipient.
                                          p 18
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     explicitAddressSchemethe distribution addressing scheme used
                                          p 18
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    EDXLDistribution     explicitAddressValue a string denoting the addressees value

                                         p 19
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    targetArea       targetArea                      a container element for the geospatial o
                                         p 19
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    targetArea                    circle             An enclosed geographic area within a gi
                                         p 20
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    targetArea                    polygon            An enclosed geographic area within a si
                                         p 20
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    targetArea                    country                        the country.
                                                                                                                     The code ofThe two-character ISO 3166
                                         p 20
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    targetArea                    subdivision                   The designator designator fo
                                                                                                                     The ISO 3166-2 ISO 3166-2 for the admin
                                         p 21
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    targetArea                    locCodeUN                     1. The two first digits are the
                                                                                                                     The UN/LOCODE designator for the loca

                                         p 21
                   EDXL-DE_Spec_v1.0_2814_29.pdf                    contentObject                                    the container element for specific mess


Pg 116 of 148                                                               D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                            DataReq-OASIS-EDXL-DE
                                      p 22
                EDXL-DE_Spec_v1.0_2814_29.pdf          contentObject             contentDescription    The human-readable text describing the
                                      p 23
                EDXL-DE_Spec_v1.0_2814_29.pdf          contentObject             contentKeyword                    1. The list and associated val
                                                                                                       The topic related to the message data a
                                      p 23
                EDXL-DE_Spec_v1.0_2814_29.pdf          contentObject             valueListUrn          <see above : contentKeyword>
                                      p 23
                EDXL-DE_Spec_v1.0_2814_29.pdf          contentObject             value                 <see above : contentKeyword>
                                      p 23
                EDXL-DE_Spec_v1.0_2814_29.pdf          contentObject             incidentID            The human-readable text uniquely iden
                                      p 24
                EDXL-DE_Spec_v1.0_2814_29.pdf          contentObject             incidentDescription   The human-readable text describing the
                                      p 24
                EDXL-DE_Spec_v1.0_2814_29.pdf          contentObject             originatorRole                    1. role of the message origi
                                                                                                       The functionalThe list and associated val
                                      p 24
                EDXL-DE_Spec_v1.0_2814_29.pdf          contentObject             valueListUrn
                                      p 24
                EDXL-DE_Spec_v1.0_2814_29.pdf          contentObject             value
                                      p 25
                EDXL-DE_Spec_v1.0_2814_29.pdf          contentObject             consumerRole                     1. role of the message cons
                                                                                                       The functionalThe list and associated val
                                      p 25
                EDXL-DE_Spec_v1.0_2814_29.pdf          contentObject             valueListUrn
                                      p 25
                EDXL-DE_Spec_v1.0_2814_29.pdf          contentObject             value
                                      p 25
                EDXL-DE_Spec_v1.0_2814_29.pdf          contentObject             confidentiality       Special requirements regarding confiden
                                      p 26
                EDXL-DE_Spec_v1.0_2814_29.pdf          contentObject             other                            1. There is no mandatory val
                                                                                                       Special requirements allowing for signat

                                      p 27
                EDXL-DE_Spec_v1.0_2814_29.pdf          nonXMLContent             mimeType                           of the 1-1.
                                                                                                       The format MIME content type and sub-
                                      p 27
                EDXL-DE_Spec_v1.0_2814_29.pdf          nonXMLContent             size                  The file size of the payload
                                      p 28
                EDXL-DE_Spec_v1.0_2814_29.pdf          nonXMLContent             digest                             Calculated using
                                                                                                       The digest value for the 1-1. the Secure
                                      p 28
                EDXL-DE_Spec_v1.0_2814_29.pdf          nonXMLContent             uri                                1. May be a full absolute UR
                                                                                                       A Uniform Resource Identifier that can b




Pg 117 of 148                                                   D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                DataReq-OASIS-EDXL-DE
              - range     - format                - length: example usage(s)
                                      - length: minimum maximum value                   compound indicator analysis optional, mandatory, conditional (in list number) reference
                                                                                                    datatype: o/m/c:                   dependent business rules/constraints
                                                                                                                                                    data item context) model
                                                                                                                           multiple occurrences (y or maximum   domain
                                                                                                                                                                n/a
  identifier of this distribution message.                     ieam_e3_2                            identifier m                                                 is assigned by
                                                                                                                                                    Uniqueness3-1.identifier the sender t
                            actor@domain-name
  identifier of the 1-2-sender.                                dellis@sandia.gov; XML2005           identifier m                                                identifies human parties, sy
                                                                                                                                                    1. Uniquely 3-2-sender.identifier
                            message was sent.                  2004-08-01T16:49:00-07:00            datetime be
nd time the distribution 1. The Date Time combination must include the offset time for time zone.2. Mustm in the W3C format for the XML [dateTime]3-1.datetime   data type.
                                                                for actionb. Exercise - Simulated information for exercise participantsc. System - Messages regarding or supporting netw
  Value must be one of:a. Actual - "Real-world" information Exercise                                code        m                                               3-1.processing environmen
                                                               Update                               identifier m                                                <none>
  1. Value must be one of:a. Report - New information regarding an incident or activityb. Update - Updated information superseding a previous messagec. Cancel - A cancellation or
  1. The <combindedConfidentiality> indicates the confidentiality of the combined
                              m                                               <none>
                                                                                         <contentObject> sub-elements. Generally the combined confidentiality is the most
      restrictive o
  Valid language values are supplied in the ISO standard [RFC3066].                                 code        o                                               3-1.language code
                                                                                        y           n/a         o          y           child of senderRole      <none>
  1. The list and associated value(s) is in the form:<senderRole><valueListUrn>valueListUrn</valueListUrn><value>value</value></senderRole>where the content of <valueListUrn
e: senderRole>                                                 urn:sandia:gov:sensors:senderRoleidentifier                             child of senderRole      <none>
e: senderRole>                                                 SENTRY sensor managment system       code or text?          y           child of senderRole      <none>
                                                                                                                o          y                                    <none>
  1. The list and associated value(s) is in the form:<recipientRole><valueListUrn>valueListUrn</valueListUrn><value>value</value></recipientRole>where the content of <valueList
e: recipientRole>                                              urn:sandia:gov:sensors:reciepentRole identifier                         child of recipientRole <none>
e: recipientRole>                                                                                   code Prediction        y           child of recipientRole <none>
                                                               Warning and Reporting Devices; Hazard or text? applications; Situational Awarness applications
                                                                           This key word [one example] can be used by subscribing systems or applications to get distribution of one th
                                                                                                    n/a         o          y           children are: valueListUrn and <valueListUrn> is o
  1. The list and associated value(s) is in the form:<keyword><valueListUrn>valueListUrn</valueListUrn><value>value</value></keyword>where the content of value <none>
e : keyword>                                                   http://www.niem.gov/EventTypeList    identifier                         child of keyword         <none>
e : keyword>                                                   Explosion                            code or text?          y           child of keyword         <none>
                                                               msgID0074,actor@domain-name,2004-08-01T16:49:00-07:00
                                                                                        y
  The <distributionID> and <senderID> and <dateTimeSent> of the referenced previous message         n/a         c          y                                    n/a
                                                                                                                                       parent of <distributionID> and <senderID> and <da
butionID> and <senderID> and <dateTimeSent> of the referenced previous message                      identifier                                                  3-1.identifier
                                                                                                                                       child of distributionReference
butionID> and <senderID> and <dateTimeSent> of the referenced previous message                      identifier                                                  3-2-sender.identifier
                                                                                                                                       child of distributionReference
butionID> and <senderID> and <dateTimeSent> of the referenced previous message                      datetime                                                    3-1.datetime
                                                                                                                                       child of distributionReference
 ier of an explicit recipient.                                                                      n/a         o          y                                    3-3-receiver.network addre
                                                                                                                                       parent of explicitAddressScheme and explicitAddre
ution addressing scheme used                                   e-mail                               code?                              child of explicitAddress?
noting the addressees value                                    dellis@sandia.gov                    identifier?                        child of explicitAddress3-3-receiver.network addre

                                                                                                n/a                      y                                  n/a
r element for the geospatial or political area targeting of the message content. It indicates the originator’s intent based on location targeting as to the dissemination of that partic
                          1. given radius around a geographic longitude, radius". 15
                                                              38.26295,              y
d geographic area within aRepresented in the form "latitude, point. -122.07454(See Geospatial Note above)2. The central pointchild of target arealat-long values conforming to th
                                                                                                ??tbd       o            y           is represented by      3-3-receiver-criteria-place.c
                          1. simple closed polygon defined by an ordered42,-120.1y39,-120 35.0,-114.6328 34.35,- 120.4418 38.9383,-123.817 42,-124.2102
                                                              42,-124.2102 set of vertices.     ??tbd                    y                                  3-3-receiver-criteria-place.p
d geographic area within aRepresented by a space-delimited series of latitude, longitude pairs, with the last pair identical to the first. (See Geospatial Note above)2. The lat-long va
                                                              US
 The two-character ISO 3166-1 Country Code for the country concerned.                           code        o            y                                  3-3-receiver-criteria-place.c
                                                                                                                                                 More specific target location informati
                          1. The the administrative before the hyphen, are
                                                              California                        identifier o             y                                   designated subdivision is lo
 The ISO 3166-2 designator forfirst two characters,subdivision concerned. the two character ISO 3166-1 Country Code for the country within which the3-3-receiver-criteria-place.s
                                                              USFFB (Fairfield, Alabama, USA), USSUU (Fairfield, California, following three characters are3-3-receiver-criteria-place.l
                                                                                                identifier               The                                 the UN/LOCODE designato
 1. The two first digits are the two character ISO3166-1 Country Code for the country in which the place is located.2. y USA), GBFFD (Falfield, South Gloucestershire, UK); USA-SF

                                                                                                                    y                                  n/a
ner element for specific messages; Additional elements (metadata) used for specific distribution of the <contentObject> payload or 8 hints for processing the payload are also pre


             Pg 118 of 148                                                                       D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                                 DataReq-OASIS-EDXL-DE
n-readable text describing the content object.                            human reading         text         o                                          n/a
                                                              "CAP message from FEMA", "Map of affected area" or "Photo of missing child", "CAP message from DOT advising best a
                                                                          Examples of things <contentKeyword> might be used to describe include message processor, event stage, re
                                                                                    y           n/a          o       y          children are: valueListUrn and value
                                                                                                                                                        n/a
 1. The list and associated value(s) is in the form:<contentKeyword><valueListUrn>valueListUrn</valueListUrn><value>value</value></contentKeyword>where the content of <va
e : contentKeyword>                                                                             identifier
                                                              urn:sandia:gov:sensor:detection.event.id                          child of contentKeyword n/a
e : contentKeyword>                                           10.2.2.1:2005-08-07T18:00:00Z code or text?            y          child of contentKeyword n/a
                                                                                                identifier o
n-readable text uniquely identifying the incident/event/situation associated with the contentObject.                                                    n/a
n-readable text describing the incident/event/situation associated with the contentObject. text              o                                          n/a
                                                                                    y           n/a                  y          children are valueListUrn, value
                                                                                                                                                        n/a
 1. The list and associated value(s) is in the form:<originatorRole><valueListUrn>valueListUrn</valueListUrn><value>value</value></originatorRole>where the content of <valueL
                                                                                                identifier                      parent is originatorRolen/a
                                                                                                code or text?        y          parent is originatorRolen/a
                                                              <valueListUrn>"http://www.dhs.gov/NiemRoleType"</valueListUrn>,children are Operations Branch</value>
                                                                                                                     y           <value>ICS valueListUrn, value
                                                                                                                                                        n/a
 1. The list and associated value(s) is in the form:<consumerRole><valueListUrn>valueListUrn</valueListUrn><value>value</value></consumerRole>where the content of <valueL
                                                                                                identifier                      parent is consumerRole  n/a
                                                                                                code or text?        y          parent is consumerRole  n/a
                                                              Unclassified                      text         o
 uirements regarding confidentiality of the content of this <contentObject>. (Editor: <contentObject> is payload)                                       n/a
                                                                                    y? not      ?         2. o       y                                  n/a
 1. There is no mandatory validation of the elements if the namespace reference can
 be located.
 MUST be a properly formed XML string – escaped, if necessary.
 Elemen3.

 MIME content type and sub-type as described in [RFC 2046].application/pdf, application/mp3 code            c                                            n/a
                                                                                                                                             Required if payload is non-XML conten
e of the payload                                                                                count       o                                             be
                                                                                                                                             Value must n/ain bytes and represent t
 Calculated using the Secure Hash Algorithm (SHA-1)                                             text
                                                                        to ensure the integrity of the 1-1. o                                            n/a
                                                                                                internet address
                                                                                                            o                                            n/a
 1. May be a full absolute URI, typically a Uniform Resource Locator, that can be used to retrieve the resource over the Internet.2. May be a relative URI naming a file. This may be




            Pg 119 of 148                                                                     D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                              DataReq-OASIS-EDXL-DE
                    Note
           Combined Envelope mapping note

3-1.identifier
3-2-sender.identifier
3-1.datetime
                      While the
3-1.processing environment codedatatype is code, the codes are the names/titles of the values.


3-1.language code


                       Multiple instances of the <value>, MAY occur with a single <valueListUrn> within the <senderRole> container.




           ?


           Reference back to sender
           Reference back to sender
           Reference back to sender
           Reference back to sender
           ?

3-3-receiver.network address


3-3-receiver-criteria-place.circle
3-3-receiver-criteria-place.polygon
3-3-receiver-criteria-place.country
3-3-receiver-criteria-place.subdivision
3-3-receiver-criteria-place.locCodeUN




           Pg 120 of 148                                                                  D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                          DataReq-OASIS-EDXL-DE
            source                 source (reference within the document)
                                                 category          sub-category item name
SDO abbreviation document (from DataRequirements-Sources, D: file name)      data                                            definition
                                                                                                               alias(es) (includes presentation label)
X12                                              ISA
            270_271_004010x092.pdf p B.3 PDF p 393 Interchange Control Headernone: element separator                         the element separator segmen
                                                                                                               element separator; 4th character ofto be use
X12                                              ISA
            270_271_004010x092.pdf p B.3 PDF p 393 Interchange Control Header                                  I
                                                                             Authorization Information QualifierSA01; I01 Code to identify the type of info
X12                                              ISA
            270_271_004010x092.pdf p B.3 PDF p 393 Interchange Control HeaderAuthorization Information         ISA02; I02 Information used for additional
X12                                              ISA
            270_271_004010x092.pdf p B.4 PDF p 394 Interchange Control HeaderSecurity Information Qualifier    ISA03; I03 Code to identify the type of info
X12                                              ISA
            270_271_004010x092.pdf p B.4 PDF p 394 Interchange Control HeaderSecurity Information              ISA04; I04 This is used for identifying the s
X12                                              ISA
            270_271_004010x092.pdf p B.4 PDF p 394 Interchange Control HeaderInterchange ID Qualifier          ISA05; I05 Qualifier to designate the syste
X12                                              ISA
            270_271_004010x092.pdf p B.4 PDF p 394 Interchange Control HeaderInterchange Sender ID             ISA06; I06 Identification code published by
X12                                              ISA
            270_271_004010x092.pdf p B.4 PDF p 394 Interchange Control HeaderInterchange ID Qualifier          ISA07; I05 Qualifier to designate the syste
X12                                              ISA
            270_271_004010x092.pdf p B.5 PDF p 395 Interchange Control HeaderInterchange Receiver ID           ISA08; I07 Identification code published by
X12                                              ISA
            270_271_004010x092.pdf p B.5 PDF p 395 Interchange Control HeaderInterchange Date                  ISA09; I08 Date of the interchange
X12                                              ISA
            270_271_004010x092.pdf p B.5 PDF p 395 Interchange Control HeaderInterchange Time                  ISA10; I09 Time of the interchange
X12                                              ISA
            270_271_004010x092.pdf p B.5 PDF p 395 Interchange Control Header                                  ISA11;
                                                                             Interchange Control Standards Identifier I10 Code to identify the agency resp
X12                                              ISA
            270_271_004010x092.pdf p B.5 PDF p 395 Interchange Control HeaderInterchange Control Version NumberISA12; I11 This version number covers the
X12                                              ISA
            270_271_004010x092.pdf p B.5 PDF p 395 Interchange Control HeaderInterchange Control Number        ISA13; I12 A control number assigned by t
X12                                              ISA
            270_271_004010x092.pdf p B.6 PDF p 396 Interchange Control HeaderAcknowledgment Requested          ISA14; I13 Code sent by the sender to requ
X12                                              ISA
            270_271_004010x092.pdf p B.6 PDF p 396 Interchange Control HeaderUsage Indicator                   ISA15; I14 Code to indicate whether data e
X12                                              ISA
            270_271_004010x092.pdf p B.6 PDF p 396 Interchange Control HeaderComponent Element Separator ISA16; I15 this field provides the delimiter
X12                                              ISA
            270_271_004010x092.pdf p B.3 PDF p 393 Interchange Control Headernone: segment terminator                        the segment terminator to be u

X12                                                  IEA                                                          IEA01;
                270_271_004010x092.pdf p B.7 PDF p 397 Interchange Control TrailerNumber of Included Functional Groups I16          A count of the number of functi
X12                                                  IEA
                270_271_004010x092.pdf p B.3 PDF p 393 Interchange Control TrailerInterchange Control Number      IEA02; I12        A control number assigned by t

X12             270_271_004010x092.pdf                  GS
                                          p B-8 PDF p 398 Functional Group Header   Functional Identifier Code          GS01; 479   Code identifying a group of app
X12             270_271_004010x092.pdf                  GS
                                          p B-8 PDF p 398 Functional Group Header   Application Sender’s Code           GS02; 142   Code identifying party sending t
X12             270_271_004010x092.pdf                  GS
                                          p B-8 PDF p 398 Functional Group Header   Application Receiver’s Code         GS03; 124   Code identifying party receiving
X12             270_271_004010x092.pdf                  GS
                                          p B-8 PDF p 398 Functional Group Header   Date                                GS04; 373   SEMANTIC: GS04 is the group d
X12             270_271_004010x092.pdf                  GS
                                          p B-8 PDF p 399 Functional Group Header   Time                                GS05 337    SEMANTIC: GS05 is the group ti
X12             270_271_004010x092.pdf                  GS
                                          p B-8 PDF p 399 Functional Group Header   Group Control Number                GS06; 28    Assigned number originated an
X12             270_271_004010x092.pdf                  GS
                                          p B-8 PDF p 399 Functional Group Header   Responsible Agency Code             GS07; 455   Code used in conjunction with D
X12             270_271_004010x092.pdf                  GS
                                          p B-8 PDF p 399 Functional Group Header                                       GS08; 480
                                                                                    Version / Release / Industry Identifier Code    Code indicating the version, rele

X12                                                  GE
                270_271_004010x092.pdf p B-8 PDF p 399 Functional Group Trailer     (this segment is not considered a control segment nor envelope data so neithe




Pg 121 of 148                                                      DataReq-X12D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
X12             270_271_004010x092.pdf PDF p 400                               Number of Transaction Sets Included
                                                      GE FUNCTIONAL GROUP TRAILER                               GE01; 97      Total number of transaction set
X12             270_271_004010x092.pdf PDF p 400                               Group Control Number
                                                      GE FUNCTIONAL GROUP TRAILER                               GE02; 28      Assigned number originated an

                                       P B.16 PDF p 36, 154
X12                                                   406
                270_271_004010x092.pdf PDF p 36, 154,ST Transaction Set Header     Transaction Set Identifier Code ST01 143   Code uniquely identifying a Tran
X12                                                   406
                270_271_004010x092.pdf PDF p 36, 154,ST Transaction Set Header     Transaction Set Control Number ST02; 329   Identifying control number that

X12             270_271_004010x092.pdf PDF p 147      SE Transaction Set Trailer   Number of Included Segments    SE01; 96    Total number of segments inclu
X12             270_271_004010x092.pdf PDF p 147      SE Transaction Set Trailer   Transaction Set Control Number SE02; 329   Identifying control number that




Pg 122 of 148                                                      DataReq-X12D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
             domain specification - range        - format                          - length: maximum
                                                                    - length: minimum                                   c             datatype: o/m/c:         dependent data item list
                                                                                                   example valueusage(s) ompound indicator analysis optional, mandatory, condit
ment separator to be used through the entire interchange           1               1               *                                  n/a          m
                                                                                                                 delimiter; in assembling and parsing the message
                                                                   2               2                                                  code         m            USE OF ADDITIONAL IDE
             values: 00 No Authorization Information Present (No Meaningful Information in I02) ADVISED UNLESS SECURITY REQUIREMENTS MANDATEAuthorization Informatio
                                                                   10 *            10                                                 identifier oroby the     Authorization Informatio
 tion used for additional identification or authorization of the interchange sender or the data in the interchange; the type of information is set text Authorization Information Q
                                                                   2               2                                                  code         m           Security Information 01
             values: 00 No Security Information Present (No Meaningful Information in I04) ADVISED UNLESS SECURITY REQUIREMENTS MANDATE USE OF PASSWORD DATA.;Qua
                                                                   10 sender or the data in the interchange; the type of information is set by theotext
 sed for identifying the security information about the interchange *              10                                                                          Security Information Qua
                                                                                                                                      identifier or Security Information Qualifier (I03).
                                                                   2
             values: 01 Duns (Dun & Bradstreet); 14 Duns Plus Suffix; 20 Health2    Industry Number (HIN) CODE SOURCE 121: Health code             m           Number; 27 ID Qualifier a
                                                                                                                                       Industry Identification Interchange Carrier Ident
                                                                   15 receiver ID to route data to 383 (for SCsender always codes thisidentifier thetext
 ation code published by the sender for other parties to use as the *              15              them; the Medicaid)                                          element
                                                                                                                                        value in ormsender ID Interchange ID Qualifier a
                                                                   2
             values: 01 Duns (Dun & Bradstreet); 14 Duns Plus Suffix; 20 Health2    Industry Number (HIN) CODE SOURCE 121: Health code             m           Number; 27 ID Qualifier a
                                                                                                                                       Industry Identification Interchange Carrier Ident
                                                                   15 is           15              UNI (for UniCare)                  identifier ormtext       Interchange ID Qualifier a
 ation code published by the receiver of the data; When sending, it* used by the sender as their sending ID, thus other parties sending to them will use this as a receiving ID to ro
 the interchange                                YYMMDD             6               6                                                  date         m
 the interchange                                HHMM               4               4                                                  time         m
             Value: U: U.S. EDI Community of ASC X12, TDCC, and UCS1               1                                                  code         m
                                                                   5               5                                                  code
             Value: 00401: Draft Standards for Trial Use Approved for Publication by ASC X12 Procedures Review Board through October 1997          m
ol number assigned by the interchange sender                       1               9                                                  identifier m
                                                                   1               1
             Values: 0 No Acknowledgment Requested; 1 Interchange Acknowledgment Requested                                            code         m
             Values: P Production Data; T Test Data                1               1                                                  code         m
                                                                   1               1               > or :        delimiter; be different than parsing element separator and the segm
                                                                                                                                      n/a          data
d provides the delimiter used to separate component data elements within a composite data structure; this value mustin assembling and the m the message
ment terminator to be used throughout the entire interchange 1                     1               ~                                  n/a          m
                                                                                                                 delimiter; in assembling and parsing the message

 of the number of functional groups included in an interchange 1                 5                                                    count      m
ol number assigned by the interchange sender                   9*                9                                                    identifier m

                                                                  2               2                HS (for 270 Inquiry (270)             code
             Values: HB Eligibility, Coverage or Benefit Information (271); HS Eligibility, Coverage or BenefitEligibility); HB (for 271 Response) m
                                                                  2               this
entifying party sending transmission; codes agreed to by trading partners. Use 15 code to identify the unit sending the information.     identifier m
                                                                  2               15                                                     identifier m
entifying party receiving transmission. Codes agreed to by trading partners. Use this code to identify the unit receiving the information.
                                                CCYYMMDD          8
TIC: GS04 is the group date. Use this date for the functional group creation date.8                                                      date       m
                                                Time expressed inThe recommended as follows: HHMM,
                                                                                  time                                                   time       m
TIC: GS05 is the group time. Use this time for the creation time. 424-hour clock 8 format is HHMM. or HHMMSS, orHHMMSSD, or HHMMSSDD, where H = hours (00-23), M =
d number originated and maintained by the sender                  1               9                                                      identifier m
             Values: X: Accredited Standards Committee X12 1                      2                                                      identifier m
                                                Values:                                                                                  identifier m
             Values: 004010X092: Draft Standards Approved for Publication by ASC X12 Procedures Review Board through October 1997, as published in this implementation guid

envelope data so neither of the two data elements in this segment (number of TS/Number of Transaction Sets Included; Group Control Number (also in GS Functional Group Head




             Pg 123 of 148                                                           DataReq-X12D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                 1             6                                                  count        m
umber of transaction sets included in the functional group or interchange (transmission) group terminated by the trailer containing this data element
d number originated and maintained by the sender                 1             9                                                  identifier m


                                                                   3                 3
             Values: 270 Eligibility, Coverage or Benefit Inquiry; 271 Eligibility, Coverage or Benefit Information               identifier m
                                                                   4                 9                                            identifier m
ing control number that must be unique within the transaction set functional group assigned by the originator for a transaction set

                                                               1
umber of segments included in a transaction set including ST and SE segments 10                                                    count      m
                                                               4               9                                                   identifier m
 ing control number that must be unique within the transaction set functional group assigned by the originator for a transaction set




            Pg 124 of 148                                                         DataReq-X12D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                         domain model reference Note
            business rules/constraints Combined Envelope mapping note
                         10-1-delimiters.
                         3-4-security.username or 3-4-security.password or ?somethingelse
Authorization Information Qualifier and Authorization Information are valued as a group
                         3-4-security.username       this data item may or ?somethingelse
Authorization Information are valued as a groupor 3-4-security.passwordbe space or zero filled to the minimum length
                         3-4-security.username or 3-4-security.password or ?somethingelse
Security Information Qualifier and Security Information are valued as a group
                         3-4-security.username or 3-4-security.passwordbe space or zero filled to the minimum length
                                                     this data item may or ?somethingelse
Security Information Qualifier and Security Information are valued as a group
                         3-2-sender.identifier       sender identifier
Interchange ID Qualifier and Interchange Sender ID are valued as a group
                         3-2-sender.identifier       this data item may
Interchange ID Qualifier and Interchange Sender ID are valued as a groupbe space or zero filled to the minimum length
                         3-3-receiver.identifier
Interchange ID Qualifier and Interchange Receiver ID are valued as a group
                         3-3-receiver.identifier      are data item group
Interchange ID Qualifier and Interchange Receiver ID this valued as amay be space or zero filled to the minimum length
                         3-1.datetime
                         3-1.datetime
                         3-1.syntax identifier
                         3-1.syntax identifier
                         3-1.identifier
            The Interchange Control Number, ISA13, must be identical to the associated Interchange Trailer IEA02.
                                                     See Section
                         3-1.acknowledgement requested code A.1.5.1 for interchange acknowledgment information.
                         3-1.processing environment code
                         10-1.delimiters (deferred to later)
                         10-1.delimiters (deferred to later)

                         3-1.group count
                         3-1.identifier            this data item may the associated Interchange Trailer IEA02.
            The Interchange Control Number, ISA13, must be identical to be space or zero filled to the minimum length

                          <none>
                          <none>
                          <none>
                          <none>
                          <none>
                          ??            ?what is this number GS06 the entire transmission or the to the same the group?
            SEMANTIC: The data interchange controlthe identifier ofin this header must be identicalidentifier for data element in the associated functional group trailer, GE02.
                          3-1.syntax identifier
                          3-1.syntax identifier
            if code in DE455 in GS segment is X, then in DE 480 positions 1-3 are the version number; positions 4-6 are the release and subrelease, level of the version; and positio

GS Functional Group Header); were included in the initial class diagram; that was later reversed)




           Pg 125 of 148                                                           DataReq-X12D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
             <none>        ?
             <none>        ?


             <none>
             <none>
The transaction set control numbers in ST02 and SE02 must be identical. This unique number also aids in error resolution research. Start with the number, for exampl

             <none>
             <none>




Pg 126 of 148                                                        DataReq-X12D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
category                              alias(es) (includes presentation label) (CORE term is Field Name) mandatory, conditional (in context)note
             data item name (CORE term is Element) definition                datatype: analysis optional, model reference
                                                                                          o/m/c:        domain      Combined Envelope mapping
                                                                                                                                Note
payload      Payload Type                          P                         code         m             4-1-payload.syntax identifier
                                      PayloadTypeayload Type specifies the type of payload included within a request, (e.g. HIPAA X12 transaction set 270, 276, 2
             Processing Mode                       Processing Mode indicates Batch or Real-time processing mode (as defined by CORE)
                                      ProcessingMode                         code         m             4-1.processing mode code
payload      Payload Length           PayloadLength                          count        c (for batch only, not for real time)
                                                   Defines the length of the actual payload in bytes.4-1-payload.length
payload      Payload ID                                                       the domain of             4-1-payload.identifier
                                      PayloadID Payload ID (unique within identifier m the party that sets this value) is a payload identifier assigned by the Sen
transmission Time Stamp                                                      datetime m                 4-1.datetime
                                      TimeStampThe Sender (request) or Receiver (response) Time Stamp combines Phase I time and date message metadata int
sender       User Name                UserName User Name is part of User text             c (Required for both batch and real timeItonly Clientcertificate receiver
                                                                                                         authentication credentials. X.509
                                                                              Name/Password based4-4-security.username onlineifcan also be used by theauthentic
sender       Password                                                        text         c (Required4-4-security.password online Password is protected SSL/TLS i
                                                                                                        for both if X.509 Clientcertificate
                                      Password Password is part of the User Name/Password based authentication credentials.onlyauthentication overby transp
sender       Sender Identifier                                               identifier o (data element definition says "User Name attribute does is better if anot
                                                                                                        4-2-sender.identifier
                                      SenderID A unique business entity identifier representing the message envelope creator. Sender Identifier not exist suited
receiver     Receiver Identifier                                             identifier m               4-3-receiver.identifier
                                      ReceiverID A unique business entity identifier representing the next-hop 1-3-receiver.
             CORE Rule Version                     The CORE Rule version that this envelope is using. This value can be used to maintain backward compatibility w
                                      CORERuleVersion                        identifier                 4-1.envelope version identifier
             Checksum                 CheckSum An element used to allowhash               c (Required the Batch, Not usedmessage that
                                                                                                        for integrity of the for
                                                                               receiving site to verify 4-1-payload.checksum Realtime) is sent.
             Error Code                                                        error      c (Required in Response (for
                                                                                                         the envelope.
                                      ErrorCode Error code to indicate thecode when processing4.8-1-error.code both Real-time and Batch), Not used in Reque
             Error Message                         Text                      text         c (Required that caused(not exact mapping) and the ErrorMessage must p
                                                                                                        in Responsethe both Real-time
                                                                                                                      (for
                                      ErrorMessage Error message that describes the condition 4.8-1-error.text 8-1-error. The text ofBatch) Not used in Reques

sender          X.509 Clientcertificate                                                c (see note 4-4-security.authentication certificate
                                                                             encoded data          in o/m/c column for User Name and Password




Pg 127 of 148                                                                 D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                DataReq-CAQH-CORE
                                        source (reference within the file name)
                                                                  category                    data
SDO abbreviation source document (from DataRequirements-Sources, D:document) sub-category item name                definition domain label)
                                                                                                      alias(es) (includes presentationspecification
ONC - Common Data Transport
                                                                  message enclosure attributes
                                                                                  message envelope meta-data

                                                                                    message addressing

                                                                                    multiple types of message content

                                                                   Addressing and routing attributes
                                                                                    organization search and discovery

                                                                                    entity search and discovery

                                                                                    service invocation and metadata

                                                                                    message routing

                                                                                    multiple recipients

                                                                   security attributes
                                                                                     multiple trust frameworks

                                                                                    encryption

                                                                                    signature

                                                                                    authentication

                                                                                    authorization

                                                                   reliable messaging attributes
                                                                                    multiple delivery semantics




Pg 128 of 148                                                              D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                              DataReq-ONC-CDT
                                      fault notification

                     non-functional considerations

                                      scalability

                                      extensibility

                                      platform independent interoperability

                                      coherence




Pg 129 of 148                D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                DataReq-ONC-CDT
- range    - format               - length: example usage(s)
                      - length: minimum maximum value           compound indicator analysis optional, mandatory, conditional (in list number) reference
                                                                         datatype: o/m/c:                 dependent business rules/constraints
                                                                                                                     data item context) model
                                                                                               multiple occurrences (y or maximum  domain


                                                                                                                               theenvelope data requirem

                                                                                                                               3-sender, 3-receiver




                                                                                                                               3-receiver criteria


                                                                                                                               3-security




                                                                                                                               3-4-security.username, 3-4




Pg 130 of 148                                                               D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                               DataReq-ONC-CDT
                                                                              9-1-response.response cod




                                                                              IIsc solution should scale

                                                                              IIsc solution should be exte

                                                                              IIsc solution should allow fo

                                                                              IIsc solution is coherent and




Pg 131 of 148                D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                DataReq-ONC-CDT
           Note


theenvelope data requirements list and associated model should make the distinction clear

3-sender, 3-receiver




           online only

           online only

           online only

           online only?

           online only?




3-4-security.username, 3-4-security.password




           Pg 132 of 148                                                                 D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                            DataReq-ONC-CDT
9-1-response.response code; 8-1-error.code, 8-1-error.text




IIsc solution should scale

IIsc solution should be extensible

IIsc solution should allow for platform independent interoperability

IIsc solution is coherent and harmonized




           Pg 133 of 148                                                            D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                       DataReq-ONC-CDT
Datatype Name      Definition                                             Example Value
indicator          yes/no, boolean                                        yes/no
code                                                                      gender codes (categorizing
                   a constrained value set, typically categorizing something along a particular axis people by gender): female/male M/F
datetime           a point in time                                        11/9/2008 9:09 p.m.
date               a specific day along the continuum of time             11/13/2008
time               a specific time of day                                 5:30 p.m. EST
person name        the complete name of a human being                     Norman Sybert
organization name the name of an organization                             IIBA Greater Boston Chapter
                   the name of something other than a person or organization Meeting
name (other than person, organization)                                    Monthly
money              currency, includes units                               $15.00 US dollars
amount                                                                    13.9 gallons
                   a measured or observed amount (other than currency), includes units
quantity           a count of individual people, places, or things        47 (people)
address            a street or post office box address                    201 Jones Road, Waltham, MA 02451, USA
phone number                                                              +1 beeper, pager,
                   a telephone number which may be dialed (includes fax,(617) 491-7424 etc.)
email address      an address than can be used to send an email message towhoami@gmail.com
internet address                                                          http://www.daoustassociates.com
                   a unique identifier for an internet site (included ftp addresses)
identifier         an identifier for a person, place or thing             S05096683 (for a MA drivers license)
sequence number a number indicating the relative position in a sequence                   2
specification text a textual specification, that typically could be parsed2nd Thursday of the month (except for July and August)
ratio                                                                     49 miles per gallon
                   the division of one amount by another amount, generally of different category of units

text                a human readable textual description                   Everyone should understand how to document data requirements.
encoded data                                                               a JPEG image
                    a file, document or collection of related data that typically requires special software to view or unencode it
n/a                 datatype is not applicable (this value is used for delimiter characters, groups of data elements, etc.)




Pg 134 of 148                                                                   D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                 Datatypes-Analysis
Column Name                   Definition                                                      Example Value         Note
SDO abbreviation                                                                              OASIS
                              the standard abbreviation for the organization that created the standard
source reference              the file name of the document the information was obtained from NCPDP_SCRIPT_Imp_Guide_v8.1.pdf
                              a reference                                                     p 23
source (reference within the document) to the location within the source reference document where the data item details can be found. Sometimes valued with a d
category                      a categorization of a group of data items. Sometimes this was valued with the segment identifier and name.
subcategory                   a further categorization of a group of data items.
data item name                                                                                home
                              the name used to refer to the data item in the source specificationaddress
alias(es)                     other names or abbreviations by which the data item is known, or a data element identifier from the source
definition                    text that specifies the meaning of the data item                the full address where a person lives (including street, city, state/province, z
domain specification                                                                           form is dependent
                              the specification for the set of valid values; the specificationF: female; M: male upon the analysis datatype; for example, for the code da
 - range                      the specification of the minimum and maximum valid values.01 - 99.99
 - format                     the specification of the format of an individual data item valuemm/dd/ccyy
 - minimum length                                                                             2 (characters for US state code)
                                                                                                                    See
                              the minimum length in display characters of the data item (ignoring empty values) comment in Notes worksheet for Minimum Length
 - maximum length             the maximum length in display characters of the data item 30 (characters for street line 1 portion of home address)
example value                 a representative value for the data item                        157 Raymond St, Cambridge, MA 02140-3314 USA
usage(s)                                                                                      delivering USPS mail; categorizing residences by country, state, city, zip cod
                              a list of purposes the data item values are used for (e.g. categorizing, sorting/ordering, identification, display)
compound indicator                                                                            y
                              an indicator that the data item can be broken down into more elemental data items
datatype: analysis                                                                            address
                              a term categorizing the data item characteristics, based in part on the operations that can be performed on the data values. See the Dat
                              a categorization of whether the data item can be empty, must always be valued, or must be valued if certain condition(s) are true
o/m/c: optional, mandatory, conditional (in context)                                          mandatory
                              an indication that                                              y
multiple occurrences (y or maximum number) the data item may repeat (y) or the maxiumum number of allowed occurrences
dependent data item list      the list of data items that are always dependent on one another (in other representations they might be considered a "compound data
business rules/constraints/valued condition                                                   street, city, state, and 5 digit zip must be valued
domain model reference                                                                        Sender.address model
                              a reference to the representation of the data item in the associated domain (where Sender is the class name and address is the attribute
                              note
Combined Envelope mapping a note on the domain model reference, a mapping to a consolidated envelope
Note                          a placeholder for additional information that doesn't fit into any of the other columns

Below columns are only in the IIsc-consolidated worksheet:
level (a temporary number until we arrive a better name)
batch only (b)/online only (o) a code to indicate if the data element is only used for batch or online
Mapping to Source data element(s):                                                                        This column is just a decription of the following columns
CAQH-CORE Phase 2 Rules the data element(s) from the standard that map to the combined data element and that identified the need for this data element
                                notes
CAQH-CORE Phase II Mappingnotes on the mapping from the standard to this data element
CDISC-Lab                      the data element(s) from the standard that map to the combined data element and that identified the need for this data element
CDISC-Lab Mapping notes        notes on the mapping from the standard to this data element


Pg 135 of 148                                                                      D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                              DataRequirements-col-definition
DICOM                      the data element(s) from the standard that map to the combined data element and that identified the need for this data element
DICOM Mapping notes        notes on the mapping from the standard to this data element
HL7-V2.6                   the data element(s) from the standard that map to the combined data element and that identified the need for this data element
HL7-V2.6 Mapping notes     notes on the mapping from the standard to this data element
HL7-V3                     the data element(s) from the standard that map to the combined data element and that identified the need for this data element
HL7-V3 Mapping notes       notes on the mapping from the standard to this data element
IHE-XDP                    the data element(s) from the standard that map to the combined data element and that identified the need for this data element
IHE-XDP Mapping notes      notes on the mapping from the standard to this data element
IHE - XDR                  the data element(s) from the standard that map to the combined data element and that identified the need for this data element
IHE - XDR Mapping notes    notes on the mapping from the standard to this data element
NDPDP-SCRIPT               the data element(s) from the standard that map to the combined data element and that identified the need for this data element
                           n
NDPDP-SCRIPT Mapping notes otes on the mapping from the standard to this data element
NCPDP-telecom - Batch      the data element(s) from the standard that map to the combined data element and that identified the need for this data element
                           notes on
NCPDP-telecom - Batch Mapping notesthe mapping from the standard to this data element
NCPDP-telecom - Real Time the data element(s) from the standard that map to the combined data element and that identified the need for this data element
                           notes on the mapping from the standard to this data element
NCPDP-telecom - Real Time Mapping Notes
OASIS-EDXL-DE-COMCARE the data element(s) from the standard that map to the combined data element and that identified the need for this data element
                           notes notes
OASIS-EDXL-DE-COMCARE Mapping on the mapping from the standard to this data element
ONC-CDT                    the data element(s) from the standard that map to the combined data element and that identified the need for this data element
ONC-CDT Mapping notes      notes on the mapping from the standard to this data element
X12                        the data element(s) from the standard that map to the combined data element and that identified the need for this data element
X12 Mapping notes          notes on the mapping from the standard to this data element
Outstanding Issues




Pg 136 of 148                                                                 D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                         DataRequirements-col-definition
uding street, city, state/province, zip or postal code, country)




 worksheet for Minimum Length
home address)

ces by country, state, city, zip code




be considered a "compound data item") and/or the list of parent or child data items

s name and address is the attribute name in a UML class model)




ecription of the following columns:
e need for this data element

e need for this data element




            Pg 137 of 148                                                                   D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                                       DataRequirements-col-definition
e need for this data element

e need for this data element

e need for this data element

e need for this data element

e need for this data element

e need for this data element

e need for this data element

e need for this data element

e need for this data element

e need for this data element

e need for this data element




            Pg 138 of 148                           D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                               DataRequirements-col-definition
SDO abbreviation                          source (reference within the file name)
                                                                    category
                   source document (from DataRequirements-Sources, D:document)                data     alias(es) (includes presentationspecification
                                                                                    sub-category item name          definition domain label)




Pg 139 of 148                                                             D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                            DataReq-SDOtemplate
- range    - format               - length: example usage(s)
                      - length: minimum maximum value          compound indicator analysis optional, mandatory, conditional (in list number) reference
                                                                        datatype: o/m/c:                 dependent business rules/constraints
                                                                                                                    data item context) model
                                                                                              multiple occurrences (y or maximum  domain




Pg 140 of 148                                                            D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                           DataReq-SDOtemplate
Note




Pg 141 of 148                 D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                DataReq-SDOtemplate
Category          Note
                  In cases where a data item was defined to be have the same minimum and maximum length and might be space or zero filled as appropriate to m
Minimum Length column
Note column       In some cases there was a more descriptive or "informal" data element name than that listed in the specifications and included in the data item




Pg 142 of 148                                                         Notes     D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
or zero filled as appropriate to meet the minimum length, an asterisk was added after the minimum length value and an annotation was placed in the corresponding Notes colum
s and included in the data item name column. I sometimes included this "informal" data element name in the Note column.




           Pg 143 of 148                                                           Notes    D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
corresponding Notes column for the data item.




          Pg 144 of 148                         Notes   D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
Diagram Identifier                   Name                                                                                 Note
        List:
n       COCT_MT900000UV              A_DetectedIssueUniversal                                                             n/f
y       COCT_MT960000UV              A_SpacialCoordinate                                                                  <expanded>

y        COCT_MT1500003UV            E_Organization[contact]                                                              <no expansion>
y        COCT_MT150000UV02           E_OrganizationUniversal                                                              <expanded>
y        COCT_MT030203UV             E_PersonContact                                                                      <no expansion>
y        COCT_MT710000UV             E_Place [universal]                                                                  <expanded>

y        COCT_RM090309UV             R_AssignedDevice[contact]                                                            <expanded>
y        COCT_MT090300UV01           R_AssignedDeviceUniversal                                                            <expanded>
n - ND   COCT_MT000106               R_AssignedPerson[identified/informational]                                           n/lf
y        COCT_MT090100UV01           R_AssignedPersonUniversal                                                            <expanded>
y        COCT_MT070000UV01           R_LocationLocatedEntityUniversal                                                     <expanded>
y        COCT_MT040203UV01           R_NotificationPartyContact                                                           <expanded>

         Hierarchy:
         E_OrganizationUniversal
                                     R_LocationLocatedEntityUniversal                                                     <expanded>
         R_AssignedDevice[contact]
                                     E_Organization[contact]                                                              <no expansion>
         R_AssignedDeviceUniversal
                                     E_OrganizationUniversal                                                              <expanded>
                                     E_OrganizationUniversal                                                              <expanded>
                                     R_LocationLocatedEntity[universal]                                                   <expanded>
                                     E_Organization[contact]                                                              <no expansion>
         R_AssignedPersonUniversal
                                    E_OrganizationContact
                                    E_OrganizationUniversal                                                               <expanded>
                                    E_OrganizationUniversal                                                               <expanded>
                                    R_LocationLocatedEntityUniversal                                                      <expanded>
                                    (from
         R_LocationLocatedEntityUniversal PrincipalChoiceList)
                                    E_Place [universal]                                                                   <expanded here>


Pg 145 of 148                                                                  D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                          HL7-V3-CMETs-listings-obsolete
                                                                          A_SpacialCoordinate                              <expanded here>
                                                                                            R_AssignedPerson[identified/informational]
                                                                                            R_AssignedDevice[contact]      <expanded here>
                                                                                                                           <no expansion>
                                                                                                           E_Organization[contact]
         R_NotificationPartyContact
                                      E_OrganizationContact                                                               <no expansion>
                                      E_PersonContact                                                                     <no expansion>




Pg 146 of 148                                                                  D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                                                          HL7-V3-CMETs-listings-obsolete
<expanded>

<no expansion>
<expanded>
<no expansion>
<expanded>

<expanded>
<expanded>

<expanded>
<expanded>
<expanded>




<expanded>

<no expansion>

<expanded>
<expanded>
<expanded>
<no expansion>


<expanded>
<expanded>
<expanded>

<expanded here>


         Pg 147 of 148                        D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                         HL7-V3-CMETs-listings-obsolete
<expanded here>
ormational]
<expanded here>
<no expansion>

<no expansion>
<no expansion>




         Pg 148 of 148                        D:\Docstoc\Working\pdf\a63d4600-1f07-4248-8640-4c626f8cf8b5.xls
                         HL7-V3-CMETs-listings-obsolete

				
DOCUMENT INFO
Shared By:
Categories:
Tags:
Stats:
views:20
posted:8/28/2011
language:English
pages:148