1.0.0 - release

CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ImmunizationSe

Official URL: https://fhir.cambio.se/StructureDefinition/ImmunizationSe Version: 1.2.0
Active as of 2025-10-27 Computable Name: ImmunizationSe

Introduction

The ImmunizationSe profile is used to retrieve data about performed patient vaccinations in COSMIC. The profile is based on the FHIR resource Immunization.

Intended Use

The intended users of this API are patient apps and healthcare professionals.

Specific Rules and Limitations

Type Description
Limitation The API only returns performed vaccinations.
Rule The consumer of the API is responsible for making sure data retrieved is filtered in compliance with laws and regulations prior to presenting it to any end-users.
Rule For reading appointments, the external system needs to be able to evaluate PDL. This means whether the information can be displayed for a healthcare professional with a specific assignment. PDL data needed (HSA care unit and HSA care provider) is retrieved by including the organization referenced from DiagnosticReport.performer.OrganizationSEVendorLite.
Limitation In Read APIs, the body site is read from the prescription and not from the administered occasion. There can be different body sites in Prescription and Occasion if a different body site is chosen than the one mentioned in the Doctor's prescription when the vaccine is administered.
Limitation The route is presented in the CodeableConcept.text instead of using a code since routes are not transformed in to a proper code system

Extensions

Extension Data type Description
SiteQualifier CodableConcept More precise administration site. To be used only when combined with site.coding.

Versions

COS version Profile version Required COSMIC version Date Description
3.11.0 1.0.0 3.9.0 Nov 2023 Initial version, Support for GET and search
4.10.0 1.1.0 4.0.0 April 2025 Introduced site and encounter attributes.
4.12.0 1.2.0 xxx June 2025 Introduced extension SiteQualifier.

APIs & Supported Operations

HTTP Method Description
GET Retrieve all performed vaccinations for patient using patient ID.

Search Parameters

