NHS Digital FHIR Medicines

This guidance is under active development by NHS Digital and content may be added or updated on a regular basis.

NHSDigital-Claim

Profile url FHIR Module Normative Status
https://fhir.nhs.uk/StructureDefinition/NHSDigital-Claim trial-use




replacementOfS I0..1Extension(Identifier)
agentS I0..1Extension(Reference(NHSDigitalPractitionerRole | NHSDigitalPractitioner | NHSDigitalHealthcareService))
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
statusS Σ ?!1..1codeBinding
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
subType0..1CodeableConcept
useΣ1..1codeBindingFixed Value
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
billablePeriodΣ I0..1Period
createdS Σ1..1dateTime
entererI0..1Reference(Practitioner | PractitionerRole)
insurerΣ I0..1Reference(Organization)
referenceΣ I1..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
fundsReserve0..1CodeableConcept
claimI0..1Reference(Claim)
relationship0..1CodeableConcept
reference0..1Identifier
groupIdentifierI1..1Extension(Complex)
referenceΣ I0..0string
typeΣ0..1uriBinding
displayΣ0..1string
groupIdentifierI1..1Extension(Complex)
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
referralI0..1Reference(ServiceRequest)
facilityI0..1Reference(Location)
sequence1..1positiveInt
providerI1..1Reference(Practitioner | PractitionerRole | Organization)
responsible0..1boolean
role0..1CodeableConcept
qualification0..1CodeableConcept
sequence1..1positiveInt
category1..1CodeableConcept
code0..1CodeableConcept
timingDatedate
timingPeriodPeriod
valueBooleanboolean
valueStringstring
valueQuantityQuantity
valueAttachmentAttachment
valueReferenceReference(Resource)
reason0..1CodeableConcept
sequence1..1positiveInt
diagnosisCodeableConceptCodeableConcept
diagnosisReferenceReference(Condition)
type0..*CodeableConcept
onAdmission0..1CodeableConcept
packageCode0..1CodeableConcept
sequence1..1positiveInt
type0..*CodeableConcept
date0..1dateTime
procedureCodeableConceptCodeableConcept
procedureReferenceReference(Procedure)
udiI0..*Reference(Device)
sequenceΣ1..1positiveInt
focalΣ1..1boolean
identifier0..1Identifier
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1stringFixed Value
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
businessArrangement0..1string
preAuthRef0..*string
claimResponseI0..1Reference(ClaimResponse)
date1..1date
type0..1CodeableConceptBinding
locationAddressAddress
locationReferenceReference(Location)
prescriptionStatusS I1..1Extension(Coding)
prescriptionStatusReasonS I0..1Extension(Coding)
sequence1..1positiveIntFixed Value
careTeamSequence0..*positiveInt
diagnosisSequence0..*positiveInt
procedureSequence0..*positiveInt
informationSequence0..*positiveInt
revenue0..1CodeableConcept
category0..1CodeableConcept
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
modifier0..*CodeableConcept
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
servicedDatedate
servicedPeriodPeriod
locationCodeableConceptCodeableConcept
locationAddressAddress
locationReferenceReference(Location)
quantityI0..1SimpleQuantity
unitPrice0..1Money
factor0..1decimal
net0..1Money
udiI0..*Reference(Device)
bodySite0..1CodeableConcept
subSite0..*CodeableConcept
encounterI0..*Reference(Encounter)
medicationRequestS I1..1Extension(Reference(NHSDigitalMedicationRequest))
sequenceIdentifierS I1..1Extension(Identifier)
repeatInformationI0..1Extension(Complex)
sequenceS1..1positiveInt
revenue0..1CodeableConcept
category0..1CodeableConcept
productOrServiceS1..1CodeableConceptBinding
modifierS1..*CodeableConceptBinding
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
quantityS I0..1SimpleQuantity
unitPrice0..1Money
factor0..1decimal
net0..1Money
udiI0..*Reference(Device)
medicationDispenseI0..1Extension(Reference(NHSDigitalMedicationDispense))
repeatInformationI0..1Extension(Complex)
sequenceS1..1positiveInt
revenue0..1CodeableConcept
category0..1CodeableConcept
productOrServiceS1..1CodeableConceptBinding
modifier0..*CodeableConcept
programCode0..*CodeableConcept
runningTotalI0..1Extension(Quantity)
valueΣ0..1decimal
comparatorΣ ?!0..0codeBinding
unitΣ0..1string
systemΣ I0..1uri
codeΣ0..1code
unitPrice0..1Money
factor0..1decimal
net0..1Money
udiI0..*Reference(Device)
total0..1Money

replacementOfS I0..1Extension(Identifier)
agentS I0..1Extension(Reference(NHSDigitalPractitionerRole | NHSDigitalPractitioner | NHSDigitalHealthcareService))
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
statusS Σ ?!1..1codeBinding
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
subType0..1CodeableConcept
useΣ1..1codeBindingFixed Value
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
billablePeriodΣ I0..1Period
createdS Σ1..1dateTime
entererI0..1Reference(Practitioner | PractitionerRole)
insurerΣ I0..1Reference(Organization)
referenceΣ I1..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
fundsReserve0..1CodeableConcept
claimI0..1Reference(Claim)
relationship0..1CodeableConcept
reference0..1Identifier
groupIdentifierI1..1Extension(Complex)
referenceΣ I0..0string
typeΣ0..1uriBinding
displayΣ0..1string
groupIdentifierI1..1Extension(Complex)
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding