description: null
package_name: uk.nhsdigital.r4
derivation: constraint
name: NHSDigitalClaim
type: Claim
elements:
  patient:
    constraint:
      patient-reference: {human: An identifier reference or resource reference must be provided, severity: error, expression: (reference.exists() or identifier.exists())}
      patient-nhs: {human: Length of the supplied NHS Number is wrong., severity: error, expression: 'identifier.where(system=''https://fhir.nhs.uk/Id/nhs-number'').exists().not() or (identifier.where(system=''https://fhir.nhs.uk/Id/nhs-number'').exists()  and identifier.where(system=''https://fhir.nhs.uk/Id/nhs-number'').value.matches(''^([0-9]{10})$''))'}
    mustSupport: true
    index: 13
    elements:
      identifier:
        index: 14
        elements:
          system:
            pattern: {type: Uri, value: 'https://fhir.nhs.uk/Id/nhs-number'}
            index: 15
          value: {index: 16}
        required: [value, system]
    required: [identifier]
  insurance:
    mustSupport: true
    index: 45
    elements:
      coverage:
        elements:
          identifier: {index: 46}
        required: [identifier]
  use:
    pattern: {type: Code, value: claim}
    index: 12
  item:
    mustSupport: true
    index: 47
    extensions:
      prescriptionStatus: {url: 'https://fhir.nhs.uk/StructureDefinition/Extension-EPS-TaskBusinessStatus', min: 1, max: 1, type: Extension, mustSupport: true, index: 49}
      prescriptionStatusReason: {url: 'https://fhir.nhs.uk/StructureDefinition/Extension-EPS-TaskBusinessStatusReason', min: 0, max: 1, short: Prescription Status Reason, type: Extension, mustSupport: true, index: 50}
    elements:
      extension:
        index: 48
        slicing:
          rules: open
          discriminator:
          - {path: url, type: value}
          min: 1
          slices:
            prescriptionStatus:
              match: {url: null}
              schema: {type: Extension, mustSupport: true, url: 'https://fhir.nhs.uk/StructureDefinition/Extension-EPS-TaskBusinessStatus', index: 49}
              min: 1
              max: 1
            prescriptionStatusReason:
              match: {url: null}
              schema: {short: Prescription Status Reason, type: Extension, mustSupport: true, url: 'https://fhir.nhs.uk/StructureDefinition/Extension-EPS-TaskBusinessStatusReason', index: 50}
              min: 0
              max: 1
      sequence:
        pattern: {type: PositiveInt, value: 1}
        index: 51
      productOrService:
        index: 52
        elements:
          coding:
            index: 53
            elements:
              system:
                pattern: {type: Uri, value: 'http://snomed.info/sct'}
                index: 54
              code:
                pattern: {type: Code, value: '16076005'}
                index: 55
              display:
                pattern: {type: String, value: Prescription}
                index: 56
            required: [display, system, code]
        required: [coding]
      programCode:
        short: PrescriptionChargeExemption
        mustSupport: true
        index: 57
        elements:
          coding:
            index: 58
            elements:
              system: {index: 59}
              code: {index: 60}
            required: [system, code]
        required: [coding]
        slicing:
          rules: open
          discriminator:
          - {path: coding.system, type: value}
          min: null
          slices:
            exemptionEvidence:
              match:
                coding: {system: 'https://fhir.nhs.uk/CodeSystem/DM-exemption-evidence'}
              schema:
                binding: {strength: extensible, valueSet: 'https://fhir.nhs.uk/ValueSet/DM-vs-exemption-evidence'}
                mustSupport: true
                index: 61
                elements:
                  coding:
                    elements:
                      system:
                        pattern: {type: Uri, value: 'https://fhir.nhs.uk/CodeSystem/DM-exemption-evidence'}
                        index: 62
                      code: {index: 63}
                    required: [system, code]
            prescriptionChargeExemption:
              match:
                coding: {system: 'https://fhir.nhs.uk/CodeSystem/prescription-charge-exemption'}
              schema:
                binding: {strength: required, valueSet: 'https://fhir.nhs.uk/ValueSet/DM-prescription-charge-exemption'}
                mustSupport: true
                _required: true
                index: 64
                elements:
                  coding:
                    elements:
                      system:
                        pattern: {type: Uri, value: 'https://fhir.nhs.uk/CodeSystem/prescription-charge-exemption'}
                        index: 65
                      code: {index: 66}
                    required: [system, code]
      detail:
        mustSupport: true
        index: 67
        extensions:
          medicationRequest: {url: 'https://fhir.nhs.uk/StructureDefinition/Extension-ClaimMedicationRequestReference', min: 1, max: 1, short: MedicationRequest reference, type: Extension, mustSupport: true, index: 69}
          sequenceIdentifier: {url: 'https://fhir.nhs.uk/StructureDefinition/Extension-ClaimSequenceIdentifier', min: 1, max: 1, type: Extension, mustSupport: true, index: 70}
          repeatInformation: {url: 'https://fhir.nhs.uk/StructureDefinition/Extension-EPS-RepeatInformation', min: 0, max: 1, type: Extension, index: 71}
          taskBusinessStatusReason: {url: 'https://fhir.nhs.uk/StructureDefinition/Extension-EPS-TaskBusinessStatusReason', min: 0, max: 1, type: Extension, isModifier: false, index: 72}
        elements:
          extension:
            array: true
            min: 2
            index: 68
            slicing:
              rules: open
              discriminator:
              - {path: url, type: value}
              min: 2
              slices:
                medicationRequest:
                  match: {url: null}
                  schema: {short: MedicationRequest reference, type: Extension, mustSupport: true, url: 'https://fhir.nhs.uk/StructureDefinition/Extension-ClaimMedicationRequestReference', index: 69}
                  min: 1
                  max: 1
                sequenceIdentifier:
                  match: {url: null}
                  schema: {type: Extension, mustSupport: true, url: 'https://fhir.nhs.uk/StructureDefinition/Extension-ClaimSequenceIdentifier', index: 70}
                  min: 1
                  max: 1
                repeatInformation:
                  match: {url: null}
                  schema: {type: Extension, url: 'https://fhir.nhs.uk/StructureDefinition/Extension-EPS-RepeatInformation', index: 71}
                  min: 0
                  max: 1
                taskBusinessStatusReason:
                  match: {url: null}
                  schema: {type: Extension, isModifier: false, url: 'https://fhir.nhs.uk/StructureDefinition/Extension-EPS-TaskBusinessStatusReason', index: 72}
                  min: 0
                  max: 1
          sequence: {mustSupport: true, index: 73}
          productOrService:
            binding: {strength: required, valueSet: 'https://fhir.nhs.uk/ValueSet/NHSDigital-MedicationRequest-Code'}
            mustSupport: true
            index: 74
          modifier:
            binding: {strength: required, valueSet: 'https://fhir.nhs.uk/ValueSet/DM-medicationdispense-type'}
            mustSupport: true
            index: 75
          programCode:
            short: Dispensing Endorsement and Charge Payment
            mustSupport: true
            index: 76
            elements:
              coding:
                mustSupport: true
                index: 77
                elements:
                  system: {index: 78}
                  code: {index: 79}
                required: [system, code]
            required: [coding]
            slicing:
              rules: open
              discriminator:
              - {path: coding.system, type: value}
              min: null
              slices:
                prescriptionCharge:
                  match:
                    coding: {system: 'https://fhir.nhs.uk/CodeSystem/DM-prescription-charge'}
                  schema:
                    binding: {strength: required, valueSet: 'https://fhir.nhs.uk/ValueSet/DM-vs-prescription-charge'}
                    mustSupport: true
                    _required: true
                    index: 80
                    elements:
                      coding:
                        elements:
                          system:
                            pattern: {type: Uri, value: 'https://fhir.nhs.uk/CodeSystem/DM-prescription-charge'}
                            index: 81
                dispensingEndorsement:
                  match:
                    coding: {system: 'https://fhir.nhs.uk/CodeSystem/medicationdispense-endorsement'}
                  schema:
                    binding: {strength: required, valueSet: 'https://fhir.nhs.uk/ValueSet/DM-dispensing-endorsement'}
                    mustSupport: true
                    index: 82
                    elements:
                      coding:
                        elements:
                          system:
                            pattern: {type: Uri, value: 'https://fhir.nhs.uk/CodeSystem/medicationdispense-endorsement'}
                            index: 83
                      text: {short: Additional Information for Dispensing Endorsements, index: 84}
          quantity: {mustSupport: true, index: 85}
          subDetail:
            mustSupport: true
            index: 86
            extensions:
              medicationDispense: {url: 'https://fhir.nhs.uk/StructureDefinition/Extension-ClaimMedicationDispenseReference', min: 0, max: 1, type: Extension, index: 88}
              repeatInformation: {url: 'https://fhir.nhs.uk/StructureDefinition/Extension-EPS-RepeatInformation', min: 0, max: 1, type: Extension, index: 89}
            elements:
              extension:
                index: 87
                slicing:
                  rules: open
                  discriminator:
                  - {path: url, type: value}
                  min: 0
                  slices:
                    medicationDispense:
                      match: {url: null}
                      schema: {type: Extension, url: 'https://fhir.nhs.uk/StructureDefinition/Extension-ClaimMedicationDispenseReference', index: 88}
                      min: 0
                      max: 1
                    repeatInformation:
                      match: {url: null}
                      schema: {type: Extension, url: 'https://fhir.nhs.uk/StructureDefinition/Extension-EPS-RepeatInformation', index: 89}
                      min: 0
                      max: 1
              sequence: {mustSupport: true, index: 90}
              productOrService:
                binding: {strength: extensible, valueSet: 'https://fhir.nhs.uk/ValueSet/NHSDigital-MedicationDispense-Code'}
                mustSupport: true
                index: 91
              quantity:
                mustSupport: true
                index: 92
                extensions:
                  runningTotal: {url: 'https://fhir.nhs.uk/StructureDefinition/Extension-DM-RunningTotal', min: 0, max: 1, type: Extension, index: 94}
                elements:
                  extension:
                    index: 93
                    slicing:
                      rules: open
                      discriminator:
                      - {path: url, type: value}
                      min: 0
                      slices:
                        runningTotal:
                          match: {url: null}
                          schema: {type: Extension, url: 'https://fhir.nhs.uk/StructureDefinition/Extension-DM-RunningTotal', index: 94}
                          min: 0
                          max: 1
            required: [quantity]
        required: [modifier]
    required: [detail, extension]
  type:
    mustSupport: true
    index: 8
    elements:
      coding:
        index: 9
        elements:
          system:
            pattern: {type: Uri, value: 'http://terminology.hl7.org/CodeSystem/claim-type'}
            index: 10
          code:
            pattern: {type: Code, value: pharmacy}
            index: 11
        required: [system, code]
    required: [coding]
  created: {mustSupport: true, index: 17}
  extension:
    index: 0
    slicing:
      rules: open
      discriminator:
      - {path: url, type: value}
      min: 0
      slices:
        replacementOf:
          match: {url: null}
          schema: {short: Used to reference a previous Claim, type: Extension, mustSupport: true, url: 'https://fhir.nhs.uk/StructureDefinition/Extension-replacementOf', index: 1}
          min: 0
          max: 1
        agent:
          match: {url: null}
          schema: {short: Provenance of the resource, type: Extension, mustSupport: true, url: 'https://fhir.nhs.uk/StructureDefinition/Extension-Provenance-agent', index: 2}
          min: 0
          max: 1
        supplyHeaderIdentifier:
          match: {url: null}
          schema: {short: Identifier for the SupplyHeader, type: Extension, mustSupport: true, url: 'https://fhir.nhs.uk/StructureDefinition/Extension-EPS-SupplyHeaderIdentifier', index: 3}
          min: 0
          max: 1
  priority:
    mustSupport: true
    index: 22
    elements:
      coding:
        index: 23
        elements:
          system:
            pattern: {type: Uri, value: 'http://terminology.hl7.org/CodeSystem/processpriority'}
            index: 24
          code:
            pattern: {type: Code, value: normal}
            index: 25
        required: [system, code]
    required: [coding]
  status: {mustSupport: true, index: 7}
  payee:
    mustSupport: true
    index: 37
    elements:
      type:
        elements:
          coding:
            index: 38
            elements:
              system:
                pattern: {type: Uri, value: 'http://terminology.hl7.org/CodeSystem/payeetype'}
                index: 39
              code:
                pattern: {type: Code, value: provider}
                index: 40
              display:
                pattern: {type: String, value: Provider}
                index: 41
            required: [display, system, code]
        required: [coding]
      party:
        type: Reference
        constraint:
          nhsd-claim-party: {human: party - An identifier reference or resource reference must be provided, severity: error, expression: (reference.exists() or (identifier.exists()))}
        refers: ['https://fhir.nhs.uk/StructureDefinition/NHSDigital-Organization']
        index: 42
        elements:
          identifier:
            elements:
              system:
                pattern: {type: Uri, value: 'https://fhir.nhs.uk/Id/ods-organization-code'}
                index: 43
              value: {index: 44}
            required: [value, system]
    required: [party]
  prescription:
    mustSupport: true
    index: 26
    extensions:
      groupIdentifier: {url: 'https://fhir.nhs.uk/StructureDefinition/Extension-DM-GroupIdentifier', min: 1, max: 1, type: Extension, index: 28}
    elements:
      extension:
        index: 27
        slicing:
          rules: open
          discriminator:
          - {path: url, type: value}
          min: 1
          slices:
            groupIdentifier:
              match: {url: null}
              schema: {type: Extension, url: 'https://fhir.nhs.uk/StructureDefinition/Extension-DM-GroupIdentifier', index: 28}
              min: 1
              max: 1
      reference: {index: 29}
      identifier:
        index: 30
        elements:
          system:
            pattern: {type: Uri, value: 'https://fhir.nhs.uk/Id/prescription-order-item-number'}
            index: 31
          value: {index: 32}
        required: [value, system]
    required: [extension]
  identifier:
    mustSupport: true
    index: 4
    elements:
      system: {index: 5}
      value: {index: 6}
    required: [value, system]
  provider:
    type: Reference
    mustSupport: true
    refers: ['https://fhir.nhs.uk/StructureDefinition/NHSDigital-PractitionerRole-SDS']
    index: 18
    elements:
      reference: {index: 19}
      identifier:
        elements:
          system: {index: 20}
          value: {index: 21}
        required: [value, system]
    required: [reference]
  originalPrescription:
    extensions:
      groupIdentifier: {url: 'https://fhir.nhs.uk/StructureDefinition/Extension-DM-GroupIdentifier', min: 1, max: 1, type: Extension, index: 34}
    elements:
      extension:
        index: 33
        slicing:
          rules: open
          discriminator:
          - {path: url, type: value}
          min: 1
          slices:
            groupIdentifier:
              match: {url: null}
              schema: {type: Extension, url: 'https://fhir.nhs.uk/StructureDefinition/Extension-DM-GroupIdentifier', index: 34}
              min: 1
              max: 1
      identifier:
        elements:
          system: {index: 35}
          value: {index: 36}
        required: [value, system]
    required: [extension]
package_version: 2.11.0
extensions:
  replacementOf: {url: 'https://fhir.nhs.uk/StructureDefinition/Extension-replacementOf', min: 0, max: 1, short: Used to reference a previous Claim, type: Extension, mustSupport: true, index: 1}
  agent: {url: 'https://fhir.nhs.uk/StructureDefinition/Extension-Provenance-agent', min: 0, max: 1, short: Provenance of the resource, type: Extension, mustSupport: true, index: 2}
  supplyHeaderIdentifier: {url: 'https://fhir.nhs.uk/StructureDefinition/Extension-EPS-SupplyHeaderIdentifier', min: 0, max: 1, short: Identifier for the SupplyHeader, type: Extension, mustSupport: true, index: 3}
class: profile
kind: resource
url: https://fhir.nhs.uk/StructureDefinition/NHSDigital-Claim
base: http://hl7.org/fhir/StructureDefinition/Claim
version: null
required: [prescription, payee, identifier, item]