JohnMoehrke PHR FHIR API
0.5.2 - ci-build United States of America flag

JohnMoehrke PHR FHIR API, published by John Moehrke (himself). This guide is not an authorized publication; it is the continuous build for version 0.5.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/JohnMoehrke/phr/ and changes regularly. See the Directory of published versions

Resource Profile: VA MHV PHR Immunization

Official URL: http://johnmoehrke.github.io/phr/StructureDefinition/JFM.PHR.immunization Version: 0.5.2
Standards status: Trial-use Maturity Level: 4 Computable Name: JFMimmunization

A profile on the Immunization that declares how MHV will expose PHR immunization.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* USCoreImmunizationProfile Immunization event information
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
us-core-5: SHOULD have a translation to the NDC value set
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier S 1..* Identifier Business identifier
Slice: Unordered, Open by value:use
ele-1: All FHIR elements must have a @value or children
.... identifier:TOid 1..1 Identifier Business identifier
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Required Pattern: usual
..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
ele-1: All FHIR elements must have a @value or children
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `ImmunizationTO` | `.` | {ImmunizationTO.id}
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... status ?!SΣ 1..1 code May indicate entered-in-error
Binding: ImmunizationStatusCodes (required)
ele-1: All FHIR elements must have a @value or children
... vaccineCode SΣC 1..1 CodeableConcept Vaccine Product Type (bind to CVX)
Binding: CVX Vaccines Administered Vaccine Set . (extensible)
ele-1: All FHIR elements must have a @value or children
.... text Σ 1..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... patient SΣ 1..1 Reference(US Core Patient Profile) Who was immunized
ele-1: All FHIR elements must have a @value or children
... occurrence[x] SΣ 1..1 dateTime Vaccine administration date
ele-1: All FHIR elements must have a @value or children
... recorded S 0..1 dateTime When the immunization was first captured in the subject's record
ele-1: All FHIR elements must have a @value or children
... primarySource SΣ 1..1 boolean Indicates context the data was recorded in
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:dar 1..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] 1..1 code Value of extension
Binding: DataAbsentReason (required)
ele-1: All FHIR elements must have a @value or children
Required Pattern: unknown
... location S 0..1 Reference(VA MHV PHR Location | Location) {c} Where immunization occurred
ele-1: All FHIR elements must have a @value or children
... Slices for performer SΣ 0..* BackboneElement Who performed event
Slice: Unordered, Closed by value:function
ele-1: All FHIR elements must have a @value or children
.... performer:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... function SΣ 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


ele-1: All FHIR elements must have a @value or children
..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) {c} Individual or organization who was performing
ele-1: All FHIR elements must have a @value or children
.... performer:AP Σ 0..* BackboneElement Who performed event
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... function SΣ 1..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AP
..... actor Σ 1..1 Reference(VA MHV PHR Practitioner | Practitioner) {c} Individual or organization who was performing
ele-1: All FHIR elements must have a @value or children
.... performer:@default Σ 0..* BackboneElement Who performed event
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... actor Σ 1..1 Reference(VA MHV PHR Organization | Organization) {c} Individual or organization who was performing
ele-1: All FHIR elements must have a @value or children
... note SΣ 0..1 Annotation Additional immunization notes
ele-1: All FHIR elements must have a @value or children
.... text Σ 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children
... reaction 0..* BackboneElement Details of a reaction that follows immunization
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... detail 0..1 Reference(Observation) Additional information on reaction
ele-1: All FHIR elements must have a @value or children
..... display SΣ 0..1 string Text alternative for the resource
ele-1: All FHIR elements must have a @value or children
... protocolApplied S 0..* BackboneElement Protocol followed by the provider
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... series S 0..1 string Name of vaccine series
ele-1: All FHIR elements must have a @value or children
.... Slices for doseNumber[x] 1..1 string Dose number within series
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
..... doseNumber[x]:doseNumberString S 0..1 string Dose number within series
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Immunization.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status
from the FHIR Standard
Immunization.vaccineCodeextensibleCVX Vaccines Administered Vaccine Set .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6
Immunization.primarySource.extension:dar.value[x]requiredPattern: unknown
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard
Immunization.performer:AP.functionextensiblePattern: AP
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorImmunization.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

