FHIR IG Statistics: StructureDefinition/profile-message-header-request

Resources that use this resource

No resources found

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "profile-message-header-request",
  "url": "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-message-header-request",
  "name": "MessageHeaderRequest",
  "title": "MessageHeader Request",
  "status": "draft",
  "description": "Message Header Request for Pharmacy claims",
  "purpose": "Message Header Request for Pharmacy claims",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "MessageHeader",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/MessageHeader",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "MessageHeader.id",
        "path": "MessageHeader.id",
        "comment": "Usage Note:   This is used to link the request/response and will be present in the MessageHeader.response.identifier\r\nTypically, the resource has an id except for cases like the create operation, conditional updates.",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.meta",
        "path": "MessageHeader.meta",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.meta.profile",
        "path": "MessageHeader.meta.profile",
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.meta.tag",
        "path": "MessageHeader.meta.tag",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "system"
            }
          ],
          "rules": "open"
        },
        "comment": "Usage Note:   There is one mandatory tag to identify the \"message version\" that is being sent.   The initial version \"1.0\"  \r\n\r\nThe tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.meta.tag:MessageVersion",
        "path": "MessageHeader.meta.tag",
        "sliceName": "MessageVersion",
        "min": 1,
        "max": "1"
      },
      {
        "id": "MessageHeader.meta.tag:MessageVersion.system",
        "path": "MessageHeader.meta.tag.system",
        "min": 1,
        "fixedUri": "http://pharmacyeclaims.ca/FHIR/CodeSystem/message-version",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.meta.tag:MessageVersion.code",
        "path": "MessageHeader.meta.tag.code",
        "comment": "Usage Note:   There is one mandatory tag to identify the \"message version\" that is being sent.   The initial version \"1.0\"  \r\nNote that FHIR strings SHALL NOT exceed 1MB in size",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.event[x]",
        "path": "MessageHeader.event[x]",
        "comment": "Usage Note::   The event code will identify the transaction type being processed.   *Only the response events (31,51,61,71,81 apply for responses\r\nSet value = 101=transaction with one (1) pay provider claim or pay cardholder claim for a dispense \r\nSet value = 103 =transaction with one (1) pay provider or pay cardholder claim for Professional Services\r\nSet value = 111= transaction for reversal of either a dispense or professional services claim\r\nSet value = 131 = Response to a pay provider or pay cardholder claim for a professoinal services claim\r\nSet value = 151= Response to a pay provider  or pay cardholder claim (formerly CPHA 54) for a dispense \r\nSet value = 161= Response to request for reversal of a pay provider claim or a pay cardholder claim  (formerly CPHA 64) which was adjudicated\r\nSet value = 130 = Request for Daily Totals\r\nSet value = 180 = Response for Daily Totals\r\nSet value = 131 = Request for Adjudication Summary\r\nSet value = 181 = Response Adjudication Summary\r\nCPHA Mapping: Transaction Code  A.03.03.   Note:   CPHA Transactions 30, 31,32,33,54, 57,64,67 have been deprecated.  \r\n*Binding and value set to be added at a later phase*\r\n\r\nThe time of the event will be found in the focus resource. The time of the message will be found in [Bundle.timestamp](bundle-definitions.html#Bundle.timestamp).",
        "type": [
          {
            "code": "Coding"
          }
        ],
        "mustSupport": true
      },
      {
        "id": "MessageHeader.event[x].system",
        "path": "MessageHeader.event[x].system",
        "comment": "Set value = http://pharmacyeclaims.ca/fhir/CodeSystem/message-events\r\n\r\nThe URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...).  OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.event[x].code",
        "path": "MessageHeader.event[x].code",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.event[x].display",
        "path": "MessageHeader.event[x].display",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.destination",
        "path": "MessageHeader.destination",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.destination.name",
        "path": "MessageHeader.destination.name",
        "comment": "Usage:   Network Name that will be used by some adjudicators who will provide the values to be set\r\nNo CPHA Mapping as this is a new data element\r\n\r\nNote that FHIR strings SHALL NOT exceed 1MB in size",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.destination.receiver",
        "path": "MessageHeader.destination.receiver",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.destination.receiver.identifier",
        "path": "MessageHeader.destination.receiver.identifier",
        "comment": "CPHA Mapping:  IIN ( Issuer Identification Number)\r\n\r\nWhen an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference.  For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport).  One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.destination.receiver.identifier.system",
        "path": "MessageHeader.destination.receiver.identifier.system",
        "min": 1,
        "fixedUri": "http://pharmacyeclaims.ca/FHIR/CPHA-identifier/IIN",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.destination.receiver.identifier.value",
        "path": "MessageHeader.destination.receiver.identifier.value",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.sender",
        "path": "MessageHeader.sender",
        "comment": "Usage Note:   This will identify the Software vendor client name.   This will only be used by some adjudicators.\r\nCPHA Map:  None as this is a new data element\r\n\r\nUse case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone.",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.sender.identifier",
        "path": "MessageHeader.sender.identifier",
        "comment": "Usage:   Software vendor client identifier; may be requested by some adjudicator and used for trouble shooting purposes.\r\nCPHA Map:   This is a new data field.\r\n\r\nWhen an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference.  For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport).  One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.sender.display",
        "path": "MessageHeader.sender.display",
        "comment": "Usage:  Implementer can specify expectations, eg Software Vendor Client Name or Active Device ID\r\nCPHA Map:  A.07.03 Active Device ID\r\n\r\nThis is generally not the same as the Resource.text of the referenced resource.  The purpose is to identify what's being referenced, not to fully describe it.",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.source",
        "path": "MessageHeader.source",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.source.name",
        "path": "MessageHeader.source.name",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.source.software",
        "path": "MessageHeader.source.software",
        "comment": "CPHA Mapping:  Provider Software ID   A.04.03\r\nNote that FHIR strings SHALL NOT exceed 1MB in size",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.source.version",
        "path": "MessageHeader.source.version",
        "comment": "CPHA Mapping:  Provider Software Version  A.05.03\r\nNote that FHIR strings SHALL NOT exceed 1MB in size",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.source.endpoint",
        "path": "MessageHeader.source.endpoint",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.responsible",
        "path": "MessageHeader.responsible",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.responsible.reference",
        "path": "MessageHeader.responsible.reference",
        "comment": "Usage Note:   This will be a reference to the pharmacy organization resource if requested by implementer.  Useful when additional pharmacy information (other than the identifier) is warranted\r\n\r\nUsing absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries.   Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server."
      },
      {
        "id": "MessageHeader.responsible.identifier",
        "path": "MessageHeader.responsible.identifier",
        "comment": "Usage:   The pharmacy identifier may be useful in the message header.   \r\n\r\nWhen an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference.  For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport).  One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.responsible.identifier.system",
        "path": "MessageHeader.responsible.identifier.system",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.responsible.identifier.value",
        "path": "MessageHeader.responsible.identifier.value",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.response",
        "path": "MessageHeader.response",
        "max": "0"
      },
      {
        "id": "MessageHeader.focus",
        "path": "MessageHeader.focus",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-claim-dispense",
              "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-claim-professional",
              "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-parameters-reversal-IN",
              "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-parameters-daily-totals-details-IN"
            ],
            "aggregation": [
              "bundled"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "MessageHeader.focus.reference",
        "path": "MessageHeader.focus.reference",
        "min": 1,
        "mustSupport": true
      }
    ]
  }
}