INTEROPen CareConnect Base STU3 Implementation Guide
3.0.0 - CI Build

INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions

StructureDefinition: CareConnect-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.

The official URL for this profile is: 

https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Immunization-1

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Immunization

Summary

Mandatory: 0 element (15 nested mandatory elements)
Fixed Value: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Immunization.site.coding is sliced based on the value of value:system
  • The element Immunization.route.coding is sliced based on the value of value:system
  • The element Immunization.vaccinationProtocol.targetDisease.coding is sliced based on the value of value:system

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*Immunization
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... Extension-CareConnect-ParentPresent-1 0..1booleanWas a parent present at the Immunization
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1
... Extension-CareConnect-DateRecorded-1 0..1dateTimeThe date that the Vaccination was recorded
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1
... identifier
.... system 1..1uri
.... value 1..1string
.... assigner 0..1Reference(CareConnect-Organization-1)
... status 1..1codecompleted
... vaccineCode 1..1CodeableConceptBinding: Care Connect Vaccine Code (extensible)
... patient 1..1Reference(CareConnect-Patient-1)
... encounter 0..1Reference(CareConnect-Encounter-1)
... primarySource 1..1boolean
... location 0..1Reference(CareConnect-Location-1)
... manufacturer 0..1Reference(CareConnect-Organization-1)
... site
.... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system
..... coding:snomedCT 0..1Coding
...... extension 0..*ExtensionSlice: Unordered, Open by value:url
...... Extension-coding-sctdescid 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system 1..1uriFixed Value: http://snomed.info/sct
...... code 1..1code
...... display 1..1string
... route
.... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system
..... coding:snomedCT 0..1CodingBinding: Care Connect Medication Dosage Route (example)
...... extension 0..*ExtensionSlice: Unordered, Open by value:url
...... Extension-coding-sctdescid 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system 1..1uriFixed Value: http://snomed.info/sct
...... code 1..1code
...... display 1..1string
... practitioner
.... actor 1..1Reference(CareConnect-Practitioner-1)
... note
.... author[x] 0..1
..... authorReferenceReference(RelatedPerson | CareConnect-Practitioner-1 | CareConnect-Patient-1)
..... authorStringstring
... explanation
.... reason 0..*CodeableConceptBinding: Care Connect Immunization Explanation Reason (example)
.... reasonNotGiven 0..*CodeableConceptBinding: Care Connect Reason Immunization Not Administered (extensible)
... reaction
.... detail 0..1Reference(CareConnect-Observation-1)
... vaccinationProtocol
.... doseSequence 1..1positiveInt
.... authority 0..1Reference(CareConnect-Organization-1)
.... targetDisease
..... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system
...... coding:snomedCT 0..1Coding
....... extension 0..*ExtensionSlice: Unordered, Open by value:url
....... Extension-coding-sctdescid 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system 1..1uriFixed Value: http://snomed.info/sct
....... code 1..1code
....... display 1..1string
.... doseStatus
..... coding
...... system 1..1uri
...... code 1..1code
...... display 1..1string

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*ImmunizationImmunization event information
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... Extension-CareConnect-ParentPresent-1 I0..1booleanWas a parent present at the Immunization
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1
... Extension-CareConnect-DateRecorded-1 I0..1dateTimeThe date that the Vaccination was recorded
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1
... Extension-CareConnect-VaccinationProcedure-1 I0..1CodeableConceptAn extension to hold an immunization procedure code
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-VaccinationProcedure-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... status ?!Σ1..1codecompleted
Binding: Immunization Status Codes (required)
... notGiven ?!Σ1..1booleanFlag for whether immunization was given
... vaccineCode 1..1CodeableConceptVaccine product administered
Binding: Care Connect Vaccine Code (extensible)
... patient 1..1Reference(CareConnect-Patient-1)Who was immunized
... encounter 0..1Reference(CareConnect-Encounter-1)Encounter administered as part of
... date 0..1dateTimeVaccination administration date
... primarySource 1..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: Immunization Origin Codes (example)
... location 0..1Reference(CareConnect-Location-1)Where vaccination occurred
... manufacturer 0..1Reference(CareConnect-Organization-1)Vaccine manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: Codes for Immunization Site of Administration (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:snomedCT Σ0..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... Extension-coding-sctdescid 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... route 0..1CodeableConceptHow vaccine entered body
Binding: Immunization Route Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:snomedCT Σ0..1CodingCode defined by a terminology system
Binding: Care Connect Medication Dosage Route (example)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... Extension-coding-sctdescid 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... practitioner ΣI0..*BackboneElementWho performed event
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ0..1CodeableConceptWhat type of performance was done
Binding: Immunization Role Codes (extensible)
.... actor Σ1..1Reference(CareConnect-Practitioner-1)Individual who was performing
... note Σ0..*AnnotationVaccination notes
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(RelatedPerson | CareConnect-Practitioner-1 | CareConnect-Patient-1)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content
... explanation I0..1BackboneElementAdministration/non-administration reasons
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... reason 0..*CodeableConceptWhy immunization occurred
Binding: Care Connect Immunization Explanation Reason (example)
.... reasonNotGiven 0..*CodeableConceptWhy immunization did not occur
Binding: Care Connect Reason Immunization Not Administered (extensible)
... reaction I0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(CareConnect-Observation-1)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... vaccinationProtocol I0..*BackboneElementWhat protocol was followed
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... doseSequence 1..1positiveIntDose number within series
.... description 0..1stringDetails of vaccine protocol
.... authority 0..1Reference(CareConnect-Organization-1)Who is responsible for protocol
.... series 0..1stringName of vaccine series
.... seriesDoses 0..1positiveIntRecommended number of doses for immunity
.... targetDisease 1..*CodeableConceptDisease immunized against
Binding: Vaccination Protocol Dose Target Codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT Σ0..1CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... Extension-coding-sctdescid 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... doseStatus 1..1CodeableConceptIndicates if dose counts towards immunity
Binding: Vaccination Protocol Dose Status codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... doseStatusReason 0..1CodeableConceptWhy dose does (not) count
Binding: Vaccination Protocol Dose Status Reason codes (example)

doco Documentation for this format

This structure is derived from Immunization

Summary

Mandatory: 0 element (15 nested mandatory elements)
Fixed Value: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Immunization.site.coding is sliced based on the value of value:system
  • The element Immunization.route.coding is sliced based on the value of value:system
  • The element Immunization.vaccinationProtocol.targetDisease.coding is sliced based on the value of value:system

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*Immunization
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... Extension-CareConnect-ParentPresent-1 0..1booleanWas a parent present at the Immunization
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1
... Extension-CareConnect-DateRecorded-1 0..1dateTimeThe date that the Vaccination was recorded
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1
... identifier
.... system 1..1uri
.... value 1..1string
.... assigner 0..1Reference(CareConnect-Organization-1)
... status 1..1codecompleted
... vaccineCode 1..1CodeableConceptBinding: Care Connect Vaccine Code (extensible)
... patient 1..1Reference(CareConnect-Patient-1)
... encounter 0..1Reference(CareConnect-Encounter-1)
... primarySource 1..1boolean
... location 0..1Reference(CareConnect-Location-1)
... manufacturer 0..1Reference(CareConnect-Organization-1)
... site
.... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system
..... coding:snomedCT 0..1Coding
...... extension 0..*ExtensionSlice: Unordered, Open by value:url
...... Extension-coding-sctdescid 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system 1..1uriFixed Value: http://snomed.info/sct
...... code 1..1code
...... display 1..1string
... route
.... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system
..... coding:snomedCT 0..1CodingBinding: Care Connect Medication Dosage Route (example)
...... extension 0..*ExtensionSlice: Unordered, Open by value:url
...... Extension-coding-sctdescid 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system 1..1uriFixed Value: http://snomed.info/sct
...... code 1..1code
...... display 1..1string
... practitioner
.... actor 1..1Reference(CareConnect-Practitioner-1)
... note
.... author[x] 0..1
..... authorReferenceReference(RelatedPerson | CareConnect-Practitioner-1 | CareConnect-Patient-1)
..... authorStringstring
... explanation
.... reason 0..*CodeableConceptBinding: Care Connect Immunization Explanation Reason (example)
.... reasonNotGiven 0..*CodeableConceptBinding: Care Connect Reason Immunization Not Administered (extensible)
... reaction
.... detail 0..1Reference(CareConnect-Observation-1)
... vaccinationProtocol
.... doseSequence 1..1positiveInt
.... authority 0..1Reference(CareConnect-Organization-1)
.... targetDisease
..... coding 0..*(Slice Definition)Slice: Unordered, Open by value:system
...... coding:snomedCT 0..1Coding
....... extension 0..*ExtensionSlice: Unordered, Open by value:url
....... Extension-coding-sctdescid 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system 1..1uriFixed Value: http://snomed.info/sct
....... code 1..1code
....... display 1..1string
.... doseStatus
..... coding
...... system 1..1uri
...... code 1..1code
...... display 1..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*ImmunizationImmunization event information
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... Extension-CareConnect-ParentPresent-1 I0..1booleanWas a parent present at the Immunization
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1
... Extension-CareConnect-DateRecorded-1 I0..1dateTimeThe date that the Vaccination was recorded
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1
... Extension-CareConnect-VaccinationProcedure-1 I0..1CodeableConceptAn extension to hold an immunization procedure code
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-VaccinationProcedure-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... status ?!Σ1..1codecompleted
Binding: Immunization Status Codes (required)
... notGiven ?!Σ1..1booleanFlag for whether immunization was given
... vaccineCode 1..1CodeableConceptVaccine product administered
Binding: Care Connect Vaccine Code (extensible)
... patient 1..1Reference(CareConnect-Patient-1)Who was immunized
... encounter 0..1Reference(CareConnect-Encounter-1)Encounter administered as part of
... date 0..1dateTimeVaccination administration date
... primarySource 1..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: Immunization Origin Codes (example)
... location 0..1Reference(CareConnect-Location-1)Where vaccination occurred
... manufacturer 0..1Reference(CareConnect-Organization-1)Vaccine manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: Codes for Immunization Site of Administration (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:snomedCT Σ0..1CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... Extension-coding-sctdescid 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... route 0..1CodeableConceptHow vaccine entered body
Binding: Immunization Route Codes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:snomedCT Σ0..1CodingCode defined by a terminology system
Binding: Care Connect Medication Dosage Route (example)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... Extension-coding-sctdescid 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... practitioner ΣI0..*BackboneElementWho performed event
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... role Σ0..1CodeableConceptWhat type of performance was done
Binding: Immunization Role Codes (extensible)
.... actor Σ1..1Reference(CareConnect-Practitioner-1)Individual who was performing
... note Σ0..*AnnotationVaccination notes
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(RelatedPerson | CareConnect-Practitioner-1 | CareConnect-Patient-1)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text 1..1stringThe annotation - text content
... explanation I0..1BackboneElementAdministration/non-administration reasons
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... reason 0..*CodeableConceptWhy immunization occurred
Binding: Care Connect Immunization Explanation Reason (example)
.... reasonNotGiven 0..*CodeableConceptWhy immunization did not occur
Binding: Care Connect Reason Immunization Not Administered (extensible)
... reaction I0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(CareConnect-Observation-1)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... vaccinationProtocol I0..*BackboneElementWhat protocol was followed
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... doseSequence 1..1positiveIntDose number within series
.... description 0..1stringDetails of vaccine protocol
.... authority 0..1Reference(CareConnect-Organization-1)Who is responsible for protocol
.... series 0..1stringName of vaccine series
.... seriesDoses 0..1positiveIntRecommended number of doses for immunity
.... targetDisease 1..*CodeableConceptDisease immunized against
Binding: Vaccination Protocol Dose Target Codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:snomedCT Σ0..1CodingCode defined by a terminology system
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... Extension-coding-sctdescid 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ1..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... doseStatus 1..1CodeableConceptIndicates if dose counts towards immunity
Binding: Vaccination Protocol Dose Status codes (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... doseStatusReason 0..1CodeableConceptWhy dose does (not) count
Binding: Vaccination Protocol Dose Status Reason codes (example)

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Immunization.languageextensibleCommon Languages
Max Binding: All Languages
Immunization.identifier.userequiredIdentifierUse
Immunization.identifier.typeextensibleIdentifier Type Codes
Immunization.statusrequiredImmunization Status Codes
Immunization.vaccineCodeextensibleCare Connect Vaccine Code
Immunization.reportOriginexampleImmunization Origin Codes
Immunization.siteexampleCodes for Immunization Site of Administration
Immunization.routeexampleImmunization Route Codes
Immunization.route.coding:snomedCTexampleCare Connect Medication Dosage Route
Immunization.practitioner.roleextensibleImmunization Role Codes
Immunization.explanation.reasonexampleCare Connect Immunization Explanation Reason
Immunization.explanation.reasonNotGivenextensibleCare Connect Reason Immunization Not Administered
Immunization.vaccinationProtocol.targetDiseaseexampleVaccination Protocol Dose Target Codes
Immunization.vaccinationProtocol.doseStatusexampleVaccination Protocol Dose Status codes
Immunization.vaccinationProtocol.doseStatusReasonexampleVaccination Protocol Dose Status Reason codes

Constraints

Constraints

IdPathDetailsRequirements
dom-2ImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1ImmunizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4ImmunizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3ImmunizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
imm-2ImmunizationIf immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
: (notGiven = true) or explanation.reasonNotGiven.empty()
imm-1ImmunizationIf immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
: (notGiven = true).not() or (reaction.empty() and explanation.reason.empty())
ele-1Immunization.extension:parentPresentAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Immunization.extension:parentPresentMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.extension:recordedDateAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Immunization.extension:recordedDateMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.extension:vaccinationProcedureAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Immunization.extension:vaccinationProcedureMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.practitionerAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Immunization.explanationAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Immunization.reactionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Immunization.vaccinationProtocolAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())