International Patient Summary Implementation Guide (Release 0.3.0 STU1 Ballot)

This page is part of the International Patient Summary Implementation Guide (v0.3.0: STU 1 (FHIR R4) Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

SD.10 StructureDefinition-Immunization-uv-ips

SD.10.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 EST 2018 as a draft by .

This profile builds on Immunization

Summary

Mandatory: 4 elements (3 nested mandatory elements)
Must-Support: 24 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.vaccineCode is sliced based on the value of value:coding.system
  • The element Immunization.vaccineCode.coding is sliced based on the value of value:system

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization S0..*
... id S0..1id
... meta S0..1Meta
.... profile S0..*canonical(StructureDefinition)Fixed Value: http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips
... status S1..1code
... vaccineCode S(Slice Definition)Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO AC codes; or any other kind of code that that identifies, classifies or cluster the administered product.
Slice: Unordered, Open by value:coding.system
Binding: IPS Vaccines (preferred)
.... (All Slices) Content/Rules for all slices
..... coding S(Slice Definition)Slice: Unordered, Open by value:system
...... atcClass S0..1CodingIPSWHO ATC classification
Binding: WHO ATC (required)
....... system S1..1uriFixed Value: http://www.whocc.no/atc
.... absentOrUnknownImmunization S0..1CodeableConceptIPSAbsent Unknown Immunization
Binding: Absent or Unknown Immunization (required)
..... coding S1..1CodingIPS
...... system S1..1uriFixed Value: http://hl7.org/fhir/uv/ips/CodeSystem/absent-unknown-uv-ips
..... text S0..1string
... patient S1..1Reference(Patient (IPS))
.... reference S1..1string
... occurrence[x] S1..1dateTime, string
.... data-absent-reason S0..1codeoccurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
... recorded S0..1dateTime
... primarySource S0..1boolean
... reportOrigin S0..1CodeableConcept
... site S0..1CodeableConceptIPSBinding: IPS Target Site (preferred)
... route S0..1CodeableConceptIPSBinding: 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 SI0..*Immunization event information
... id SΣ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile SΣ0..*canonical(StructureDefinition)Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... 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 SI(Slice Definition)Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO AC codes; or any other kind of code that that identifies, classifies or cluster the administered product.
Slice: Unordered, Open by value:coding.system
Binding: IPS Vaccines (preferred)
.... (All Slices) Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SI(Slice Definition)A reference to a code defined by a terminology system
Slice: Unordered, Open by value:system
...... atcClass SI0..1CodingIPSWHO ATC classification
Binding: WHO ATC (required)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://www.whocc.no/atc
....... version SΣ0..1stringVersion of the system - if relevant
....... code SΣ0..1codeSymbol in syntax defined by the system
....... display SΣ0..1stringRepresentation defined by the system
........ id 0..1stringxml:id (or equivalent in JSON)
........ extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
........ translation SI0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
........ value 0..1stringPrimitive value for string
Max Length: 1048576
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... absentOrUnknownImmunization SI0..1CodeableConceptIPSAbsent Unknown Immunization
Binding: Absent or Unknown Immunization (required)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SI1..1CodingIPSA reference to a code defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/ips/CodeSystem/absent-unknown-uv-ips
...... version SΣ0..1stringVersion of the system - if relevant
...... code SΣ0..1codeSymbol in syntax defined by the system
...... display SΣ0..1stringRepresentation defined by the system
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... translation SI0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
....... value 0..1stringPrimitive value for string
Max Length: 1048576
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text SΣ0..1stringPlain text representation of the concept
... patient SΣ1..1Reference(Patient (IPS))Who was immunized
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣI1..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] SΣ1..1Vaccine administration date
.... (All Types) Content/Rules for all Types
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... data-absent-reason S0..1codeoccurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... valueCode 0..1codeValue of extension
Binding: DataAbsentReason (required)
.... occurrenceDateTimedateTime
.... occurrenceStringstring
... recorded S0..1dateTimeWhen the immunization was first captured in the subject's record
... primarySource SΣ0..1booleanIndicates context the data was recorded in
... reportOrigin S0..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 SI0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: IPS Target Site (preferred)
... route SI0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Route of Administration (required)
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... performer SΣI0..1BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even 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..1stringUnique id for inter-element referencing
..... 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even 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)
... reaction I0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... protocolApplied I0..*BackboneElementProtocol followed by the provider
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... series 0..1stringName of vaccine series
.... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
.... targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example)
.... doseNumber[x] 1..1Dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format

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