This structure is derived from USCoreImmunizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* USCoreImmunizationProfile Immunization event information
... Slices for identifier S 1..* Identifier Business identifier
Slice: Unordered, Open by value:use
.... identifier:TOid 1..1 Identifier Business identifier
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
..... system C 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
..... value 0..1 string `ImmunizationTO` | `.` | {ImmunizationTO.id}
... status 1..1 code May indicate entered-in-error
... statusReason 0..0
... vaccineCode
.... coding
..... code 0..1 code Symbol in syntax defined by the system
..... display 0..1 string Representation defined by the system
.... text 1..1 string Plain text representation of the concept
... patient 1..1 Reference(US Core Patient Profile) Who was immunized
... encounter 0..0
... occurrence[x] 1..1 dateTime Vaccine administration date
... recorded S 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource 1..1 boolean Indicates context the data was recorded in
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:dar 1..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
...... value[x] 1..1 code Value of extension
Required Pattern: unknown
... reportOrigin 0..0
... location S 0..1 Reference(VA MHV PHR Location | Location) {c} Where immunization occurred
.... display 0..0
... manufacturer 0..0
... lotNumber 0..0
... expirationDate 0..0
... site 0..0
... route 0..0
... doseQuantity 0..0
... Slices for performer S 0..* BackboneElement Who performed event
Slice: Unordered, Closed by value:function
.... performer:All Slices Content/Rules for all slices
..... function S 0..1 CodeableConcept What type of performance was done
..... actor 1..1 Reference(Practitioner | PractitionerRole | Organization) {c} Individual or organization who was performing
...... display 0..0
.... performer:AP 0..* BackboneElement Who performed event
..... function S 1..1 CodeableConcept What type of performance was done
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AP
..... actor 1..1 Reference(VA MHV PHR Practitioner | Practitioner) {c} Individual or organization who was performing
.... performer:@default 0..* BackboneElement Who performed event
..... function S 0..0
..... actor 1..1 Reference(VA MHV PHR Organization | Organization) {c} Individual or organization who was performing
... note S 0..1 Annotation Additional immunization notes
.... text 1..1 markdown The annotation - text content (as markdown)
... reasonCode 0..0
... reasonReference 0..0
... isSubpotent 0..0
... education 0..0
... programEligibility 0..0
... fundingSource 0..0
... reaction
.... date 0..0
.... detail
..... reference 0..0
..... identifier 0..0
..... display S 0..1 string Text alternative for the resource
.... reported 0..0
... protocolApplied S 0..* BackboneElement Protocol followed by the provider
.... series S 0..1 string Name of vaccine series
.... authority 0..0
.... targetDisease 0..0
.... Slices for doseNumber[x] 1..1 string Dose number within series
Slice: Unordered, Open by type:$this
..... doseNumber[x]:doseNumberString S 0..1 string Dose number within series
..... doseNumber[x]:doseNumberPositiveInt 0..0
.... seriesDoses[x] 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorImmunization.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* USCoreImmunizationProfile Immunization event information
us-core-5: SHOULD have a translation to the NDC value set
... 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier Business identifier
Slice: Unordered, Open by value:use
.... identifier:TOid 1..1 Identifier Business identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `ImmunizationTO` | `.` | {ImmunizationTO.id}
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code May indicate entered-in-error
Binding: ImmunizationStatusCodes (required)
... vaccineCode SΣC 1..1 CodeableConcept Vaccine Product Type (bind to CVX)
Binding: CVX Vaccines Administered Vaccine Set . (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 1..1 string Plain text representation of the concept
... patient SΣ 1..1 Reference(US Core Patient Profile) Who was immunized
... occurrence[x] SΣ 1..1 dateTime S Vaccine administration date
... recorded S 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource SΣ 1..1 boolean Indicates context the data was recorded in
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:dar 1..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] 1..1 code Value of extension
Binding: DataAbsentReason (required)
Required Pattern: unknown
.... value 0..1 boolean Primitive value for boolean
... location S 0..1 Reference(VA MHV PHR Location | Location) {c} Where immunization occurred
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... Slices for performer SΣ 0..* BackboneElement Who performed event
Slice: Unordered, Closed by value:function
.... performer:All Slices Content/Rules for all slices
..... 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
..... function SΣ 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) {c} Individual or organization who was performing
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... performer:AP Σ 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
..... function SΣ 1..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AP
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... actor Σ 1..1 Reference(VA MHV PHR Practitioner | Practitioner) {c} Individual or organization who was performing
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... performer:@default Σ 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(VA MHV PHR Organization | Organization) {c} Individual or organization who was performing
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... note SΣ 0..1 Annotation Additional immunization notes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)
... subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... reaction 0..* BackboneElement Details of a reaction that follows immunization
.... 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
.... detail 0..1 Reference(Observation) Additional information on reaction
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... display SΣ 0..1 string Text alternative for the resource
... protocolApplied S 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
.... series S 0..1 string Name of vaccine series
.... Slices for doseNumber[x] 1..1 string Dose number within series
Slice: Unordered, Closed by type:$this
..... doseNumber[x]:doseNumberString S 0..1 string Dose number within series

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Immunization.identifier:TOid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status
from the FHIR Standard
Immunization.vaccineCodeextensibleCVX Vaccines Administered Vaccine Set .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6
Immunization.primarySource.extension:dar.value[x]requiredPattern: unknown
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Immunization.location.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard
Immunization.performer.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Immunization.performer:AP.functionextensiblePattern: AP
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard
Immunization.performer:AP.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Immunization.performer:@default.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
from the FHIR Standard
Immunization.reaction.detail.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorImmunization.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

