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-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.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.system",
        "path": "MessageHeader.meta.tag.system",
        "comment": "Usage Note:  Use system http://pharmacyeclaims.ca/FHIR/CodeSystem/message-version to specify the version\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,
        "fixedUri": "http://pharmacyeclaims.ca/FHIR/CodeSystem/message-version",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.meta.tag.code",
        "path": "MessageHeader.meta.tag.code",
        "comment": "Usage: 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 = 02 =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 = 30 = Request for Daily Totals\r\nSet value = 31 = Request for Adjudication Details\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 = 80 = Response for Daily Totals\r\nSet value = 81 = 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\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": "Set value = http://pharmacyeclaims.ca/fhir/CodeSystem/message-events-request\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,
        "fixedUri": "http://pharmacyeclaims.ca/fhir/CodeSystem/message-events",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.event[x].code",
        "path": "MessageHeader.event[x].code",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.destination",
        "path": "MessageHeader.destination",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.destination.target",
        "path": "MessageHeader.destination.target",
        "comment": "Usage:  Will be used to specify an optional identifier to identify the target network or intermediary system. \r\n\r\nReferences SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.destination.target.identifier",
        "path": "MessageHeader.destination.target.identifier",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.destination.endpoint",
        "path": "MessageHeader.destination.endpoint",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.destination.receiver",
        "path": "MessageHeader.destination.receiver",
        "comment": "Usage:   The IIN, Issuer Identification Number identifies issuer of benefit card\r\n\r\nReferences SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
        "min": 1,
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
              "http://hl7.org/fhir/StructureDefinition/Organization"
            ]
          }
        ],
        "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.source",
        "path": "MessageHeader.source",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.source.extension:sourceProvinceCode",
        "path": "MessageHeader.source.extension",
        "sliceName": "sourceProvinceCode",
        "comment": "Usage Note:  This may be useful for troubleshooting purposes.   Implementers may wish to inclue\r\n\r\nThere can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/ext-SourceProvinceCode"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "MessageHeader.source.name",
        "path": "MessageHeader.source.name",
        "comment": "Usage Note:   This will identify the POS vendor client name for troubleshooting purposes.   Could include banner.\r\nCPHA 3 Map:  None.  This will only be used at the request of the implementer.\r\n\r\nCPHA Map:  None as this is a new data elementNote that FHIR strings SHALL NOT exceed 1MB in size",
        "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",
        "comment": "Usage:  This may map to CPHA3 Active Device ID  A.07.03\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.responsible",
        "path": "MessageHeader.responsible",
        "comment": "Usage Note:   This will be a reference to the pharmacy organization resource  \r\nUsage Note:  For reversals, the identifier must be present  CPHA Map:  \r\nUsually only for the request but can be used in a response.",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "MessageHeader.responsible.identifier",
        "path": "MessageHeader.responsible.identifier",
        "comment": "Usage Note:  Must be present for Reversal requests to identify the Pharmacy and may also be present for all other requests.   \r\nMapping:  CPHA 3 B21.03 Pharmacy ID Code\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.responsible.identifier.system",
        "path": "MessageHeader.responsible.identifier.system",
        "fixedUri": "http://pharmacyeclaims.ca/FHIR/PharmacyID",
        "mustSupport": true
      },
      {
        "id": "MessageHeader.responsible.identifier.value",
        "path": "MessageHeader.responsible.identifier.value",
        "min": 1,
        "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
      }
    ]
  }
}