Trillium II Implementation Guide Implementation Guide CI Build

Publish Box goes here

SD.4 StructureDefinition-Immunization-uv-ips

SD.4.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.eu/fhir/trillium2/StructureDefinition/Immunization-uv-ips

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

This profile builds on Immunization

Summary

Mandatory: 4 elements (3 nested mandatory elements)
Must-Support: 24 elements
Fixed Value: 2 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..*uri
... language S0..1code
... text S0..1Narrative
... status S1..1code
... vaccineCode SCodeableConceptIPSVaccine 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)
.... coding SCodingIPSSlice: Unordered, Open by value:system
.... coding S0..1CodingIPSWHO ATC classification
Binding: WHO ATC (required)
..... system S1..1uriFixed Value: http://www.whocc.no/atc
... vaccineCode 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 (Trillium II))
.... reference S1..1string
... date S1..1dateTime
.... data-absent-reason S0..1codedate absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
... route S0..1CodeableConcept
.... coding 0..*CodingIPSBinding: Medicine Route of Administration (required)
... practitioner S0..1BackboneElement
.... actor S1..1Reference(Practitioner)
..... reference S0..1string
... vaccinationProtocol S0..*BackboneElement
.... vaccinationValidity-immunization-uv-trillium2 S0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaValidity of Vaccination in years, months, days OR expressed as a period of time
URL: http://hl7.eu/fhir/trillium2/StructureDefinition/vaccinationValidity-immunization-uv-trillium2

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..1stringxml:id (or equivalent in JSON)
.... 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
.... profile SΣ0..*uriProfiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: Common Tags (example)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language S0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text SI0..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
Binding: Immunization Status Codes (required)
... notGiven ?!Σ1..1booleanFlag for whether immunization was given
... vaccineCode SICodeableConceptIPSVaccine 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)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣCodingIPSCode defined by a terminology system
Slice: Unordered, Open by value:system
.... coding SΣ0..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 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation SI0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive 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
... vaccineCode 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 SΣ1..1CodingIPSCode 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 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation SI0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive 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 S1..1Reference(Patient (Trillium II))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ΣI1..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... encounter 0..1Reference(Encounter)Encounter administered as part of
... date S1..1dateTimeVaccination administration date
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... data-absent-reason SI0..1codedate absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... value 0..1Primitive value for dateTime
... 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(Location)Where vaccination 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: 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 SI0..*CodingIPSA reference to a code defined by a terminology system
Binding: IPS Target Site (preferred)
.... text Σ0..1stringPlain text representation of the concept
... route S0..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 SI0..*CodingIPSA reference to a code 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
... practitioner 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
.... role Σ0..1CodeableConceptWhat type of performance was done
Binding: Immunization Role Codes (extensible)
.... actor SΣ1..1Reference(Practitioner)Individual 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
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
... note Σ0..*AnnotationVaccination notes
... 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: Immunization Reason Codes (example)
.... reasonNotGiven 0..*CodeableConceptWhy immunization did not occur
Binding: Immunization Reasons for Not Immunizing Codes (example)
... 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(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... vaccinationProtocol SI0..*BackboneElementWhat protocol was followed
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... vaccinationValidity-immunization-uv-trillium2 S0..1base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaValidity of Vaccination in years, months, days OR expressed as a period of time
URL: http://hl7.eu/fhir/trillium2/StructureDefinition/vaccinationValidity-immunization-uv-trillium2
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... doseSequence 0..1positiveIntDose number within series
.... description 0..1stringDetails of vaccine protocol
.... authority 0..1Reference(Organization)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 SI0..*CodingIPSA reference to a code defined by a terminology system
..... 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 SI0..*CodingIPSA reference to a code defined by a terminology system
..... 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

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