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

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-response",
  "url": "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-message-header-response",
  "name": "MessageHeaderResponse",
  "title": "Message Header Response",
  "status": "draft",
  "description": "MessageHeaderResponse",
  "purpose": "MessageHeaderResponse",
  "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",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.meta",
        "path": "MessageHeader.meta",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.meta.profile",
        "path": "MessageHeader.meta.profile",
        "min": 1,
        "max": "1",
        "fixedCanonical": "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-message-header-response",
        "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
      },
      {
        "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\n\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 = 01=transaction with one (1) pay provider claim or pay cardholder claim for a dispense \r\nSet value = 03 =transaction with one (1) pay provider or pay cardholder claim for Professional Services\r\nSet value = 11= transaction for reversal of either a dispense or professional services claim\r\nSet value = 31 = Response to a pay prUsage 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 = 01=transaction with one (1) pay provider claim or pay cardholder claim for a dispense \r\nSet value = 03 =transaction with one (1) pay provider or pay cardholder claim for Professional Services\r\nSet value = 11= transaction for reversal of either a dispense or professional services claim\r\nSet value = 31 = Response to a pay provider or pay cardholder claim for a professoinal services claim\r\nSet value = 51= Response to a pay provider  or pay cardholder claim (formerly CPHA 54) for a dispense \r\nSet value = 61= Response to request for reversal of a pay provider claim or a pay cardholder claim  (formerly CPHA 64) which was adjudicated\r\nSet value = 30 = Request for Daily Totals\r\nSet value = 80 = Response for Daily Totals\r\nSet value = 31 = Request for Adjudication Summary\r\nSet value = 81 = Response Adjudication Summary\r\n\r\nCPHA Mapping: Transaction Code  A.03.03.   Note:  CPHA Transactions 30, 31,32,33,54, 57,64,67 have been deprecated.  \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",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.event[x].code",
        "path": "MessageHeader.event[x].code",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.destination",
        "path": "MessageHeader.destination",
        "comment": "Usage Note:   For responses, the destination is the sending Pharmacy\r\n\r\nThere SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.",
        "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.target",
        "path": "MessageHeader.destination.target",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.destination.target.identifier",
        "path": "MessageHeader.destination.target.identifier",
        "comment": "CPHA Mapping:  Provider Software ID   A.04.03\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.endpoint",
        "path": "MessageHeader.destination.endpoint",
        "comment": "Usage Note:   Endpoint for the network routing to the Pharmacy.   Normally this is the source endpoint from the request message.\r\n\r\nThe id may be a non-resolvable URI for systems that do not use standard network-based addresses.",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.source",
        "path": "MessageHeader.source",
        "comment": "Usage Note:   This is the endpoint of the Adjudicator;  values will be set by each system.    This may vary across environments (test/production).",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.source.name",
        "path": "MessageHeader.source.name",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.source.software",
        "path": "MessageHeader.source.software",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.source.version",
        "path": "MessageHeader.source.version",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.source.endpoint",
        "path": "MessageHeader.source.endpoint",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.response",
        "path": "MessageHeader.response",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.response.identifier",
        "path": "MessageHeader.response.identifier",
        "comment": "Usage Note:  Mandatory as this allows the receiver to link the request and response\r\n\r\nRFC 4122",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.response.code",
        "path": "MessageHeader.response.code",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.response.details",
        "path": "MessageHeader.response.details",
        "comment": "Usage Note:   If the message has failed, an operation outcome with further details may be included here; will also be referenced as the focus if there is only an Operations Outcome that is returned.\r\n\r\nThis SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.response.details.reference",
        "path": "MessageHeader.response.details.reference",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.focus",
        "path": "MessageHeader.focus",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-claim-response",
              "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-error-response",
              "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-parameters-reversal-OUT",
              "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-claim-response-proff-services"
            ],
            "aggregation": [
              "bundled"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "MessageHeader.focus.reference",
        "path": "MessageHeader.focus.reference",
        "min": 1,
        "mustSupport": true
      }
    ]
  }
}