This structure is derived from USCoreImmunizationProfile

Summary

Mandatory: 6 elements(1 nested mandatory element)
Must-Support: 12 elements
Prohibited: 26 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 1 is sliced based on the value of Immunization.identifier
  • The element 1 is sliced based on the value of Immunization.performer (Closed)
  • The element 1 is sliced based on the value of Immunization.protocolApplied.doseNumber[x]

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* USCoreImmunizationProfile Immunization event information
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
us-core-5: SHOULD have a translation to the NDC value set
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier S 1..* Identifier Business identifier
Slice: Unordered, Open by value:use
ele-1: All FHIR elements must have a @value or children
.... identifier:TOid 1..1 Identifier Business identifier
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Required Pattern: usual
..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
ele-1: All FHIR elements must have a @value or children
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `ImmunizationTO` | `.` | {ImmunizationTO.id}
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... status ?!SΣ 1..1 code May indicate entered-in-error
Binding: ImmunizationStatusCodes (required)
ele-1: All FHIR elements must have a @value or children
... vaccineCode SΣC 1..1 CodeableConcept Vaccine Product Type (bind to CVX)
Binding: CVX Vaccines Administered Vaccine Set . (extensible)
ele-1: All FHIR elements must have a @value or children
.... text Σ 1..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... patient SΣ 1..1 Reference(US Core Patient Profile) Who was immunized
ele-1: All FHIR elements must have a @value or children
... occurrence[x] SΣ 1..1 dateTime Vaccine administration date
ele-1: All FHIR elements must have a @value or children
... recorded S 0..1 dateTime When the immunization was first captured in the subject's record
ele-1: All FHIR elements must have a @value or children
... primarySource SΣ 1..1 boolean Indicates context the data was recorded in
ele-1: All FHIR elements must have a @value or children
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:dar 1..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] 1..1 code Value of extension
Binding: DataAbsentReason (required)
ele-1: All FHIR elements must have a @value or children
Required Pattern: unknown
... location S 0..1 Reference(VA MHV PHR Location | Location) {c} Where immunization occurred
ele-1: All FHIR elements must have a @value or children
... Slices for performer SΣ 0..* BackboneElement Who performed event
Slice: Unordered, Closed by value:function
ele-1: All FHIR elements must have a @value or children
.... performer:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... function SΣ 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


