FHIR IG Statistics: StructureDefinition/profile-error-response

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "profile-error-response",
  "url": "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-error-response",
  "name": "ErrorClaimResponse",
  "title": "Claim Response with Errors",
  "status": "draft",
  "description": "A claim response that has errors and therefore cannot be fully adjudicated",
  "purpose": "A claim response that has errors and therefore cannot be fully adjudicated",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "ClaimResponse",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ClaimResponse",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "ClaimResponse",
        "path": "ClaimResponse",
        "comment": "Usage Note:  This profile is used when a calim or reversal has been rejected due to errors.\r\nCPHA Mapping:   Response Status E.05.03 = R \"R=rejected claim/reversal\" where errors are detected"
      },
      {
        "id": "ClaimResponse.meta",
        "path": "ClaimResponse.meta",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.meta.profile",
        "path": "ClaimResponse.meta.profile",
        "max": "1",
        "fixedCanonical": "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-error-response",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.identifier",
        "path": "ClaimResponse.identifier",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "assigner.identifier.type.coding.system"
            }
          ],
          "rules": "open"
        },
        "comment": "Usage Note:    There are two identifiers; the Reference number which maps to CPHA and a response identifier which is not restricted    Both are assigned by the processor.    Minimally, one identifier must be present for the Reference number (limited to 9N).   The additional identifier must also be specified, without limitation and will eventually replace the Reference number as it will be unlimited.\r\n\r\nCPHA Map:  Reference Number E.04.03\r\nUsage Note:  this is optional in CPHA",
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.identifier.system",
        "path": "ClaimResponse.identifier.system",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.identifier.value",
        "path": "ClaimResponse.identifier.value",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.identifier:ReferenceNumber",
        "path": "ClaimResponse.identifier",
        "sliceName": "ReferenceNumber",
        "comment": "Usage Note: This is an internal reference number assigned to each claim by the processor.    This must be present on all claim response\r\nCPHA Mapping: Reference Number  E.04.03  9N",
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.identifier:ReferenceNumber.system",
        "path": "ClaimResponse.identifier.system",
        "max": "0"
      },
      {
        "id": "ClaimResponse.identifier:ReferenceNumber.value",
        "path": "ClaimResponse.identifier.value",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.identifier:ResponseIdentifier",
        "path": "ClaimResponse.identifier",
        "sliceName": "ResponseIdentifier",
        "comment": "Usage Note:   A GUID may be used as this number must be unique.  The system may be assigned by the adjudicaiton system to identify the unique namespace.",
        "min": 1,
        "max": "1"
      },
      {
        "id": "ClaimResponse.identifier:ResponseIdentifier.system",
        "path": "ClaimResponse.identifier.system",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.identifier:ResponseIdentifier.value",
        "path": "ClaimResponse.identifier.value",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.status",
        "path": "ClaimResponse.status",
        "fixedCode": "active",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.type",
        "path": "ClaimResponse.type",
        "fixedCodeableConcept": {
          "text": "pharmacy"
        },
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.type.coding",
        "path": "ClaimResponse.type.coding",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.type.coding.code",
        "path": "ClaimResponse.type.coding.code",
        "min": 1,
        "fixedCode": "pharmacy",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.use",
        "path": "ClaimResponse.use",
        "fixedCode": "claim",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.patient",
        "path": "ClaimResponse.patient",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-patient"
            ],
            "aggregation": [
              "bundled"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.created",
        "path": "ClaimResponse.created",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.insurer",
        "path": "ClaimResponse.insurer",
        "comment": "Usage Note:   This conveys the identifer for the insurer\r\nCPHA Mapping:  IIN ( Issuer Identification Number)    A.01.01\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": "ClaimResponse.insurer.identifier",
        "path": "ClaimResponse.insurer.identifier",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.request",
        "path": "ClaimResponse.request",
        "comment": "Usage:  This is the number assigned, by the provider, to the request to which this response applies.   This includes both the main identifier as well as the trace number for backward compatibility.\r\nCPHA Map:   Trace Number E.02.03 6N, maps to display\r\n\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,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.request.identifier",
        "path": "ClaimResponse.request.identifier",
        "comment": "CPHA Map:  Trace Number E.02.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": "ClaimResponse.request.identifier.system",
        "path": "ClaimResponse.request.identifier.system",
        "min": 1,
        "fixedUri": "http://pharmacyeclaims.ca/FHIR/CPHA-identifier/trace-number",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.request.identifier.value",
        "path": "ClaimResponse.request.identifier.value",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.request.display",
        "path": "ClaimResponse.request.display",
        "comment": "Usage Note:  This will be the Claim.identifier (slice Claim-identifier) from the request message.   Note:  the additional identifier from the request ( Trace number ) will be conveyed in the display element.\r\nCPHA MAP:   \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": "ClaimResponse.outcome",
        "path": "ClaimResponse.outcome",
        "fixedCode": "error",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.disposition",
        "path": "ClaimResponse.disposition",
        "comment": "CPHA Map:   Response Status E.05.03\r\nThis indicates the status of the claim response which is a value of \"R\" = Rejected claim/reversal\r\n\r\nSet value = Single letter of A or B or C, etc.. as follows:\r\n\r\nA=accepted as transmitted - no adjustments\r\nB=accepted with Rx price adjustment\r\nC=claim captured for batch processing\r\nD=pay cardholder claim accepted\r\nR=rejected claim/reversal\r\nV=reversal acceptedNote that FHIR strings SHALL NOT exceed 1MB in size",
        "min": 1,
        "fixedString": "R",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item",
        "path": "ClaimResponse.item",
        "comment": "Note:  This is not permitted; used as a differentiator in the FHIR profiles.",
        "max": "0"
      },
      {
        "id": "ClaimResponse.processNote",
        "path": "ClaimResponse.processNote",
        "comment": "Usage:  Detailed response information which may be returned with errors.\r\n\r\nConformance Rule:   A maximum of 1000 characters may be returned for each note\r\nConformance Rule:   A maximum of 10 notes can be returned; this allows for a given note to be returned in both english and french and therefore allows up to 20 instances.    \r\nConformance Rule:   Where possible adjudicators must return both english and french as this allows the vendor to display the note in the language of the user.\r\nConformance Rule:    Vendors must co-relate french and english notes by assigning the same processNote.number\r\nConformance Rule:   When the adjudicator does not know whether a note is french or english, the language.text must contain a value of \"unknown\".\r\n\r\nCPHA Map:  Message Data Lines 1,2,3  E.20.03, E.21.03, E.22.03  A/N40",
        "max": "20",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.processNote.text",
        "path": "ClaimResponse.processNote.text",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.error",
        "path": "ClaimResponse.error",
        "comment": "Usage Note:   A new code set has been created which contains a subset of the CPHA Response Codes.  This logically separates errors from other types of response codes.   TBD\r\nCPHA Map:  Response Codes E.06.03\r\n\r\nIf the request contains errors then an error element should be provided and no adjudication related sections (item, addItem, or payment) should be present.",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.error.code",
        "path": "ClaimResponse.error.code",
        "mustSupport": true,
        "binding": {
          "strength": "extensible",
          "valueSet": "http://pharmacyeclaims.ca/FHIR/ValueSet/error-code"
        }
      },
      {
        "id": "ClaimResponse.error.code.coding",
        "path": "ClaimResponse.error.code.coding",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.error.code.coding.system",
        "path": "ClaimResponse.error.code.coding.system",
        "min": 1,
        "fixedUri": "http://pharmacyeclaims.ca/FHIR/CodeSystem/error-code",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.error.code.coding.code",
        "path": "ClaimResponse.error.code.coding.code",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.error.code.text",
        "path": "ClaimResponse.error.code.text",
        "mustSupport": true
      }
    ]
  }
}