NHS England FHIR Implementation Guide (deprecated)

Important Announcement regarding this Implementation Guide
  • As of 04/10/2023, this implementation guide has been deprecated and all development on the legacy NHS England FHIR Implementation Guide assets has ceased.
  • Therefore, vendors looking to start new implementations or looking to update existing implementations should use the new NHS England Implementation Guide. Vendors continuing to implement legacy NHS England FHIR Implementation Guide based solutions do so at their own risk and on the understanding that no maintenance or support will be available.

Profiles

SDS-Device

Conformance url
https://fhir.nhs.uk/StructureDefinition/SDS-Device




with Device

managingOrganisationS I1..1Extension(Reference())
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uriFixed Value
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uriFixed Value
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uriFixed Value
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
definitionI0..1Reference(DeviceDefinition)
deviceIdentifierΣ0..1string
issuer0..1uri
jurisdiction0..1uri
carrierAIDCΣ0..1base64Binary
carrierHRFΣ0..1string
entryType0..1codeBinding
statusΣ ?!0..1codeBinding
statusReason0..*CodeableConceptBinding
distinctIdentifier0..1string
manufacturer0..1string
manufactureDate0..1dateTime
expirationDate0..1dateTime
lotNumber0..1string
serialNumber0..1string
name1..1string
type1..1codeBinding
modelNumber0..1string
partNumber0..1string
type0..1CodeableConcept
systemType1..1CodeableConcept
version0..1string
type0..1CodeableConcept
component0..1Identifier
value1..1string
type1..1CodeableConcept
valueQuantityI0..*Quantity
valueCode0..*CodeableConcept
patientI0..1Reference(Patient)
ownerS I1..1Reference(Organization)
contactI0..*ContactPoint
locationI0..1Reference(Location)
url0..1uri
note0..*Annotation
safetyΣ0..*CodeableConcept
parentI0..1Reference(Device)

from Device

managingOrganisationS I1..1Extension(Reference())
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uriFixed Value
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uriFixed Value
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uriFixed Value
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
definitionI0..1Reference(DeviceDefinition)
deviceIdentifierΣ0..1string
issuer0..1uri
jurisdiction0..1uri
carrierAIDCΣ0..1base64Binary
carrierHRFΣ0..1string
entryType0..1codeBinding
statusΣ ?!0..1codeBinding
statusReason0..*CodeableConceptBinding
distinctIdentifier0..1string
manufacturer0..1string
manufactureDate0..1dateTime
expirationDate0..1dateTime
lotNumber0..1string
serialNumber0..1string
name1..1string
type1..1codeBinding
modelNumber0..1string
partNumber0..1string
type0..1CodeableConcept
systemType1..1CodeableConcept
version0..1string
type0..1CodeableConcept
component0..1Identifier
value1..1string
type1..1CodeableConcept
valueQuantityI0..*Quantity
valueCode0..*CodeableConcept
patientI0..1Reference(Patient)
ownerS I1..1Reference(Organization)
contactI0..*ContactPoint
locationI0..1Reference(Location)
url0..1uri
note0..*Annotation
safetyΣ0..*CodeableConcept
parentI0..1Reference(Device)

SDS-Endpoint

Conformance url
https://fhir.nhs.uk/StructureDefinition/SDS-Endpoint


with Endpoint

ExtensionSDSReliabilityConfigurationS I0..1Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uriFixed Value
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uriFixed Value
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uriFixed Value
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uriFixed Value
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uriFixed Value
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
statusS Σ ?!1..1codeBinding
connectionTypeS Σ1..1CodingBinding
nameΣ0..1string
managingOrganizationS Σ I1..1Reference(Organization)
contactI0..*ContactPoint
periodΣ I0..1Period
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
payloadMimeTypeΣ0..*codeBinding
addressS Σ1..1url
header0..*string

from Endpoint

ExtensionSDSReliabilityConfigurationS I0..1Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uriFixed Value
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uriFixed Value
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uriFixed Value
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uriFixed Value
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uriFixed Value
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
statusS Σ ?!1..1codeBinding
connectionTypeS Σ1..1CodingBinding
nameΣ0..1string
managingOrganizationS Σ I1..1Reference(Organization)
contactI0..*ContactPoint
periodΣ I0..1Period
systemΣ1..1uriFixed Value
versionΣ0..1string
codeΣ1..1codeFixed Value
displayΣ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
payloadMimeTypeΣ0..*codeBinding
addressS Σ1..1url
header0..*string

Spine-OperationOutcome

See NHSDigital-OperationOutcome

NHSDigital-CapabilityStatement

Conformance url FHIR Module Maturity Level
https://fhir.nhs.uk/StructureDefinition/NHSDigital-CapabilityStatement Implementation Support draft

Conformance Rules



with CapabilityStatement