ele-1: All FHIR elements must have a @value or children
..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) {c} Individual or organization who was performing
ele-1: All FHIR elements must have a @value or children
.... performer:AP Σ 0..* BackboneElement Who performed event
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... function SΣ 1..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AP
..... actor Σ 1..1 Reference(VA MHV PHR Practitioner | Practitioner) {c} Individual or organization who was performing
ele-1: All FHIR elements must have a @value or children
.... performer:@default Σ 0..* BackboneElement Who performed event
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... actor Σ 1..1 Reference(VA MHV PHR Organization | Organization) {c} Individual or organization who was performing
ele-1: All FHIR elements must have a @value or children
... note SΣ 0..1 Annotation Additional immunization notes
ele-1: All FHIR elements must have a @value or children
.... text Σ 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children
... reaction 0..* BackboneElement Details of a reaction that follows immunization
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... detail 0..1 Reference(Observation) Additional information on reaction
ele-1: All FHIR elements must have a @value or children
..... display SΣ 0..1 string Text alternative for the resource
ele-1: All FHIR elements must have a @value or children
... protocolApplied S 0..* BackboneElement Protocol followed by the provider
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... series S 0..1 string Name of vaccine series
ele-1: All FHIR elements must have a @value or children
.... Slices for doseNumber[x] 1..1 string Dose number within series
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
..... doseNumber[x]:doseNumberString S 0..1 string Dose number within series
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Immunization.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status
from the FHIR Standard
Immunization.vaccineCodeextensibleCVX Vaccines Administered Vaccine Set .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6
Immunization.primarySource.extension:dar.value[x]requiredPattern: unknown
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard
Immunization.performer:AP.functionextensiblePattern: AP
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorImmunization.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

Differential View