Parameter Format Comment
patient string ID or identifier for patient
_profile string Optional query parameter. Canonical url for the profile (https://fhir.cambio.se/StructureDefinition/ImmunizationSe)
_include string Can be Immunization:patient, Immunization:location, Immunization:performer.actor or all three

Supported Queries

  1. GET [baseURL]/Immunization?patient={id}`
  2. GET [baseURL]/Immunization?patient.identifier={identifierSystemURI identifierValue}`
  3. GET [baseURL]/Immunization?patient.identifier={identifierSystemURI identifierValue}`&_include=Immunization:location
  4. GET [baseURL]/Immunization?patient.identifier={identifierSystemURI identifierValue}&_include=Immunization:performer.actor

Error Codes

Code Description Comment
400 Invalid payloads  

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:SiteQualifier 0..1 CodeableConcept Extension
URL: https://fhir.cambio.se/StructureDefinition/SiteQualifier
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... statusReason 0..1 CodeableConcept Reason for current status.
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips (required): The ATC code for vaccine product administered.
... patient Σ 1..1 Reference(Patient) Who was immunized
... occurrence[x] Σ 1..1 dateTime Vaccine administration date
... primarySource Σ 0..1 boolean Will always be true. Indicates context the data was recorded in
Fixed Value: true

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From the FHIR Standard
Immunization.statusReasonexampleImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason
From the FHIR Standard
Immunization.vaccineCoderequiredhttp://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips
http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:SiteQualifier 0..1 CodeableConcept Extension
URL: https://fhir.cambio.se/StructureDefinition/SiteQualifier
... statusReason 0..1 CodeableConcept Reason for current status.
... vaccineCode 1..1 CodeableConcept Vaccine product administered
Binding: http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips (required): The ATC code for vaccine product administered.
... primarySource 0..1 boolean Will always be true. Indicates context the data was recorded in
Fixed Value: true
... reportOrigin 0..0
... manufacturer 0..0
... expirationDate 0..0
... route
.... coding 0..0
... performer
.... function 0..0
.... actor 1..1 Reference(Practitioner) Individual or organization who was performing
... note 0..0
... reasonCode 0..0
... reasonReference 0..0
... isSubpotent 0..0
... subpotentReason 0..0
... education 0..0
... programEligibility 0..0
... fundingSource 0..0
... reaction 0..0
... protocolApplied
.... series 0..0
.... authority 0..0
.... targetDisease 0..0
.... doseNumber[x] 1..1 positiveInt Dose number within series
.... seriesDoses[x] 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.vaccineCoderequiredhttp://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips
http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:SiteQualifier 0..1 CodeableConcept Extension
URL: https://fhir.cambio.se/StructureDefinition/SiteQualifier
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!Σ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
... statusReason 0..1 CodeableConcept Reason for current status.
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips (required): The ATC code for vaccine product administered.
... patient Σ 1..1 Reference(Patient) Who was immunized
... encounter 0..1 Reference(Encounter) Encounter immunization was part of
... occurrence[x] Σ 1..1 dateTime Vaccine administration date
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource Σ 0..1 boolean Will always be true. Indicates context the data was recorded in
Fixed Value: true
... location 0..1 Reference(Location) Where immunization occurred
... lotNumber 0..1 string Vaccine lot number
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... text Σ 0..1 string Plain text representation of the concept
... doseQuantity 0..1 SimpleQuantity Amount of vaccine administered
... performer Σ 0..* BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 1..1 Reference(Practitioner) Individual or organization who was performing
... protocolApplied 0..* BackboneElement Protocol followed by the provider
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... doseNumber[x] 1..1 positiveInt Dose number within series

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From the FHIR Standard
Immunization.statusReasonexampleImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason
From the FHIR Standard
Immunization.vaccineCoderequiredhttp://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips
http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
http://hl7.org/fhir/ValueSet/immunization-site
From the FHIR Standard
Immunization.routeexampleImmunizationRouteCodes
http://hl7.org/fhir/ValueSet/immunization-route
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Immunization

Summary

Fixed: 1 element
Prohibited: 18 elements

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:SiteQualifier 0..1 CodeableConcept Extension
URL: https://fhir.cambio.se/StructureDefinition/SiteQualifier
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... statusReason 0..1 CodeableConcept Reason for current status.
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips (required): The ATC code for vaccine product administered.
... patient Σ 1..1 Reference(Patient) Who was immunized
... occurrence[x] Σ 1..1 dateTime Vaccine administration date
... primarySource Σ 0..1 boolean Will always be true. Indicates context the data was recorded in
Fixed Value: true

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From the FHIR Standard
Immunization.statusReasonexampleImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason
From the FHIR Standard
Immunization.vaccineCoderequiredhttp://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips
http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:SiteQualifier 0..1 CodeableConcept Extension
URL: https://fhir.cambio.se/StructureDefinition/SiteQualifier
... statusReason 0..1 CodeableConcept Reason for current status.
... vaccineCode 1..1 CodeableConcept Vaccine product administered
Binding: http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips (required): The ATC code for vaccine product administered.
... primarySource 0..1 boolean Will always be true. Indicates context the data was recorded in
Fixed Value: true
... reportOrigin 0..0
... manufacturer 0..0
... expirationDate 0..0
... route
.... coding 0..0
... performer
.... function 0..0
.... actor 1..1 Reference(Practitioner) Individual or organization who was performing
... note 0..0
... reasonCode 0..0
... reasonReference 0..0
... isSubpotent 0..0
... subpotentReason 0..0
... education 0..0
... programEligibility 0..0
... fundingSource 0..0
... reaction 0..0
... protocolApplied
.... series 0..0
.... authority 0..0
.... targetDisease 0..0
.... doseNumber[x] 1..1 positiveInt Dose number within series
.... seriesDoses[x] 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.vaccineCoderequiredhttp://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips
http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:SiteQualifier 0..1 CodeableConcept Extension
URL: https://fhir.cambio.se/StructureDefinition/SiteQualifier
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!Σ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
... statusReason 0..1 CodeableConcept Reason for current status.
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips (required): The ATC code for vaccine product administered.
... patient Σ 1..1 Reference(Patient) Who was immunized
... encounter 0..1 Reference(Encounter) Encounter immunization was part of
... occurrence[x] Σ 1..1 dateTime Vaccine administration date
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource Σ 0..1 boolean Will always be true. Indicates context the data was recorded in
Fixed Value: true
... location 0..1 Reference(Location) Where immunization occurred
... lotNumber 0..1 string Vaccine lot number
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... text Σ 0..1 string Plain text representation of the concept
... doseQuantity 0..1 SimpleQuantity Amount of vaccine administered
... performer Σ 0..* BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 1..1 Reference(Practitioner) Individual or organization who was performing
... protocolApplied 0..* BackboneElement Protocol followed by the provider
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... doseNumber[x] 1..1 positiveInt Dose number within series

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From the FHIR Standard
Immunization.statusReasonexampleImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason
From the FHIR Standard
Immunization.vaccineCoderequiredhttp://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips
http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
http://hl7.org/fhir/ValueSet/immunization-site
From the FHIR Standard
Immunization.routeexampleImmunizationRouteCodes
http://hl7.org/fhir/ValueSet/immunization-route
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Immunization

Summary

Fixed: 1 element
Prohibited: 18 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron