UK Core Implementation Guide 1.0.0 - STU1

StructureDefinition-UKCore-Immunization

This UK Core profile is a restraint on the International FHIR resource Immunization, and defines the constraints, extensions, and minimal set of data to query and retrieve an individual’s immunisation information.

Profile Purpose

This profile is intended to cover the recording of current and historical administration of vaccines to individuals across all healthcare disciplines in all care settings and all regions. This profile does not support the administration of non-vaccine agents, even those that may have or claim to have immunological effects. While the terms "immunisation" and "vaccination" are not clinically identical, for the purposes of the FHIR profile, the terms are used synonymously.

Snapshot View

parentPresentI0..1Extension(boolean)
vaccinationProcedureI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
statusReason0..1CodeableConceptBinding
vaccineCodeΣ1..1CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
occurrenceDateTimedateTime
occurrenceStringstring
recorded0..1dateTime
primarySourceΣ0..1boolean
reportOrigin0..1CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
lotNumber0..1string
expirationDate0..1date
site0..1CodeableConceptBinding
route0..1CodeableConceptBinding
doseQuantityI0..1SimpleQuantity
functionΣ0..1CodeableConceptBinding
actorΣ I1..1Reference(UK Core Practitioner | UK Core PractitionerRole | UK Core Organization)
authorStringstring
authorReferenceReference(UK Core Practitioner | UK Core Patient | RelatedPerson | UK Core Organization)
timeΣ0..1dateTime
textΣ1..1markdown
reasonCode0..*CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
isSubpotentΣ ?!0..1boolean
subpotentReason0..*CodeableConcept
documentType0..1string
reference0..1uri
publicationDate0..1dateTime
presentationDate0..1dateTime
programEligibility0..*CodeableConcept
fundingSource0..1CodeableConcept
date0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
reported0..1boolean
series0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
targetDisease0..*CodeableConcept
doseNumberPositiveIntpositiveInt
doseNumberStringstring
seriesDosesPositiveIntpositiveInt
seriesDosesStringstring

Differential View

parentPresentI0..1Extension(boolean)
vaccinationProcedureI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
statusReason0..1CodeableConceptBinding
vaccineCodeΣ1..1CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
occurrenceDateTimedateTime
occurrenceStringstring
recorded0..1dateTime
primarySourceΣ0..1boolean
reportOrigin0..1CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
lotNumber0..1string
expirationDate0..1date
site0..1CodeableConceptBinding
route0..1CodeableConceptBinding
doseQuantityI0..1SimpleQuantity
functionΣ0..1CodeableConceptBinding
actorΣ I1..1Reference(UK Core Practitioner | UK Core PractitionerRole | UK Core Organization)
authorStringstring
authorReferenceReference(UK Core Practitioner | UK Core Patient | RelatedPerson | UK Core Organization)
timeΣ0..1dateTime
textΣ1..1markdown
reasonCode0..*CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
isSubpotentΣ ?!0..1boolean
subpotentReason0..*CodeableConcept
documentType0..1string
reference0..1uri
publicationDate0..1dateTime
presentationDate0..1dateTime
programEligibility0..*CodeableConcept
fundingSource0..1CodeableConcept
date0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
reported0..1boolean
series0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
targetDisease0..*CodeableConcept
doseNumberPositiveIntpositiveInt
doseNumberStringstring
seriesDosesPositiveIntpositiveInt
seriesDosesStringstring

Hybrid View

parentPresentI0..1Extension(boolean)
vaccinationProcedureI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
statusReason0..1CodeableConceptBinding
vaccineCodeΣ1..1CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
occurrenceDateTimedateTime
occurrenceStringstring
recorded0..1dateTime
primarySourceΣ0..1boolean
reportOrigin0..1CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
lotNumber0..1string
expirationDate0..1date
site0..1CodeableConceptBinding
route0..1CodeableConceptBinding
doseQuantityI0..1SimpleQuantity
functionΣ0..1CodeableConceptBinding
actorΣ I1..1Reference(UK Core Practitioner | UK Core PractitionerRole | UK Core Organization)
authorStringstring
authorReferenceReference(UK Core Practitioner | UK Core Patient | RelatedPerson | UK Core Organization)
timeΣ0..1dateTime
textΣ1..1markdown
reasonCode0..*CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
isSubpotentΣ ?!0..1boolean
subpotentReason0..*CodeableConcept
documentType0..1string
reference0..1uri
publicationDate0..1dateTime
presentationDate0..1dateTime
programEligibility0..*CodeableConcept
fundingSource0..1CodeableConcept
date0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
reported0..1boolean
series0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period