NHS Digital FHIR Implementation Guide (Retired - 2.1.50)

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

NHSDigital-Composition

Profile url
https://fhir.nhs.uk/StructureDefinition/NHSDigital-Composition

This FHIR R4 profile is designed to set a core Composition standard for:

  • Transfer of Care ITK3 and STU3 Digital Meds
  • Summary Care Record
  • GP Connect unstructured record

from UK Core Composition

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..1Identifier
statusΣ ?!1..1codeBinding
typeΣ1..1CodeableConceptBinding
categoryΣ0..*CodeableConcept
subjectΣ I1..1Reference(NHSDigitalPatient)
encounterΣ I0..1Reference(Encounter)
dateΣ1..1dateTime
authorΣ I1..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
titleΣ1..1string
confidentialityΣ0..1codeBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
mode1..1codeBinding
time0..1dateTime
partyI0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)
custodianΣ I0..1Reference(Organization)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
code1..1codeBinding
targetIdentifierIdentifier
targetReferenceReference(Composition)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
codeΣ0..*CodeableConcept
periodΣ I0..1Period
detailΣ I0..*Reference(Resource)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI1..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
entryI0..*Reference(Resource)
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
entryI1..*Reference(NHSDigitalEncounter)
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
entryI0..*Reference(UK Core AllergyIntolerance)
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
entryI0..*Reference(Resource)
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
entryI0..*Reference(Binary)
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uriFixed Value
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..0boolean
textΣ0..0string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI1..1Narrative
mode0..0codeBinding
id0..1string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
emptyReasonI0..0CodeableConceptBinding
sectionI0..0see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..0string
codeΣ1..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..0boolean
textΣ0..0string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI1..1Narrative
mode0..0codeBinding
id0..1string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
emptyReasonI0..0CodeableConceptBinding
sectionI0..0see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..0string
codeΣ1..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
entryI0..*Reference(Resource)
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..0string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..0boolean
textΣ0..0string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI1..1Narrative
mode0..0codeBinding
entryI1..*Reference(NHSDigitalOrganization)
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..0string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
emptyReasonI0..0CodeableConceptBinding
sectionI0..0see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
entryI0..*Reference(Binary)
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
emptyReasonI0..0CodeableConceptBinding
sectionI0..0see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
emptyReasonI0..0CodeableConceptBinding
sectionI0..0see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
entryI0..*Reference(UK Core MedicationStatement)
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
entryI0..*Reference(Binary)
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
entryI0..*Reference(Resource)
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
entryI1..*Reference(NHSDigitalPatient)
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
emptyReasonI0..0CodeableConceptBinding
sectionI0..0see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title1..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
entryI0..*Reference(Resource)
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
entryI0..*Reference(Resource)
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
title0..1stringFixed Value
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1codeFixed Value
displayΣ0..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
entryI0..*Reference(Binary)
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)

Search Parameters

Name Type Description Conformance Path
identifier token Version-independent identifier for the Composition SHALL Composition.identifier

Additional parameters can be on Composition - Search Parameters

Mandatory Search Parameters

None defined

Optional Search Parameters

identifier

SHOULD support searching using the identifier search parameter.

GET [baseUrl]/Composition?identifier={system|}[code]

Example:

GET [baseUrl]/Composition?identifier=FA60BE64-1F34-11EB-A2A8-000C29A364EB

Return all Composition resources for an identifier FA60BE64-1F34-11EB-A2A8-000C29A364EB.

back to top