This structure is derived from USCoreImmunizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* USCoreImmunizationProfile Immunization event information
... Slices for identifier S 1..* Identifier Business identifier
Slice: Unordered, Open by value:use
.... identifier:TOid 1..1 Identifier Business identifier
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
..... system C 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
..... value 0..1 string `ImmunizationTO` | `.` | {ImmunizationTO.id}
... status 1..1 code May indicate entered-in-error
... statusReason 0..0
... vaccineCode
.... coding
..... code 0..1 code Symbol in syntax defined by the system
..... display 0..1 string Representation defined by the system
.... text 1..1 string Plain text representation of the concept
... patient 1..1 Reference(US Core Patient Profile) Who was immunized
... encounter 0..0
... occurrence[x] 1..1 dateTime Vaccine administration date
... recorded S 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource 1..1 boolean Indicates context the data was recorded in
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:dar 1..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
...... value[x] 1..1 code Value of extension
Required Pattern: unknown
... reportOrigin 0..0
... location S 0..1 Reference(VA MHV PHR Location | Location) {c} Where immunization occurred
.... display 0..0
... manufacturer 0..0
... lotNumber 0..0
... expirationDate 0..0
... site 0..0
... route 0..0
... doseQuantity 0..0
... Slices for performer S 0..* BackboneElement Who performed event
Slice: Unordered, Closed by value:function
.... performer:All Slices Content/Rules for all slices
..... function S 0..1 CodeableConcept What type of performance was done
..... actor 1..1 Reference(Practitioner | PractitionerRole | Organization) {c} Individual or organization who was performing
...... display 0..0
.... performer:AP 0..* BackboneElement Who performed event
..... function S 1..1 CodeableConcept What type of performance was done
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AP
..... actor 1..1 Reference(VA MHV PHR Practitioner | Practitioner) {c} Individual or organization who was performing
.... performer:@default 0..* BackboneElement Who performed event
..... function S 0..0
..... actor 1..1 Reference(VA MHV PHR Organization | Organization) {c} Individual or organization who was performing
... note S 0..1 Annotation Additional immunization notes
.... text 1..1 markdown The annotation - text content (as markdown)
... reasonCode 0..0
... reasonReference 0..0
... isSubpotent 0..0
... education 0..0
... programEligibility 0..0
... fundingSource 0..0
... reaction
.... date 0..0
.... detail
..... reference 0..0
..... identifier 0..0
..... display S 0..1 string Text alternative for the resource
.... reported 0..0
... protocolApplied S 0..* BackboneElement Protocol followed by the provider
.... series S 0..1 string Name of vaccine series
.... authority 0..0
.... targetDisease 0..0
.... Slices for doseNumber[x] 1..1 string Dose number within series
Slice: Unordered, Open by type:$this
..... doseNumber[x]:doseNumberString S 0..1 string Dose number within series
..... doseNumber[x]:doseNumberPositiveInt 0..0
.... seriesDoses[x] 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorImmunization.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* USCoreImmunizationProfile Immunization event information
us-core-5: SHOULD have a translation to the NDC value set
... 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier Business identifier
Slice: Unordered, Open by value:use
.... identifier:TOid 1..1 Identifier Business identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `ImmunizationTO` | `.` | {ImmunizationTO.id}
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code May indicate entered-in-error
Binding: ImmunizationStatusCodes (required)
... vaccineCode SΣC 1..1 CodeableConcept Vaccine Product Type (bind to CVX)
Binding: CVX Vaccines Administered Vaccine Set . (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 1..1 string Plain text representation of the concept
... patient SΣ 1..1 Reference(US Core Patient Profile) Who was immunized
... occurrence[x] SΣ 1..1 dateTime S Vaccine administration date
... recorded S 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource SΣ 1..1 boolean Indicates context the data was recorded in
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:dar 1..1 (Complex) unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] 1..1 code Value of extension
Binding: DataAbsentReason (required)
Required Pattern: unknown
.... value 0..1 boolean Primitive value for boolean
... location S 0..1 Reference(VA MHV PHR Location | Location) {c} Where immunization occurred
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... Slices for performer SΣ 0..* BackboneElement Who performed event
Slice: Unordered, Closed by value:function
.... performer:All Slices Content/Rules for all slices
..... 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
..... function SΣ 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) {c} Individual or organization who was performing
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... performer:AP Σ 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
..... function SΣ 1..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: AP
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... actor Σ 1..1 Reference(VA MHV PHR Practitioner | Practitioner) {c} Individual or organization who was performing
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... performer:@default Σ 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(VA MHV PHR Organization | Organization) {c} Individual or organization who was performing
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
... note SΣ 0..1 Annotation Additional immunization notes
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)
... subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... reaction 0..* BackboneElement Details of a reaction that follows immunization
.... 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
.... detail 0..1 Reference(Observation) Additional information on reaction
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... display SΣ 0..1 string Text alternative for the resource
... protocolApplied S 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
.... series S 0..1 string Name of vaccine series
.... Slices for doseNumber[x] 1..1 string Dose number within series
Slice: Unordered, Closed by type:$this
..... doseNumber[x]:doseNumberString S 0..1 string Dose number within series

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Immunization.identifier:TOid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status
from the FHIR Standard
Immunization.vaccineCodeextensibleCVX Vaccines Administered Vaccine Set .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6
Immunization.primarySource.extension:dar.value[x]requiredPattern: unknown
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Immunization.location.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard
Immunization.performer.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Immunization.performer:AP.functionextensiblePattern: AP
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard
Immunization.performer:AP.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Immunization.performer:@default.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
from the FHIR Standard
Immunization.reaction.detail.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorImmunization.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

This structure is derived from USCoreImmunizationProfile

Summary

Mandatory: 6 elements(1 nested mandatory element)
Must-Support: 12 elements
Prohibited: 26 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 1 is sliced based on the value of Immunization.identifier
  • The element 1 is sliced based on the value of Immunization.performer (Closed)
  • The element 1 is sliced based on the value of Immunization.protocolApplied.doseNumber[x]

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron