International Patient Summary Implementation Guide Implementation Guide: STU2 Ballot

This page is part of the International Patient Summary Implementation Guide (v0.2.0: STU 1 Ballot 2) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

SD.11 StructureDefinition-immunization-uv-ips

This profile represents the constraints applied to the Immunization resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an immunization is represented in the patient summary as an instance of an Immunization resource constrained by this profile.

It 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.

Information about that statement (e.g. who did the assertion, when was done) are optionally provided by the statement-uv-ips extension

Conformance resource variables defined here

SD.11.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/uv/ips/StructureDefinition/immunization-uv-ips

Published on Tue Mar 06 00:00:00 AEST 2018 as a draft by .

This profile builds on Immunization

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 14 elements
Fixed Value: 1 element
Prohibited: 1 element

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.vaccineCode.coding is sliced based on the value of value:binding.valueSet (Open at End)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... statement-uv-ips 0..1base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, Expression, UsageContext, DosageImmunization Statement detail
URL: http://hl7.org/fhir/uv/ips/StructureDefinition/statement-uv-ips
.... extension 0..0
... status S1..1code
... vaccineCode S1..1CodeableConcept
.... coding coding-uv-ipsSlice: Unordered, Open At End by value:binding.valueSet
.... coding S0..*coding-uv-ipsVaccine Type
Binding: IPS Vaccines (preferred)
..... system 0..1uri
..... code 0..1code
..... display 0..1stringType of the Vaccine
.... coding 0..*coding-uv-ipsPharmaceutical Product Identifier, Level 1
Binding: PhPID Active Substance Stratum Level 1 (example)
..... system 0..1uri
..... code 0..1code
..... display 0..1stringName of the Pharmaceutical Product [Substance(s)]
.... coding 0..*coding-uv-ipsPharmaceutical Product Identifier, Level 2
Binding: PhPID Active Substance Stratum Level 2 (example)
..... system 0..1uri
..... code 0..1code
..... display 0..1stringName of the Pharmaceutical Product [Substance(s) + Strength + reference strength]
.... coding 0..*coding-uv-ipsPharmaceutical Product Identifier, Level 3
Binding: PhPID Active Substance Stratum Level 3 (example)
..... system 0..1uri
..... code 0..1code
..... display 0..1stringName of the Pharmaceutical Product [Substance(s) + administrable dose form]
.... coding 0..*coding-uv-ipsPharmaceutical Product Identifier, Level 4
Binding: PhPID Active Substance Stratum Level 4 (example)
..... system 0..1uri
..... code 0..1code
..... display S0..1stringName of the Pharmaceutical Product [Substance(s) + strength + reference strength + administrable dose form]
.... coding S0..*coding-uv-ipsMedicinal Product Identifier
Binding: Medicinal Product (example)
..... system 0..1uri
..... code 0..1code
..... display 0..1stringName of the Medicinal Product
.... coding S0..*coding-uv-ipsPackaged Medicinal Product Identifier
Binding: Packaged Medicinal Product (example)
..... system 0..1uri
..... code 0..1code
..... display S0..1stringName of the Packaged Medicinal Product
.... coding 0..1coding-uv-ipsWHO ATC classification
Binding: WHO ATC (required)
..... system 1..1uriFixed Value: http://www.whocc.no/atc
..... code 1..1code
.... coding S0..1coding-uv-ipsAbsent Unknown Immunization
Binding: Absent or Unknown Immunization (required)
.... text S0..1string
... patient S1..1Reference(Patient)
.... reference S0..1string
... route 0..1CodeableConcept
.... coding 0..*coding-uv-ipsBinding: Medicine Route of Administration (required)
... performer S0..1BackboneElement
.... actor S1..1Reference(Practitioner | PractitionerRole | Organization)
..... reference S0..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*Immunization 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 (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... statement-uv-ips 0..1base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, Expression, UsageContext, DosageImmunization Statement detail
URL: http://hl7.org/fhir/uv/ips/StructureDefinition/statement-uv-ips
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1identifies the meaning of the extension
.... value[x] 0..1base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, Expression, UsageContext, DosageValue of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... statusReason 0..1CodeableConceptReason not done
Binding: ImmunizationStatusReasonCodes (example)
... vaccineCode SΣ1..1CodeableConceptVaccine product administered
Binding: VaccineAdministeredValueSet (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σcoding-uv-ipsCode defined by a terminology system
Slice: Unordered, Open At End by value:binding.valueSet
.... coding SI0..*coding-uv-ipsVaccine Type
Binding: IPS Vaccines (preferred)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringType of the Vaccine
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive value for string
Max Length: 1048576
.... coding I0..*coding-uv-ipsPharmaceutical Product Identifier, Level 1
Binding: PhPID Active Substance Stratum Level 1 (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringName of the Pharmaceutical Product [Substance(s)]
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive value for string
Max Length: 1048576
.... coding I0..*coding-uv-ipsPharmaceutical Product Identifier, Level 2
Binding: PhPID Active Substance Stratum Level 2 (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringName of the Pharmaceutical Product [Substance(s) + Strength + reference strength]
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive value for string
Max Length: 1048576
.... coding I0..*coding-uv-ipsPharmaceutical Product Identifier, Level 3
Binding: PhPID Active Substance Stratum Level 3 (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringName of the Pharmaceutical Product [Substance(s) + administrable dose form]
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive value for string
Max Length: 1048576
.... coding I0..*coding-uv-ipsPharmaceutical Product Identifier, Level 4
Binding: PhPID Active Substance Stratum Level 4 (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display SΣ0..1stringName of the Pharmaceutical Product [Substance(s) + strength + reference strength + administrable dose form]
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive value for string
Max Length: 1048576
.... coding SI0..*coding-uv-ipsMedicinal Product Identifier
Binding: Medicinal Product (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringName of the Medicinal Product
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive value for string
Max Length: 1048576
.... coding SI0..*coding-uv-ipsPackaged Medicinal Product Identifier
Binding: Packaged Medicinal Product (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display SΣ0..1stringName of the Packaged Medicinal Product
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive value for string
Max Length: 1048576
.... coding I0..1coding-uv-ipsWHO ATC classification
Binding: WHO ATC (required)
..... 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
Fixed Value: http://www.whocc.no/atc
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive value for string
Max Length: 1048576
.... coding SI0..1coding-uv-ipsAbsent Unknown Immunization
Binding: Absent or Unknown Immunization (required)
.... text SΣ0..1stringPlain text representation of the concept
... patient SΣ1..1Reference(Patient)Who was immunized
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... encounter 0..1Reference(Encounter)Encounter immunization was part of
... occurrence[x] Σ1..1dateTime, stringVaccine administration date
... recorded 0..1dateTimeWhen the immunization was first captured in the subject's record
... primarySource Σ0..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example)
... location 0..1Reference(Location)Where immunization occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding I0..*coding-uv-ipsCode defined by a terminology system
Binding: IPS Target Site (preferred)
.... text Σ0..1stringPlain text representation of the concept
... route 0..1CodeableConceptHow vaccine entered body
Binding: ImmunizationRouteCodes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding I0..*coding-uv-ipsCode defined by a terminology system
Binding: Medicine Route of Administration (required)
.... text Σ0..1stringPlain text representation of the concept
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... performer SΣI0..1BackboneElementWho performed event
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... function Σ0..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible)
.... actor SΣ1..1Reference(Practitioner | PractitionerRole | Organization)Individual or organization who was performing
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference SΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... note Σ0..*AnnotationAdditional immunization notes
... reasonCode 0..*CodeableConceptWhy immunization occurred
Binding: ImmunizationReasonCodes (example)
... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!Σ0..1booleanDose potency
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example)
... education I0..*BackboneElementEducational material presented to patient
imm-1: One of documentType or reference SHALL be present
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example)
... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example)
... protocolApplied I0..*BackboneElementProtocol followed by the provider
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... series 0..1stringName of vaccine series
.... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
.... targetDisease 1..1CodeableConceptVaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example)
.... doseNumber[x] 1..1positiveInt, stringDose number within series

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron