FHIR IG Statistics: StructureDefinition/profile-claim-response-proff-services

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "profile-claim-response-proff-services",
  "url": "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-claim-response-proff-services",
  "name": "ClaimResponseProffServices",
  "title": "Claim Response Professional Services",
  "status": "draft",
  "description": "A successfully processed claim response (no errors)",
  "purpose": "Conveys key information in a successfully processed claim response (no errors)",
  "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": "CPHA Mapping:   Response Status - E.05.03 where the following codes apply\r\nA=accepted as transmitted - no adjustments\r\nB=accepted with Rx price adjustment\r\nD=pay cardholder claim accepted (indicated using payee type)"
      },
      {
        "id": "ClaimResponse.id",
        "path": "ClaimResponse.id",
        "min": 1,
        "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",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.identifier:ReferenceNumber.system",
        "path": "ClaimResponse.identifier.system",
        "max": "0",
        "mustSupport": false
      },
      {
        "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",
        "mustSupport": true
      },
      {
        "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",
        "comment": "CPHA Mapping:  None\r\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
        "fixedCode": "active",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.type",
        "path": "ClaimResponse.type",
        "comment": "CPHA Mapping:  None\r\nThis may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.",
        "fixedCodeableConcept": {
          "text": "pharmacy"
        },
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.type.text",
        "path": "ClaimResponse.type.text",
        "min": 1,
        "fixedString": "pharmacy",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.subType",
        "path": "ClaimResponse.subType",
        "comment": "Conformance Rule:   This will be used to convey the \"type\" of Claim/Claim Response in accordance with the Plan Type.  Set value = \"public\" or \"private\" \"patientAssistedCard\" or \"unknown\".\r\nRationale:   This value will be conveyed in downstream claim requests, as part of the Prior Claim Response to assist in proper coordination of benefits.\r\nCPHA Map:  None:  This is a new data element\r\n\r\n\r\nThis may contain the local bill type codes, for example the US UB-04 bill type code or the CMS bill type.",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.use",
        "path": "ClaimResponse.use",
        "fixedCode": "claim",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.patient",
        "path": "ClaimResponse.patient",
        "comment": "Usage Note:   The same resource from the request may be included here\r\nCPHA Mapping:  None\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.",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-patient"
            ],
            "aggregation": [
              "bundled"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.patient.reference",
        "path": "ClaimResponse.patient.reference",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.created",
        "path": "ClaimResponse.created",
        "comment": "CPHA Mapping:   Adjudication Date E.01.03",
        "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",
        "comment": "CPHA Mapping:  IIN ( Issuer Identification Number)    A.01.01\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.insurer.identifier.system",
        "path": "ClaimResponse.insurer.identifier.system",
        "min": 1,
        "fixedUri": "http://pharmacyeclaims.ca/FHIR/CPHA-identifier/IIN",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.insurer.identifier.value",
        "path": "ClaimResponse.insurer.identifier.value",
        "comment": "CPHA Mapping:  IIN ( Issuer Identification Number)    A.01.01\r\n\r\nIf the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.  The value's primary purpose is computational mapping.  As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.)  A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.request",
        "path": "ClaimResponse.request",
        "comment": "Usage Note:   This field is limited to a single identifier.  Adjudicators will include both identifiers from the request message (claim.identifier).   The trace number from the Claim Request.identifier (display, limited to 6N) and the FHIR claim. identifier from the request which is an unlimited identifier.   \r\nUsage Note:  The number assigned, by the provider, to the transaction to which this response applies.   \r\r\nCPHA Mapping: Trace Number B.23.03  (in display)\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": "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\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",
        "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 is limited to 6N in order to support backward compatibility to CPHA  This will be the trace number from the Claim Request.identifier.value  The number assigned, by the provider, to the transaction to which this response applies.   This is limited to 6N, in order to maintain backward compatibility with CPHA.     This is optional as the Trace number can be deprecated once all implementations natively support FHIR.\r\r\nCPHA Mapping: Trace Number B.23.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": "ClaimResponse.outcome",
        "path": "ClaimResponse.outcome",
        "comment": "Usage Note:   This can be set to \"complete\" unless there is an error that prevents the claim from being fully processed.\r\nCPHA Mapping:   Always map to complete; no field level mapping \r\n\r\nThe resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).",
        "fixedCode": "complete",
        "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 or prior claim response.  This must be populated\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 accepted\r\nNote that FHIR strings SHALL NOT exceed 1MB in sizeNote that FHIR strings SHALL NOT exceed 1MB in size",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.preAuthRef",
        "path": "ClaimResponse.preAuthRef",
        "comment": "Usage Rule:    This is an indicator that this is a special authorization.   Each implementer will decide how this is to be used; for example this could be an identifier (GUID) or a URL or text.    If a link is provided, pharmacies may be able to download the information to store on the patient record.  If this is populated, PMS can expect that other special auth fields will be present.\"\r\n\r\nThis value is only present on preauthorization adjudications.",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.preAuthPeriod",
        "path": "ClaimResponse.preAuthPeriod",
        "comment": "Usage:   Used only for Special Auth claims to convey the start and expiry date.   Note:   An expiry date will not be present for \"unlimited\" expiry dates.   Payors who have this special authorization information (if available) should return it in the new fields. This would include things like the ODB limited use expiry date \r\nCPHA Map:  New data element\r\n\r\nA Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.payeeType",
        "path": "ClaimResponse.payeeType",
        "comment": "Usage Rule:  Determines who the adjudicator/insurer will issue payment to.  Set value = \"subscriber\" or \"provider\".  \r\nNote:  The pay subscriber option may be used if the network is down, and when the pharmacy has collected from the patient and is submitting on their behalf.\r\nCPHA Mapping:   Transaction code E,03,03.  \r\nValue of \"provider\" maps to 51=response to a pay provider claim for real-time adjudication\r\nValue of \"subscriber\" maps to 54=response to a pay cardholder claim If value = subscriber, maps to CPHA  \r\n\r\nNot all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.payeeType.coding",
        "path": "ClaimResponse.payeeType.coding",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.payeeType.coding.system",
        "path": "ClaimResponse.payeeType.coding.system",
        "min": 1,
        "fixedUri": "http://terminology.hl7.org/CodeSystem/payeetype",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.payeeType.coding.code",
        "path": "ClaimResponse.payeeType.coding.code",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item",
        "path": "ClaimResponse.item",
        "comment": "Usage Note:  This section includes the adjudication results and when rejected, the response codes to provide details.",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.itemSequence",
        "path": "ClaimResponse.item.itemSequence",
        "comment": "Usage Note:   This is the claim.item.sequence from the request message.   Typically this will be a value of \"1\" but for future this could grow.\r\nCPHA Mapping:  None\r\n\r\n32 bit number; for values larger than this, use decimal",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication",
        "path": "ClaimResponse.item.adjudication",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "category.coding.code"
            }
          ],
          "rules": "open"
        },
        "comment": "Usage Note:   The adjudication details associated with the item being claimed.",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication.category",
        "path": "ClaimResponse.item.adjudication.category",
        "comment": "Usage:   This will indicate the type of adjudication, eg DrugCost, Cost Upcharge, etc.   \r\nCPHA Mapping:   None\r\nFor example codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.",
        "mustSupport": true,
        "binding": {
          "strength": "extensible",
          "valueSet": "http://pharmacyeclaims.ca/FHIR/ValueSet/adjudication-category-codes"
        }
      },
      {
        "id": "ClaimResponse.item.adjudication.category.coding",
        "path": "ClaimResponse.item.adjudication.category.coding",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication.category.coding.system",
        "path": "ClaimResponse.item.adjudication.category.coding.system",
        "fixedUri": "http://pharmacyeclaims.ca/FHIR/CodeSystem/adjudication-category-codes",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication.category.coding.code",
        "path": "ClaimResponse.item.adjudication.category.coding.code",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication.reason",
        "path": "ClaimResponse.item.adjudication.reason",
        "comment": "Usage Note:   Future consideration if desired by implementers.   This would allow the response codes to be directly associated with each cutback/amount paid.    Mapping Note:   Where known, this could map to the Response/error code specific to the adjudicated amount (eg drug cost, upcharge, professional fee, etc)  Mapping at the specific area, versus to the entire claim level would be new to split out error and cutbacks, as they are combined together in CPHA.\r\nCPHA Mapping:   - Optional and TBD- Response Codes E.06.03, where an adjudication system is sophisticated enough to associated the reason for cutback to each specific cost breakdown.   \r\r\n\r\nFor example may indicate that the funds for this benefit type have been exhausted."
      },
      {
        "id": "ClaimResponse.item.adjudication.amount",
        "path": "ClaimResponse.item.adjudication.amount",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication.value",
        "path": "ClaimResponse.item.adjudication.value",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:ProfessionalFee",
        "path": "ClaimResponse.item.adjudication",
        "sliceName": "ProfessionalFee",
        "comment": "Usage:  The amount accepted as a professional charge before any adjustments provided for in the Co-Pay, Deductible and Co-Insurance fields.  This reflects the amount claimed in the request, field Claim.item.detail:ProfessionalFee\r\n\r\nCPHA Map:  E.12.03  Professional Fee Optional D5",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:ProfessionalFee.category",
        "path": "ClaimResponse.item.adjudication.category",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:ProfessionalFee.category.coding",
        "path": "ClaimResponse.item.adjudication.category.coding",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:ProfessionalFee.category.coding.code",
        "path": "ClaimResponse.item.adjudication.category.coding.code",
        "min": 1,
        "fixedCode": "ProfFee",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:ProfessionalFee.amount",
        "path": "ClaimResponse.item.adjudication.amount",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:SpecialServicesFee",
        "path": "ClaimResponse.item.adjudication",
        "sliceName": "SpecialServicesFee",
        "comment": "Usage:  The amount accepted as a special services fee before any adjustments provided for in the Co-Pay, Deductible and Co-Insurance fields\r\nCPHA Map:  E.14.03 Special Services Fee  Optional D5;   0..*",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:SpecialServicesFee.category",
        "path": "ClaimResponse.item.adjudication.category",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:SpecialServicesFee.category.coding",
        "path": "ClaimResponse.item.adjudication.category.coding",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:SpecialServicesFee.category.coding.code",
        "path": "ClaimResponse.item.adjudication.category.coding.code",
        "min": 1,
        "fixedCode": "SSF",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:SpecialServicesFee.amount",
        "path": "ClaimResponse.item.adjudication.amount",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:CoPayToCollect",
        "path": "ClaimResponse.item.adjudication",
        "sliceName": "CoPayToCollect",
        "comment": "Usage:  The co pay amount which the provider collects from the beneficiary for a specific claim.  This refers to \"co pay\" as defined in the carrier's benefit brochure.\r\nCPHA Map:  Copay to Collect  E.15.03  Optional D6",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:CoPayToCollect.category",
        "path": "ClaimResponse.item.adjudication.category",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:CoPayToCollect.category.coding",
        "path": "ClaimResponse.item.adjudication.category.coding",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:CoPayToCollect.category.coding.code",
        "path": "ClaimResponse.item.adjudication.category.coding.code",
        "min": 1,
        "fixedCode": "Copay",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:CoPayToCollect.amount",
        "path": "ClaimResponse.item.adjudication.amount",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:DeductibleToCollect",
        "path": "ClaimResponse.item.adjudication",
        "sliceName": "DeductibleToCollect",
        "comment": "Usage:  The deductible amount which the provider collects from the beneficiary for a specific claim.  This refers to \"deductible\" as defined in the carrier's benefit brochure.\r\nCPHA Map:  Deductible to Collect E.16.03  Optional D6",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:DeductibleToCollect.category",
        "path": "ClaimResponse.item.adjudication.category",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:DeductibleToCollect.category.coding",
        "path": "ClaimResponse.item.adjudication.category.coding",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:DeductibleToCollect.category.coding.code",
        "path": "ClaimResponse.item.adjudication.category.coding.code",
        "min": 1,
        "fixedCode": "E.16.03",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:DeductibleToCollect.amount",
        "path": "ClaimResponse.item.adjudication.amount",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:CoInsuranceToCollect",
        "path": "ClaimResponse.item.adjudication",
        "sliceName": "CoInsuranceToCollect",
        "comment": "Usage:  The co-insurance amount which the provider collects from the beneficiary for a specific claim.  This refers to \"co-insurance\" as defined in the carrier's benefit brochure.\r\nCPHA Map:  Co-Insurance to Collect E.17.03  Optional D6",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:CoInsuranceToCollect.category",
        "path": "ClaimResponse.item.adjudication.category",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:CoInsuranceToCollect.category.coding",
        "path": "ClaimResponse.item.adjudication.category.coding",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:CoInsuranceToCollect.category.coding.code",
        "path": "ClaimResponse.item.adjudication.category.coding.code",
        "min": 1,
        "fixedCode": "Co-Insurance",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:CoInsuranceToCollect.amount",
        "path": "ClaimResponse.item.adjudication.amount",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:ResponseCodes",
        "path": "ClaimResponse.item.adjudication",
        "sliceName": "ResponseCodes",
        "comment": "Usage:  Codes to define responses that identify errors and other reasons that may cause the claim(s) to be altered or rejected. Field length of 10 will accommodate 5 response codes per claim.    The first two numeric digits of the field/version numbers in sections A, B, C and D reflect error codes which indicate missing or invalid information received \r\nin the respective fields. Alphanumeric and alpha combinations provide other response messages.\r\nCPHA Map:  Response Codes E.06.03   A/N10",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:ResponseCodes.category",
        "path": "ClaimResponse.item.adjudication.category",
        "comment": "Usage Note:  Set value = \"ResponseCode\".   Note:  In future, more granular categories may be defined.\r\n\r\nFor example codes indicating: Co-Pay, deductible, eligible, benefit, tax, etc.",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:ResponseCodes.reason",
        "path": "ClaimResponse.item.adjudication.reason",
        "comment": "CPHA Map:  Response Codes E.06.03   A/N10\r\nUsage Note:   Codes to define responses that identify errors and other reasons that may cause the claim(s) to be altered or rejected.   In CPHA, the Field length of 10 will accommodate 5 response codes per claim.   In FHIR, this is a list with a practical maximum of 20 codes.   Note:  error codes may be moved out of the repsonse codes \r\n\r\nFor example may indicate that the funds for this benefit type have been exhausted.",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:ResponseCodes.reason.coding",
        "path": "ClaimResponse.item.adjudication.reason.coding",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:ResponseCodes.reason.coding.system",
        "path": "ClaimResponse.item.adjudication.reason.coding.system",
        "comment": "Usage Note:  Implementers must use a default system value - http://pharmacyeclaims.ca/FHIR/CodeSystem/FHIR-response-codes.   If codes come from another code set, a value from the \"http://pharmacyeclaims.ca/FHIR/ValueSet/code-system-values-for-response-codes\"must be used\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.",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.item.adjudication:ResponseCodes.reason.coding.code",
        "path": "ClaimResponse.item.adjudication.reason.coding.code",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.payment",
        "path": "ClaimResponse.payment",
        "comment": "Usage:  The conveyes (in amount) the total amount payable, by the insurer, to the payee for product, services and taxes for a specific claim. This includes all amounts in the \"ClaimResponse.item.adjudication\" section (eg DrugCostProductValue, CostUpcharge, GenericIncentive.. etc) less any amount paid by the beneficiary \r\nUsage:   There is no size restriction on this dollar amount field",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.payment.type",
        "path": "ClaimResponse.payment.type",
        "comment": "CPHA Mapping:   None.  \r\nUsage:  This amount must be derived.   If the paid amount is less than submitted, value = \"partial\", else \"complete\"\r\n\r\nNot all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.payment.type.coding",
        "path": "ClaimResponse.payment.type.coding",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.payment.type.coding.system",
        "path": "ClaimResponse.payment.type.coding.system",
        "comment": "Usage:  This is a fixed value\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://hl7.org/fhir/ValueSet/ex-paymenttype",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.payment.type.coding.code",
        "path": "ClaimResponse.payment.type.coding.code",
        "comment": "Usage:  Set value = \"partial\" or \"complete\"\r\nNote that FHIR strings SHALL NOT exceed 1MB in size",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.payment.amount",
        "path": "ClaimResponse.payment.amount",
        "comment": "Usage:  The total amount payable, by the insurer, to the provider for product, services and taxes for a specific claim. This includes all amounts in the \"ClaimResponse.item.adjudication\" section (eg DrugCostProductValue, CostUpcharge, GenericIncentive.. etc) less any amount paid by the beneficiary.\r\nUsage:  There is no size restriction on this dollar amount field\r\nCPHA Mapping:  Plan Pays E.19.03 D6",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.payment.amount.value",
        "path": "ClaimResponse.payment.amount.value",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.processNote",
        "path": "ClaimResponse.processNote",
        "comment": "Usage:  Detailed response information.  \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.extension:processNoteDirectedTo",
        "path": "ClaimResponse.processNote.extension",
        "sliceName": "processNoteDirectedTo",
        "comment": "Usage Note:   Allows the adjudicator to direct a note to a particular audiance.  Set value = \"patient\", \"provider\" or \"both\r\nCPHA Map:   This is a new data element; mapping to a value of \"both\" if unknown.\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.",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/ext-ProcessNoteDirectedTo"
            ]
          }
        ],
        "mustSupport": true,
        "isModifier": false
      },
      {
        "id": "ClaimResponse.processNote.number",
        "path": "ClaimResponse.processNote.number",
        "comment": "Usage Note:   When an adjudicator returns the same note in both english and french, this number must be used to co-relate the notes.     Vendors must co-relate french and english notes by assigning the same processNote.number\r\n\r\n32 bit number; for values larger than this, use decimal",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.processNote.type",
        "path": "ClaimResponse.processNote.type",
        "comment": "Usage Notes:   Systems that natively support FHIR must support this\r\nCPHA Mapping:  None\r\n\r\nNote that FHIR strings SHALL NOT exceed 1MB in size",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.processNote.text",
        "path": "ClaimResponse.processNote.text",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.processNote.language",
        "path": "ClaimResponse.processNote.language",
        "comment": "Conformance Rule:   This must be populated with a code of \"en\" for English or \"fr\" for French, OR,  if unknown, do not use a code and instead populate the text value with \"unknown\".    \r\nConformance Rule:  Where possible, both english and french messages shall be included.   If english is returned,  adjudicators must also return french to allow PMS vendors to display in the patient's language\r\nUsage Rule:   .   Patient language should be determined by the Pharmacy.   If french, adjudicators must always return english.   When language is unknown, PMS will always render whatever is returned.  Provider language is determined using the \"user language\" in the pharmacy software and the PMS can display the appropriate language based on the user who is viewing the patient record.   \r\nCPHA Mapping:  None.   New requirement\r\nOnly required if the language is different from the resource language.",
        "min": 1,
        "mustSupport": true,
        "binding": {
          "strength": "extensible",
          "valueSet": "http://hl7.org/fhir/ValueSet/all-languages"
        }
      },
      {
        "id": "ClaimResponse.processNote.language.coding",
        "path": "ClaimResponse.processNote.language.coding",
        "comment": "Usage:   Either system+ code must be present (for en and fr), or text must have a value of \"unknown\".\r\nCodes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.  Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.processNote.language.coding.system",
        "path": "ClaimResponse.processNote.language.coding.system",
        "min": 1,
        "fixedUri": "urn:ietf:bcp:47",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.processNote.language.coding.code",
        "path": "ClaimResponse.processNote.language.coding.code",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.processNote.language.text",
        "path": "ClaimResponse.processNote.language.text",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.error.code.coding",
        "path": "ClaimResponse.error.code.coding",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.error.code.coding.system",
        "path": "ClaimResponse.error.code.coding.system",
        "mustSupport": true
      },
      {
        "id": "ClaimResponse.error.code.coding.code",
        "path": "ClaimResponse.error.code.coding.code",
        "min": 1,
        "mustSupport": true
      }
    ]
  }
}