FHIR IG analytics

Resources that use this resource

No resources found

Resources that this resource uses

Narrative

No narrative content found in resource

Source1

{
  "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",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.meta.tag",
        "path": "MessageHeader.meta.tag",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "system"
            }
          ],
          "rules": "open"
        },
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.meta.tag.system",
        "path": "MessageHeader.meta.tag.system",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.meta.tag.code",
        "path": "MessageHeader.meta.tag.code",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.event[x]",
        "path": "MessageHeader.event[x]",
        "comment": "Usage Note::   The event code will identify the transaction type being processed\r\nprocessed.   \r\nSet value = 51= Response to a dispense claim\r\nSet value = 52 - Response to professional services claim\r\nSet value = 61= Response to request for reversal \r\nSet value = 80 = Response for Daily Totals\r\nSet value = 81 = Response Adjudication Summary\r\n\r\nCPHA Mapping: Transaction Code  A.03.03.     \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,
        "binding": {
          "strength": "preferred",
          "valueSet": "http://pharmacyeclaims.ca/fhir/valueset-message-events"
        }
      },
      {
        "id": "MessageHeader.event[x].system",
        "path": "MessageHeader.event[x].system",
        "comment": "Usage:   A fixed value of http://pharmacyeclaims.ca/fhir/CodeSystem/message-events-response\r\nCPHA Mapping:  None \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,
        "fixedUri": "http://pharmacyeclaims.ca/fhir/CodeSystem/message-events",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.event[x].code",
        "path": "MessageHeader.event[x].code",
        "comment": "Usage:  The response value will be one of:\r\n51 - Response to Pay Provider or Pay Cardholder Claim for Dispensed Medication\r\n52 - Response to Professional Services Claim\r\n61 - Response to Reversal Request\r\n80 - Response to Daily Totals\r\n81 - Response to Adjudication DetailsNote that FHIR strings SHALL NOT exceed 1MB in size",
        "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.target",
        "path": "MessageHeader.destination.target",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.destination.target.identifier",
        "path": "MessageHeader.destination.target.identifier",
        "comment": "Usage:  An optional identifier used to specify the target network\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.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.destination.receiver",
        "path": "MessageHeader.destination.receiver",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.destination.receiver.identifier",
        "path": "MessageHeader.destination.receiver.identifier",
        "comment": "Usage Note:   This should be treated as mandatory for backward compatibility\r\nCPHA 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).",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.destination.receiver.display",
        "path": "MessageHeader.destination.receiver.display",
        "comment": "Usage:   This should be treated as mandatory for backward compatibility\r\nCPHA Map:  Provider Software Version A.05.03\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",
        "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.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",
        "comment": "Usage:  Mandatory when the message has been successfully processed by the receiving application\r\n\r\nThe data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message.  Only the root resource is specified.  The resources it references should be contained in the bundle but are not also listed here.  Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.",
        "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-parameters-OUT-AdjudicationDetails",
              "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-parameters-daily-totals-OUT"
            ],
            "aggregation": [
              "bundled"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "MessageHeader.focus.reference",
        "path": "MessageHeader.focus.reference",
        "min": 1,
        "mustSupport": true
      }
    ]
  }
}