Digital Child Health Service - Events Catalogue

CareConnect-DCH-Immunization-1

This Immunization Resource describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed. Further constraints have been applied to represent an Immunisation performed during a Child Health event.

NameCard.TypeDescription & Constraints
..ImmunizationDomainResourceImmunization event information

...id0..1IdLogical id of this artifact

...meta0..1MetaMetadata about the resource

...implicitRules0..1UriA set of rules under which this content was created

...language0..1CodeLanguage of the resource content
Binding A human language. (http://tools.ietf.org/html/bcp47)
Binding Strength Required

...text0..1NarrativeText summary of the resource, for human interpretation

...contained0..*ResourceContained, inline Resources

...parentPresent0..1ExtensionWas a parent present at the Immunization
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-CareConnect-ParentPresent-1

...dateRecorded0..1ExtensionThe date that the Vaccination was recorded
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-CareConnect-DateRecorded-1

...identifier1..1IdentifierBusiness identifier

....id0..1Idxml:id (or equivalent in JSON)

....use0..1Codeusual | official | temp | secondary (If known)
Binding Identifies the purpose for this identifier, if known . (http://hl7.org/fhir/ValueSet/identifier-use)
Binding Strength Required

....type0..1CodeableConceptDescription of identifier
Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/ValueSet/identifier-type)
Binding Strength Extensible

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..*CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......system0..1UriIdentity of the terminology system

......version0..1StringVersion of the system - if relevant

......code0..1CodeSymbol in syntax defined by the system

......display0..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

....system1..1UriThe namespace for the identifier
Example Value http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri

....value1..1StringThe value that is unique
Example Value 123456

....period0..1PeriodTime period when id is/was valid for use

.....id0..1Idxml:id (or equivalent in JSON)

.....start0..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

....assigner0..1Reference (CareConnect-DCH-Organization-1)Organization that issued id (may be just text)

.....id0..1Idxml:id (or equivalent in JSON)

.....reference0..1StringRelative, internal or absolute URL reference

.....display0..1StringText alternative for the resource

...status1..1Codein-progress | on-hold | completed | entered-in-error | stopped
Binding A set of codes indicating the current status of an Immunization (http://hl7.org/fhir/ValueSet/medication-admin-status)
Binding Strength Required

...date1..1DateTimeVaccination administration date

...vaccineCode1..1CodeableConceptVaccine product administered
Binding The code for vaccine product administered (http://hl7.org/fhir/ValueSet/vaccine-code)
Binding Strength Example

....id0..1Idxml:id (or equivalent in JSON)

....coding1..1Code defined by a terminology system
Slice: Ordering: Unordered, Discriminator: system, Rules: Open

....coding (SNOMED CT)0..1CodingCode defined by a terminology system

.....id0..1Idxml:id (or equivalent in JSON)

.....snomedCTDescriptionID0..1ExtensionThe SNOMED CT Description ID for the display
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-coding-sctdescid

.....system1..1UriIdentity of the terminology system
Fixed Value http://snomed.info/sct

.....code1..1CodeSymbol in syntax defined by the system

.....display1..1StringRepresentation defined by the system

.....userSelected0..1BooleanIf this coding was chosen directly by the user

....text0..1StringPlain text representation of the concept

...patient1..1Reference (CareConnect-DCH-Patient-1)Who was immunized

....id0..1Idxml:id (or equivalent in JSON)

....reference1..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

...wasNotGiven1..1BooleanFlag for whether immunization was given

...reported1..1BooleanIndicates a self-reported record

...performer0..1Reference (CareConnect-DCH-Practitioner-1)Who administered vaccine

....id0..1Idxml:id (or equivalent in JSON)

....reference0..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

...requester0..1Reference (CareConnect-DCH-Practitioner-1)Who ordered vaccination

....id0..1Idxml:id (or equivalent in JSON)

....reference0..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

...encounter1..1Reference (CareConnect-DCH-Encounter-1)Encounter administered as part of

....id0..1Idxml:id (or equivalent in JSON)

....reference1..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

...manufacturer0..1Reference (CareConnect-DCH-Organization-1)Vaccine manufacturer

....id0..1Idxml:id (or equivalent in JSON)

....reference0..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

...location0..1Reference (CareConnect-DCH-Location-1)Where vaccination occurred

....id0..1Idxml:id (or equivalent in JSON)

....reference0..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

...lotNumber0..1StringVaccine lot number

...expirationDate0..1DateVaccine expiration date

...site0..1CodeableConceptBody site vaccine was administered
Binding The site at which the vaccine was administered (http://hl7.org/fhir/ValueSet/immunization-site)
Binding Strength Example

....id0..1Idxml:id (or equivalent in JSON)

....coding0..*Code defined by a terminology system
Slice: Ordering: Unordered, Discriminator: system, Rules: Open

....coding (SNOMED CT)0..1CodingCode defined by a terminology system

.....id0..1Idxml:id (or equivalent in JSON)

.....snomedCTDescriptionID0..1ExtensionThe SNOMED CT Description ID for the display
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-coding-sctdescid

.....system1..1UriIdentity of the terminology system
Fixed Value http://snomed.info/sct

.....code1..1CodeSymbol in syntax defined by the system

.....display1..1StringRepresentation defined by the system

.....userSelected0..1BooleanIf this coding was chosen directly by the user

....text0..1StringPlain text representation of the concept

...route0..1CodeableConceptHow vaccine entered body
Binding The route by which the vaccine was administered (http://hl7.org/fhir/ValueSet/immunization-route)
Binding Strength Example

....id0..1Idxml:id (or equivalent in JSON)

....coding0..*Code defined by a terminology system
Slice: Ordering: Unordered, Discriminator: system, Rules: Open

....coding (SNOMED CT)0..1CodingCode defined by a terminology system

.....id0..1Idxml:id (or equivalent in JSON)

.....snomedCTDescriptionID0..1ExtensionThe SNOMED CT Description ID for the display
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-coding-sctdescid

.....system1..1UriIdentity of the terminology system
Fixed Value http://snomed.info/sct

.....code1..1CodeSymbol in syntax defined by the system

.....display1..1StringRepresentation defined by the system

.....userSelected0..1BooleanIf this coding was chosen directly by the user

....text0..1StringPlain text representation of the concept

...doseQuantity (SimpleQuantity)0..1SimpleQuantityAmount of vaccine administered

....id0..1Idxml:id (or equivalent in JSON)

....value0..1DecimalNumerical value (with implicit precision)

....unit0..1StringUnit representation

....system0..1UriSystem that defines coded unit form

....code0..1CodeCoded form of the unit

...note0..*AnnotationVaccination notes

....id0..1Idxml:id (or equivalent in JSON)

....author[x]0..1RelatedPerson | String | CareConnect-DCH-Practitioner-1 | CareConnect-DCH-Patient-1Individual responsible for the annotation

....time0..1DateTimeWhen the annotation was made

....text1..1StringThe annotation - text content

...explanation0..1BackboneElementAdministration/non-administration reasons

....id0..1Idxml:id (or equivalent in JSON)

....reason0..*CodeableConceptWhy immunization occurred
Binding The reason why a vaccine was administered (http://hl7.org/fhir/ValueSet/immunization-reason)
Binding Strength Example

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..*CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......system0..1UriIdentity of the terminology system

......version0..1StringVersion of the system - if relevant

......code0..1CodeSymbol in syntax defined by the system

......display0..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

....reasonNotGiven1..1CodeableConceptWhy immunization did not occur
Binding The reason why an immunisation was not administered (https://fhir.nhs.uk/ValueSet/DCH-ReasonNotGiven-1)
Binding Strength Required

.....id0..1Idxml:id (or equivalent in JSON)

.....coding1..1CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......system1..1UriIdentity of the terminology system
Fixed Value https://fhir.nhs.uk/DCH-ReasonNotGiven-1

......version0..1StringVersion of the system - if relevant

......code1..1CodeSymbol in syntax defined by the system

......display1..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

...reaction0..*BackboneElementDetails of a reaction that follows immunization

....id0..1Idxml:id (or equivalent in JSON)

....date0..1DateTimeWhen reaction started

....detail0..1Reference (CareConnect-DCH-Observation-1)Additional information on reaction

.....id0..1Idxml:id (or equivalent in JSON)

.....reference0..1StringRelative, internal or absolute URL reference

.....display0..1StringText alternative for the resource

....reported0..1BooleanIndicates self-reported reaction

...vaccinationProtocol1..*BackboneElementWhat protocol was followed

....id0..1Idxml:id (or equivalent in JSON)

....doseSequence (Immunization Part)1..1PositiveIntDose number within series

....description0..1StringDetails of vaccine protocol

....authority0..1Reference (CareConnect-DCH-Organization-1)Who is responsible for protocol

.....id0..1Idxml:id (or equivalent in JSON)

.....reference0..1StringRelative, internal or absolute URL reference

.....display0..1StringText alternative for the resource

....series0..1StringName of vaccine series

....seriesDoses0..1PositiveIntRecommended number of doses for immunity

....targetDisease1..*CodeableConceptDisease immunized against
Binding The disease target of the vaccination protocol (http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-target)
Binding Strength Example

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..*Code defined by a terminology system
Slice: Ordering: Unordered, Discriminator: system, Rules: Open

.....coding (SNOMED CT)0..1CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......snomedCTDescriptionID0..1ExtensionThe SNOMED CT Description ID for the display
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-coding-sctdescid

......system1..1UriIdentity of the terminology system
Fixed Value http://snomed.info/sct

......code1..1CodeSymbol in syntax defined by the system

......display1..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

....doseStatus1..1CodeableConceptIndicates if dose counts towards immunity
Binding The status of the vaccination protocol (i.e. should this count) (http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status)
Binding Strength Example

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..*CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......system1..1UriIdentity of the terminology system

......version0..1StringVersion of the system - if relevant

......code1..1CodeSymbol in syntax defined by the system

......display1..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

....doseStatusReason0..1CodeableConceptWhy dose does (not) count
Binding The reason for the determining if a vaccination should count or why vaccination should not count. (http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status-reason)
Binding Strength Example

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..*CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......system0..1UriIdentity of the terminology system

......version0..1StringVersion of the system - if relevant

......code0..1CodeSymbol in syntax defined by the system

......display0..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

Name Type Description & Constraints
. . Extension-CareConnect-ParentPresent-1 Extension This Extension resource is constrained to indicate whether a parent was present at the Immunization.
. . Extension-CareConnect-DateRecorded-1 Extension This Extension resource is constrained to support the date that an event was recorded.
. . Extension-coding-sctdescid Extension This Extension resource is constrained to support SNOMED CT Description ID for the display.
. . Extension-coding-sctdescid Extension This Extension resource is constrained to support SNOMED CT Description ID for the display.
. . Extension-coding-sctdescid Extension This Extension resource is constrained to support SNOMED CT Description ID for the display.
. . Extension-coding-sctdescid Extension This Extension resource is constrained to support SNOMED CT Description ID for the display.
Path Name Binding Strength ValueSet
.Immunization.language language Required http://tools.ietf.org/html/bcp47
.Immunization.identifier.use use Required http://hl7.org/fhir/ValueSet/identifier-use
.Immunization.identifier.type type Extensible http://hl7.org/fhir/ValueSet/identifier-type
.Immunization.status status Required http://hl7.org/fhir/ValueSet/medication-admin-status
.Immunization.vaccineCode vaccineCode Example http://hl7.org/fhir/ValueSet/vaccine-code
.Immunization.site site Example http://hl7.org/fhir/ValueSet/immunization-site
.Immunization.route route Example http://hl7.org/fhir/ValueSet/immunization-route
.Immunization.explanation.reason reason Example http://hl7.org/fhir/ValueSet/immunization-reason
.Immunization.explanation.reasonNotGiven reasonNotGiven Required https://fhir.nhs.uk/ValueSet/DCH-ReasonNotGiven-1
.Immunization.vaccinationProtocol.targetDisease targetDisease Example http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-target
.Immunization.vaccinationProtocol.doseStatus doseStatus Example http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status
.Immunization.vaccinationProtocol.doseStatusReason doseStatusReason Example http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status-reason