PackageS I0..1Extension(Complex)
urlΣ0..1uri
versionΣ0..1string
nameΣ I0..1string
titleΣ0..1string
statusS Σ ?!1..1codeBinding
experimentalΣ0..1boolean
dateΣ1..1dateTime
publisherΣ1..1string
contactΣ0..*ContactDetail
descriptionI0..1markdown
useContextΣ0..*UsageContext
jurisdictionΣ0..*CodeableConceptBinding
purpose0..1markdown
copyright0..1markdown
kindS Σ I1..1codeBinding
instantiatesΣ0..*canonical(CapabilityStatement)
importsΣ0..*canonical(CapabilityStatement)
nameΣ1..1string
versionΣ0..1string
releaseDateΣ0..1dateTime
descriptionΣ1..1string
urlΣ0..1url
custodianΣ I0..1Reference(Organization)
fhirVersionS Σ1..1codeBinding
formatΣ1..*codeBinding
patchFormatΣ0..*codeBinding
implementationGuideS Σ0..*canonical(ImplementationGuide)
modeΣ1..1codeBinding
documentation0..1markdown
oauthUrisS I0..1Extension(Complex)
corsΣ0..1boolean
serviceΣ0..*CodeableConceptBinding
description0..1markdown
searchParameterCombinationI0..*Extension(Complex)
typeΣ1..1codeBinding
profileΣ1..1canonical(StructureDefinition)
supportedProfileΣ0..*canonical(StructureDefinition)
documentation0..1markdown
ExamplesI0..1Extension(Complex)
code1..1codeBinding
documentation0..1markdown
versioning0..1codeBinding
readHistory0..1boolean
updateCreate0..1boolean
conditionalCreate0..1boolean
conditionalRead0..1codeBinding
conditionalUpdate0..1boolean
conditionalDelete0..1codeBinding
referencePolicy0..*codeBinding
searchInclude0..*string
searchRevInclude0..*string
name1..1string
definition0..1canonical(SearchParameter)
type1..1codeBinding
documentation0..1markdown
nameΣ1..1string
definitionΣ1..1canonical(OperationDefinition)
documentation0..1markdown
code1..1codeBinding
documentation0..1markdown
searchParam0..*see (searchParam)
operationΣ0..*see (operation)
compartment0..*canonical(CompartmentDefinition)
protocol1..1CodingBinding
address1..1url
reliableCache0..1unsignedInt
documentation0..1markdown
ExamplesI0..*Extension(Complex)
modeΣ1..1codeBinding
definitionΣ1..1canonical(MessageDefinition)
modeΣ1..1codeBinding
documentation0..1markdown
profileΣ1..1canonical(StructureDefinition)

from CapabilityStatement

PackageS I0..1Extension(Complex)
urlΣ0..1uri
versionΣ0..1string
nameΣ I0..1string
titleΣ0..1string
statusS Σ ?!1..1codeBinding
experimentalΣ0..1boolean
dateΣ1..1dateTime
publisherΣ1..1string
contactΣ0..*ContactDetail
descriptionI0..1markdown
useContextΣ0..*UsageContext
jurisdictionΣ0..*CodeableConceptBinding
purpose0..1markdown
copyright0..1markdown
kindS Σ I1..1codeBinding
instantiatesΣ0..*canonical(CapabilityStatement)
importsΣ0..*canonical(CapabilityStatement)
nameΣ1..1string
versionΣ0..1string
releaseDateΣ0..1dateTime
descriptionΣ1..1string
urlΣ0..1url
custodianΣ I0..1Reference(Organization)
fhirVersionS Σ1..1codeBinding
formatΣ1..*codeBinding
patchFormatΣ0..*codeBinding
implementationGuideS Σ0..*canonical(ImplementationGuide)
modeΣ1..1codeBinding
documentation0..1markdown
oauthUrisS I0..1Extension(Complex)
corsΣ0..1boolean
serviceΣ0..*CodeableConceptBinding
description0..1markdown
searchParameterCombinationI0..*Extension(Complex)
typeΣ1..1codeBinding
profileΣ1..1canonical(StructureDefinition)
supportedProfileΣ0..*canonical(StructureDefinition)
documentation0..1markdown
ExamplesI0..1Extension(Complex)
code1..1codeBinding
documentation0..1markdown
versioning0..1codeBinding
readHistory0..1boolean
updateCreate0..1boolean
conditionalCreate0..1boolean
conditionalRead0..1codeBinding
conditionalUpdate0..1boolean
conditionalDelete0..1codeBinding
referencePolicy0..*codeBinding
searchInclude0..*string
searchRevInclude0..*string
name1..1string
definition0..1canonical(SearchParameter)
type1..1codeBinding
documentation0..1markdown
nameΣ1..1string
definitionΣ1..1canonical(OperationDefinition)
documentation0..1markdown