Requirements for HingX Resource ADD API from HL7

Documentation of the HL7 requirements for posting (adding) a new Resource to the HingX repository. Material is built off the initial HingX API posted August 12, 2012.

Steps

1. What artifacts are appropriate/advantageous as HingX resources?

2. Note where these artifacts may be contained within another

3. Note where these artifacts may depend upon another

4. What is (are) the primary identifier(s) of the artifact

5. What are the primary characteristics that should be used to find artifacts

6. How, if at all, are characteristics arranged in a hierarchy?

Starter Artifacts from the V3 Messaging World (expressed in containment hierarchy)

• Normative Edition
  • Reference Information Model (RIM) Release (already a HingX resource)

  • Application Domain (does not distinguish infrastructure like "wrappers" from clinical like "pharmacy") contains:
    • Interaction
      • References one or more SIM

    • Domain Information Model (DIM) (Use the SAIF term)
      • Derived from RIM

    • Serializable Information Models (Use the SAIF term)
      • Derived from a DIM
      • Derived from 0..* SIM

    • Trigger Events - Skip from Interaction, are not general enough for HingX resource status

    • Application Roles - Skip from Interaction, are not general enough for HingX resource status

    • Receiver Responsibilities - Skip from Interaction, are not general enough for HingX resource status

Properties of Artifacts (Used to find and retrieve)

Note: In the following, required properties are in bold.

Normative Edition

• Identifier (Like NE2012)

• Publication date

• Identifier of RIM based-on

RIM

• Identifier (like rim0240)

• Bound-to Data Types Release

• Bound-to Vocabulary Release

Application Domain

• Identifier (two character code, like pa)

• Realm Namespace (like UV)

• Publication date

• Containing Edition Identifier

• Scope description

• Responsible Work Group

Interaction

• Identifier (like PRPA_IN090909UV)

• Description

• Type

• Identifier of "payload" SIM (like PRPA_MT998877UV)

• Realm Namespace (like UV)

DIM

• Containing Domain identifier

• Realm Namespace (like UV)

• DIM Identifier, (if more than one in domain) (like PRPA_DM000002UV01)

• Publication date

• Description (brief)

SIM

• Containing Domain identifier (like pa)

• Identifier (like PRPA_MT123321UV06)

• Realm Namespace (like UV)

• Version (like 06)

• Is registered common type? (Boolean for registered CMETs)

• Description (from EntryPoint)

• Entry Class properties
  • RIM Class Name
  • classCode or typeCode
  • moodCode or determinerCode (if Act or Entity)

• List of CMETs used