Copy of 'GP Connect Data Model | FHIR STU3 Representation'

Profile: CareConnect-GPC-Immunization-1

CareConnect-GPC-Immunization-1 (Immunization)

There are no (further) constraints on this element

Element id

Immunization

Short description

Immunization event information

Definition

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

Data type

Immunization

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-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
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
workflow: Event
v2: VXU_V04
rim: SubstanceAdministration

0..1

There are no (further) constraints on this element

Element id

Immunization.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Meta

There are no (further) constraints on this element

Element id

Immunization.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

0..1

string

There are no (further) constraints on this element

Element id

Immunization.meta.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.meta.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

versionId

0..1

There are no (further) constraints on this element

Element id

Immunization.meta.versionId

Short description

Version specific identifier

Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

lastUpdated

0..1

instant

There are no (further) constraints on this element

Element id

Immunization.meta.lastUpdated

Short description

When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Data type

instant

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

source

0..1

uri

There are no (further) constraints on this element

Element id

Immunization.meta.source

Short description

Identifies where the resource comes from

Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

profile

1..*

canonical(StructureDefinition)

There are no (further) constraints on this element

Element id

Immunization.meta.profile

Short description

Profiles this resource claims to conform to

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Data type

canonical(StructureDefinition)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

security

0..*

CodingBinding

There are no (further) constraints on this element

Element id

Immunization.meta.security

Short description

Security Labels applied to this resource

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Coding

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

AllSecurityLabels (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

tag

0..*

Coding

There are no (further) constraints on this element

Element id

Immunization.meta.tag

Short description

Tags applied to this resource

Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Coding

Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

implicitRules

Σ ?!

0..1

uri

There are no (further) constraints on this element

Element id

Immunization.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Immunization.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

MaxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

text

0..1

Narrative

There are no (further) constraints on this element

Element id

Immunization.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

Resource

There are no (further) constraints on this element

Element id

Immunization.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

2..*

Extension

There are no (further) constraints on this element

Element id

Immunization.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

parentPresent

S C

0..1

Extension

Element id

Immunization.extension:parentPresent

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Extension URL

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..1

string

There are no (further) constraints on this element

Element id

Immunization.extension:parentPresent.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.extension:parentPresent.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

Element id

Immunization.extension:parentPresent.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Data type

uri

Fixed value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

Immunization.extension:parentPresent.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

valueAddress

Address

There are no (further) constraints on this element

Data type

Address

valueAge

Age

There are no (further) constraints on this element

Data type

Age

valueAnnotation

Annotation

There are no (further) constraints on this element

Data type

Annotation

valueAttachment

Attachment

There are no (further) constraints on this element

Data type

Attachment

valueBase64Binary

base64Binary

There are no (further) constraints on this element

Data type

base64Binary

valueBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

valueCanonical

canonical

There are no (further) constraints on this element

Data type

canonical

valueCode

code

There are no (further) constraints on this element

Data type

code

valueCodeableConcept

CodeableConcept

There are no (further) constraints on this element

Data type

CodeableConcept

valueCoding

Coding

There are no (further) constraints on this element

Data type

Coding

valueContactDetail

ContactDetail

There are no (further) constraints on this element

Data type

ContactDetail

valueContactPoint

ContactPoint

There are no (further) constraints on this element

Data type

ContactPoint

valueContributor

Contributor

There are no (further) constraints on this element

Data type

Contributor

valueCount

Count

There are no (further) constraints on this element

Data type

Count

valueDataRequirement

DataRequirement

There are no (further) constraints on this element

Data type

DataRequirement

valueDate

date

There are no (further) constraints on this element

Data type

date

valueDateTime

dateTime

There are no (further) constraints on this element

Data type

dateTime

valueDecimal

decimal

There are no (further) constraints on this element

Data type

decimal

valueDistance

Distance

There are no (further) constraints on this element

Data type

Distance

valueDosage

Dosage

There are no (further) constraints on this element

Data type

Dosage

valueDuration

Duration

There are no (further) constraints on this element

Data type

Duration

valueExpression

Expression

There are no (further) constraints on this element

Data type

Expression

valueHumanName

HumanName

There are no (further) constraints on this element

Data type

HumanName

valueId

There are no (further) constraints on this element

Data type

valueIdentifier

Identifier

There are no (further) constraints on this element

Data type

Identifier

valueInstant

instant

There are no (further) constraints on this element

Data type

instant

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueMeta

Meta

There are no (further) constraints on this element

Data type

Meta

valueMoney

Money

There are no (further) constraints on this element

Data type

Money

valueOid

oid

There are no (further) constraints on this element

Data type

oid

valueParameterDefinition

ParameterDefinition

There are no (further) constraints on this element

Data type

ParameterDefinition

valuePeriod

Period

There are no (further) constraints on this element

Data type

Period

valuePositiveInt

positiveInt

There are no (further) constraints on this element

Data type

positiveInt

valueQuantity

Quantity

There are no (further) constraints on this element

Data type

Quantity

valueRange

Range

There are no (further) constraints on this element

Data type

Range

valueRatio

Ratio

There are no (further) constraints on this element

Data type

Ratio

valueReference

Reference

There are no (further) constraints on this element

Data type

Reference

valueRelatedArtifact

RelatedArtifact

There are no (further) constraints on this element

Data type

RelatedArtifact

valueSampledData

SampledData

There are no (further) constraints on this element

Data type

SampledData

valueSignature

Signature

There are no (further) constraints on this element

Data type

Signature

valueString

string

There are no (further) constraints on this element

Data type

string

valueTime

time

There are no (further) constraints on this element

Data type

time

valueTiming

Timing

There are no (further) constraints on this element

Data type

Timing

valueTriggerDefinition

TriggerDefinition

There are no (further) constraints on this element

Data type

TriggerDefinition

valueUnsignedInt

unsignedInt

There are no (further) constraints on this element

Data type

unsignedInt

valueUri

uri

There are no (further) constraints on this element

Data type

uri

valueUrl

url

There are no (further) constraints on this element

Data type

url

valueUsageContext

UsageContext

There are no (further) constraints on this element

Data type

UsageContext

valueUuid

uuid

There are no (further) constraints on this element

Data type

uuid

recordedDate

1..1

Extension

Element id

Immunization.extension:recordedDate

Short description

The date that the Vaccination was recorded

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Extension URL

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..1

string

There are no (further) constraints on this element

Element id

Immunization.extension:recordedDate.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.extension:recordedDate.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

Element id

Immunization.extension:recordedDate.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

uri

Fixed value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

Immunization.extension:recordedDate.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

valueAddress

Address

There are no (further) constraints on this element

Data type

Address

valueAge

Age

There are no (further) constraints on this element

Data type

Age

valueAnnotation

Annotation

There are no (further) constraints on this element

Data type

Annotation

valueAttachment

Attachment

There are no (further) constraints on this element

Data type

Attachment

valueBase64Binary

base64Binary

There are no (further) constraints on this element

Data type

base64Binary

valueBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

valueCanonical

canonical

There are no (further) constraints on this element

Data type

canonical

valueCode

code

There are no (further) constraints on this element

Data type

code

valueCodeableConcept

CodeableConcept

There are no (further) constraints on this element

Data type

CodeableConcept

valueCoding

Coding

There are no (further) constraints on this element

Data type

Coding

valueContactDetail

ContactDetail

There are no (further) constraints on this element

Data type

ContactDetail

valueContactPoint

ContactPoint

There are no (further) constraints on this element

Data type

ContactPoint

valueContributor

Contributor

There are no (further) constraints on this element

Data type

Contributor

valueCount

Count

There are no (further) constraints on this element

Data type

Count

valueDataRequirement

DataRequirement

There are no (further) constraints on this element

Data type

DataRequirement

valueDate

date

There are no (further) constraints on this element

Data type

date

valueDateTime

dateTime

There are no (further) constraints on this element

Data type

dateTime

valueDecimal

decimal

There are no (further) constraints on this element

Data type

decimal

valueDistance

Distance

There are no (further) constraints on this element

Data type

Distance

valueDosage

Dosage

There are no (further) constraints on this element

Data type

Dosage

valueDuration

Duration

There are no (further) constraints on this element

Data type

Duration

valueExpression

Expression

There are no (further) constraints on this element

Data type

Expression

valueHumanName

HumanName

There are no (further) constraints on this element

Data type

HumanName

valueId

There are no (further) constraints on this element

Data type

valueIdentifier

Identifier

There are no (further) constraints on this element

Data type

Identifier

valueInstant

instant

There are no (further) constraints on this element

Data type

instant

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueMeta

Meta

There are no (further) constraints on this element

Data type

Meta

valueMoney

Money

There are no (further) constraints on this element

Data type

Money

valueOid

oid

There are no (further) constraints on this element

Data type

oid

valueParameterDefinition

ParameterDefinition

There are no (further) constraints on this element

Data type

ParameterDefinition

valuePeriod

Period

There are no (further) constraints on this element

Data type

Period

valuePositiveInt

positiveInt

There are no (further) constraints on this element

Data type

positiveInt

valueQuantity

Quantity

There are no (further) constraints on this element

Data type

Quantity

valueRange

Range

There are no (further) constraints on this element

Data type

Range

valueRatio

Ratio

There are no (further) constraints on this element

Data type

Ratio

valueReference

Reference

There are no (further) constraints on this element

Data type

Reference

valueRelatedArtifact

RelatedArtifact

There are no (further) constraints on this element

Data type

RelatedArtifact

valueSampledData

SampledData

There are no (further) constraints on this element

Data type

SampledData

valueSignature

Signature

There are no (further) constraints on this element

Data type

Signature

valueString

string

There are no (further) constraints on this element

Data type

string

valueTime

time

There are no (further) constraints on this element

Data type

time

valueTiming

Timing

There are no (further) constraints on this element

Data type

Timing

valueTriggerDefinition

TriggerDefinition

There are no (further) constraints on this element

Data type

TriggerDefinition

valueUnsignedInt

unsignedInt

There are no (further) constraints on this element

Data type

unsignedInt

valueUri

uri

There are no (further) constraints on this element

Data type

uri

valueUrl

url

There are no (further) constraints on this element

Data type

url

valueUsageContext

UsageContext

There are no (further) constraints on this element

Data type

UsageContext

valueUuid

uuid

There are no (further) constraints on this element

Data type

uuid

vaccinationProcedure

1..1

Extension

Element id

Immunization.extension:vaccinationProcedure

Short description

The procedure code describing the vaccine that was administered.

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Extension URL

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-VaccinationProcedure-1

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..1

string

There are no (further) constraints on this element

Element id

Immunization.extension:vaccinationProcedure.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.extension:vaccinationProcedure.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

Element id

Immunization.extension:vaccinationProcedure.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

uri

Fixed value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-VaccinationProcedure-1

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

Immunization.extension:vaccinationProcedure.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

valueCodeableConcept

CodeableConcept

Data type

CodeableConcept

modifierExtension

?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

1..*

Identifier

There are no (further) constraints on this element

Element id

Immunization.identifier

Short description

Business identifier

Definition

A unique identifier assigned to this immunization record.

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Event.identifier
w5: FiveWs.identifier
rim: .id
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id

0..1

string

There are no (further) constraints on this element

Element id

Immunization.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Immunization.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Immunization.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

CodeableConcept

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

IdentifierTypeCodes (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

1..1

uri

There are no (further) constraints on this element

Element id

Immunization.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

1..1

string

There are no (further) constraints on this element

Element id

Immunization.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..1

Period

There are no (further) constraints on this element

Element id

Immunization.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

Reference(CareConnect-GPC-Organization-1)

Element id

Immunization.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Reference(CareConnect-GPC-Organization-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

status

Σ ?!

1..1

codeBindingFixed Value

Element id

Immunization.status

Short description

completed

Definition

Indicates the current status of the immunization event.

Comments

Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Data type

code

Binding

A set of codes indicating the current status of an Immunization.

ImmunizationStatusCodes (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

completed

Mappings

rim: n/a
workflow: Event.status
w5: FiveWs.status
rim: statusCode

statusReason

0..1

CodeableConcept

There are no (further) constraints on this element

Element id

Immunization.statusReason

Short description

Reason not done

Definition

Indicates the reason the immunization event was not performed.

Comments

This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here.

Data type

CodeableConcept

Binding

The reason why a vaccine was not administered.

ImmunizationStatusReasonCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.statusReason
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde

vaccineCode

1..1

CodeableConceptBinding

Element id

Immunization.vaccineCode

Short description

Vaccine product administered

Definition

Vaccine that was administered or was to be administered.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Data type

CodeableConcept

Binding

The code for vaccine product administered.

VaccineAdministeredValueSet (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.code
w5: FiveWs.what[x]
v2: RXA-5
rim: .code
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code

0..1

string

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

0..*

Coding

Element id

Immunization.vaccineCode.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Data type

Coding

Slicing

Unordered, Open, by system(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

snomedCT

0..1

Coding

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

snomedCTDescriptionID

0..1

Extension(Complex)

Element id

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID

Short description

The SNOMED CT Description ID for the display

Alternate names

extensions, user content

Definition

The SNOMED CT Description ID for the display.

Comments

Data type

Extension(Complex)

Extension URL

Extension-coding-sctdescid

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..1

string

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

1..*

Extension

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

descriptionId

1..1

Extension

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId

Short description

The SNOMED CT Description ID

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..1

string

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

uri

Fixed value

descriptionId

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.value[x]

Short description

The SNOMED CT Description ID

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

valueId

There are no (further) constraints on this element

Data type

descriptionDisplay

0..1

Extension

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay

Short description

The SNOMED CT display for the description ID

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..1

string

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..0

Extension

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

uri

Fixed value

descriptionDisplay

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.value[x]

Short description

The SNOMED CT display for the description ID

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

valueString

string

There are no (further) constraints on this element

Data type

string

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

uri

Fixed value

https://fhir.nhs.uk/STU3/StructureDefinition/Extension-coding-sctdescid

Mappings

rim: N/A

value[x]

0..0

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

system

1..1

uriFixed Value

Element id

Immunization.vaccineCode.coding:snomedCT.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

http://snomed.info/sct

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

string

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.version

Short description

Version of the system - if relevant

Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

code

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

1..1

string

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:snomedCT.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

string

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

patient

Σ C

1..1

Reference(CareConnect-GPC-Patient-1)

Element id

Immunization.patient

Short description

Who was immunized

Definition

The patient who either received or did not receive the immunization.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(CareConnect-GPC-Patient-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.subject
w5: FiveWs.subject[x]
v2: PID-3
rim: .partipication[ttypeCode=].role
w5: FiveWs.subject

encounter

S C

0..1

Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1)

Element id

Immunization.encounter

Short description

Encounter immunization was part of

Definition

The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

Comments

Data type

Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.context
w5: FiveWs.context
v2: PV1-19
rim: component->EncounterEvent

occurrence[x]

1..1

There are no (further) constraints on this element

Element id

Immunization.occurrence[x]

Short description

Vaccine administration date

Definition

Date vaccine administered or was to be administered.

Comments

When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Event.occurrence[x]
w5: FiveWs.done[x]
v2: RXA-3
rim: .effectiveTime
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value

occurrenceDateTime

dateTime

There are no (further) constraints on this element

Data type

dateTime

occurrenceString

string

There are no (further) constraints on this element

Data type

string

recorded

0..1

dateTime

There are no (further) constraints on this element

Element id

Immunization.recorded

Short description

When the immunization was first captured in the subject's record

Definition

The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.recorded
rim: .participation[typeCode=AUT].time

primarySource

0..1

boolean

Element id

Immunization.primarySource

Short description

Indicates context the data was recorded in

Definition

An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.

Comments

Reflects the “reliability” of the content.

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Default value

true

Mappings

rim: n/a
w5: FiveWs.source
v2: RXA-9
rim: immunization.uncertaintycode (if primary source=false, uncertainty=U)

reportOrigin

0..1

CodeableConcept

There are no (further) constraints on this element

Element id

Immunization.reportOrigin

Short description

Indicates the source of a secondarily reported record

Definition

The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.

Comments

Should not be populated if primarySource = True, not required even if primarySource = False.

Data type

CodeableConcept

Binding

The source of the data for a record which is not from a primary source.

ImmunizationOriginCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.source
v2: RXA-9
rim: .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported) .participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional) .participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)

location

S C

0..1

Reference(CareConnect-GPC-Location-1)

Element id

Immunization.location

Short description

Where immunization occurred

Definition

The service delivery location where the vaccine administration occurred.

Comments

Data type

Reference(CareConnect-GPC-Location-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.location
w5: FiveWs.where[x]
v2: RXA-27 (or RXA-11, deprecated as of v2.7)
rim: .participation[typeCode=LOC].COCT_MT240000UV

manufacturer

S C

0..1

Reference(CareConnect-GPC-Organization-1)

Element id

Immunization.manufacturer

Short description

Vaccine manufacturer

Definition

Name of vaccine manufacturer.

Comments

Data type

Reference(CareConnect-GPC-Organization-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: RXA-17
rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name

lotNumber

0..1

string

There are no (further) constraints on this element

Element id

Immunization.lotNumber

Short description

Vaccine lot number

Definition

Lot number of the vaccine product.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: RXA-15
rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText

expirationDate

0..1

date

There are no (further) constraints on this element

Element id

Immunization.expirationDate

Short description

Vaccine expiration date

Definition

Date vaccine batch expires.

Data type

date

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: RXA-16
rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime

site

0..1

CodeableConcept

There are no (further) constraints on this element

Element id

Immunization.site

Short description

Body site vaccine was administered

Definition

Body site where vaccine was administered.

Comments

Data type

CodeableConcept

Binding

The site at which the vaccine was administered.

CodesForImmunizationSiteOfAdministration (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: RXR-2
rim: observation.targetSiteCode
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code

0..1

string

There are no (further) constraints on this element

Element id

Immunization.site.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.site.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

0..*

Coding

Element id

Immunization.site.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Slicing

Unordered, Open, by system(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

snomedCT

0..1

Coding

There are no (further) constraints on this element

Element id

Immunization.site.coding:snomedCT

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

Immunization.site.coding:snomedCT.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.site.coding:snomedCT.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

snomedCTDescriptionID

0..1

Extension

Element id

Immunization.site.coding:snomedCT.extension:snomedCTDescriptionID

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Extension URL

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..1

string

There are no (further) constraints on this element

Element id

Immunization.site.coding:snomedCT.extension:snomedCTDescriptionID.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.site.coding:snomedCT.extension:snomedCTDescriptionID.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

Element id

Immunization.site.coding:snomedCT.extension:snomedCTDescriptionID.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

uri

Fixed value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

Immunization.site.coding:snomedCT.extension:snomedCTDescriptionID.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

valueAddress

Address

There are no (further) constraints on this element

Data type

Address

valueAge

Age

There are no (further) constraints on this element

Data type

Age

valueAnnotation

Annotation

There are no (further) constraints on this element

Data type

Annotation

valueAttachment

Attachment

There are no (further) constraints on this element

Data type

Attachment

valueBase64Binary

base64Binary

There are no (further) constraints on this element

Data type

base64Binary

valueBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

valueCanonical

canonical

There are no (further) constraints on this element

Data type

canonical

valueCode

code

There are no (further) constraints on this element

Data type

code

valueCodeableConcept

CodeableConcept

There are no (further) constraints on this element

Data type

CodeableConcept

valueCoding

Coding

There are no (further) constraints on this element

Data type

Coding

valueContactDetail

ContactDetail

There are no (further) constraints on this element

Data type

ContactDetail

valueContactPoint

ContactPoint

There are no (further) constraints on this element

Data type

ContactPoint

valueContributor

Contributor

There are no (further) constraints on this element

Data type

Contributor

valueCount

Count

There are no (further) constraints on this element

Data type

Count

valueDataRequirement

DataRequirement

There are no (further) constraints on this element

Data type

DataRequirement

valueDate

date

There are no (further) constraints on this element

Data type

date

valueDateTime

dateTime

There are no (further) constraints on this element

Data type

dateTime

valueDecimal

decimal

There are no (further) constraints on this element

Data type

decimal

valueDistance

Distance

There are no (further) constraints on this element

Data type

Distance

valueDosage

Dosage

There are no (further) constraints on this element

Data type

Dosage

valueDuration

Duration

There are no (further) constraints on this element

Data type

Duration

valueExpression

Expression

There are no (further) constraints on this element

Data type

Expression

valueHumanName

HumanName

There are no (further) constraints on this element

Data type

HumanName

valueId

There are no (further) constraints on this element

Data type

valueIdentifier

Identifier

There are no (further) constraints on this element

Data type

Identifier

valueInstant

instant

There are no (further) constraints on this element

Data type

instant

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueMeta

Meta

There are no (further) constraints on this element

Data type

Meta

valueMoney

Money

There are no (further) constraints on this element

Data type

Money

valueOid

oid

There are no (further) constraints on this element

Data type

oid

valueParameterDefinition

ParameterDefinition

There are no (further) constraints on this element

Data type

ParameterDefinition

valuePeriod

Period

There are no (further) constraints on this element

Data type

Period

valuePositiveInt

positiveInt

There are no (further) constraints on this element

Data type

positiveInt

valueQuantity

Quantity

There are no (further) constraints on this element

Data type

Quantity

valueRange

Range

There are no (further) constraints on this element

Data type

Range

valueRatio

Ratio

There are no (further) constraints on this element

Data type

Ratio

valueReference

Reference

There are no (further) constraints on this element

Data type

Reference

valueRelatedArtifact

RelatedArtifact

There are no (further) constraints on this element

Data type

RelatedArtifact

valueSampledData

SampledData

There are no (further) constraints on this element

Data type

SampledData

valueSignature

Signature

There are no (further) constraints on this element

Data type

Signature

valueString

string

There are no (further) constraints on this element

Data type

string

valueTime

time

There are no (further) constraints on this element

Data type

time

valueTiming

Timing

There are no (further) constraints on this element

Data type

Timing

valueTriggerDefinition

TriggerDefinition

There are no (further) constraints on this element

Data type

TriggerDefinition

valueUnsignedInt

unsignedInt

There are no (further) constraints on this element

Data type

unsignedInt

valueUri

uri

There are no (further) constraints on this element

Data type

uri

valueUrl

url

There are no (further) constraints on this element

Data type

url

valueUsageContext

UsageContext

There are no (further) constraints on this element

Data type

UsageContext

valueUuid

uuid

There are no (further) constraints on this element

Data type

uuid

system

1..1

uriFixed Value

Element id

Immunization.site.coding:snomedCT.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

http://snomed.info/sct

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

Immunization.site.coding:snomedCT.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

code

There are no (further) constraints on this element

Element id

Immunization.site.coding:snomedCT.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

1..1

string

There are no (further) constraints on this element

Element id

Immunization.site.coding:snomedCT.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Immunization.site.coding:snomedCT.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

string

There are no (further) constraints on this element

Element id

Immunization.site.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

route

0..1

CodeableConcept

There are no (further) constraints on this element

Element id

Immunization.route

Short description

How vaccine entered body

Definition

The path by which the vaccine product is taken into the body.

Comments

Data type

CodeableConcept

Binding

The route by which the vaccine was administered.

ImmunizationRouteCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: RXR-1
rim: .routeCode
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code

0..1

string

There are no (further) constraints on this element

Element id

Immunization.route.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.route.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

0..*

Coding

Element id

Immunization.route.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Slicing

Unordered, Open, by system(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

snomedCT

0..1

Coding

Element id

Immunization.route.coding:snomedCT

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Binding

A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration.

(unbound) (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

Immunization.route.coding:snomedCT.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.route.coding:snomedCT.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

snomedCTDescriptionID

0..1

Extension

Element id

Immunization.route.coding:snomedCT.extension:snomedCTDescriptionID

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Extension URL

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..1

string

There are no (further) constraints on this element

Element id

Immunization.route.coding:snomedCT.extension:snomedCTDescriptionID.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.route.coding:snomedCT.extension:snomedCTDescriptionID.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

Element id

Immunization.route.coding:snomedCT.extension:snomedCTDescriptionID.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

uri

Fixed value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

Immunization.route.coding:snomedCT.extension:snomedCTDescriptionID.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

valueAddress

Address

There are no (further) constraints on this element

Data type

Address

valueAge

Age

There are no (further) constraints on this element

Data type

Age

valueAnnotation

Annotation

There are no (further) constraints on this element

Data type

Annotation

valueAttachment

Attachment

There are no (further) constraints on this element

Data type

Attachment

valueBase64Binary

base64Binary

There are no (further) constraints on this element

Data type

base64Binary

valueBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

valueCanonical

canonical

There are no (further) constraints on this element

Data type

canonical

valueCode

code

There are no (further) constraints on this element

Data type

code

valueCodeableConcept

CodeableConcept

There are no (further) constraints on this element

Data type

CodeableConcept

valueCoding

Coding

There are no (further) constraints on this element

Data type

Coding

valueContactDetail

ContactDetail

There are no (further) constraints on this element

Data type

ContactDetail

valueContactPoint

ContactPoint

There are no (further) constraints on this element

Data type

ContactPoint

valueContributor

Contributor

There are no (further) constraints on this element

Data type

Contributor

valueCount

Count

There are no (further) constraints on this element

Data type

Count

valueDataRequirement

DataRequirement

There are no (further) constraints on this element

Data type

DataRequirement

valueDate

date

There are no (further) constraints on this element

Data type

date

valueDateTime

dateTime

There are no (further) constraints on this element

Data type

dateTime

valueDecimal

decimal

There are no (further) constraints on this element

Data type

decimal

valueDistance

Distance

There are no (further) constraints on this element

Data type

Distance

valueDosage

Dosage

There are no (further) constraints on this element

Data type

Dosage

valueDuration

Duration

There are no (further) constraints on this element

Data type

Duration

valueExpression

Expression

There are no (further) constraints on this element

Data type

Expression

valueHumanName

HumanName

There are no (further) constraints on this element

Data type

HumanName

valueId

There are no (further) constraints on this element

Data type

valueIdentifier

Identifier

There are no (further) constraints on this element

Data type

Identifier

valueInstant

instant

There are no (further) constraints on this element

Data type

instant

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueMeta

Meta

There are no (further) constraints on this element

Data type

Meta

valueMoney

Money

There are no (further) constraints on this element

Data type

Money

valueOid

oid

There are no (further) constraints on this element

Data type

oid

valueParameterDefinition

ParameterDefinition

There are no (further) constraints on this element

Data type

ParameterDefinition

valuePeriod

Period

There are no (further) constraints on this element

Data type

Period

valuePositiveInt

positiveInt

There are no (further) constraints on this element

Data type

positiveInt

valueQuantity

Quantity

There are no (further) constraints on this element

Data type

Quantity

valueRange

Range

There are no (further) constraints on this element

Data type

Range

valueRatio

Ratio

There are no (further) constraints on this element

Data type

Ratio

valueReference

Reference

There are no (further) constraints on this element

Data type

Reference

valueRelatedArtifact

RelatedArtifact

There are no (further) constraints on this element

Data type

RelatedArtifact

valueSampledData

SampledData

There are no (further) constraints on this element

Data type

SampledData

valueSignature

Signature

There are no (further) constraints on this element

Data type

Signature

valueString

string

There are no (further) constraints on this element

Data type

string

valueTime

time

There are no (further) constraints on this element

Data type

time

valueTiming

Timing

There are no (further) constraints on this element

Data type

Timing

valueTriggerDefinition

TriggerDefinition

There are no (further) constraints on this element

Data type

TriggerDefinition

valueUnsignedInt

unsignedInt

There are no (further) constraints on this element

Data type

unsignedInt

valueUri

uri

There are no (further) constraints on this element

Data type

uri

valueUrl

url

There are no (further) constraints on this element

Data type

url

valueUsageContext

UsageContext

There are no (further) constraints on this element

Data type

UsageContext

valueUuid

uuid

There are no (further) constraints on this element

Data type

uuid

system

1..1

uriFixed Value

Element id

Immunization.route.coding:snomedCT.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed value

http://snomed.info/sct

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

Immunization.route.coding:snomedCT.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

code

There are no (further) constraints on this element

Element id

Immunization.route.coding:snomedCT.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

1..1

string

There are no (further) constraints on this element

Element id

Immunization.route.coding:snomedCT.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Immunization.route.coding:snomedCT.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

string

There are no (further) constraints on this element

Element id

Immunization.route.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

doseQuantity

S C

0..1

SimpleQuantity

There are no (further) constraints on this element

Element id

Immunization.doseQuantity

Short description

Amount of vaccine administered

Definition

The quantity of vaccine product that was administered.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

SimpleQuantity

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: RXA-6 / RXA-7
rim: .doseQuantity

performer

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Immunization.performer

Short description

Who performed event

Definition

Indicates who performed the immunization event.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Event.performer
v2: ORC-12 / RXA-10
rim: .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]

0..1

string

There are no (further) constraints on this element

Element id

Immunization.performer.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.performer.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.performer.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

function

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Immunization.performer.function

Short description

What type of performance was done

Definition

Describes the type of performance (e.g. ordering provider, administering provider, etc.).

Comments

Data type

CodeableConcept

Binding

The role a practitioner or organization plays in the immunization event.

ImmunizationFunctionCodes (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.performer.function
rim: .participation.functionCode

actor

Σ C

1..1

Reference(Organization | Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

Immunization.performer.actor

Short description

Individual or organization who was performing

Definition

The practitioner or organization who performed the action.

Comments

When the individual practitioner who performed the action is known, it is best to send.

Data type

Reference(Organization | Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.performer.actor
w5: FiveWs.actor
rim: .player

note

S Σ

0..*

Annotation

There are no (further) constraints on this element

Element id

Immunization.note

Short description

Additional immunization notes

Definition

Extra information about the immunization that is not conveyed by the other attributes.

Comments

For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).

Data type

Annotation

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act
workflow: Event.note
v2: OBX-5 : OBX-3 = 48767-8
rim: note

0..1

string

There are no (further) constraints on this element

Element id

Immunization.note.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.note.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

author[x]

0..1

There are no (further) constraints on this element

Element id

Immunization.note.author[x]

Short description

Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.participant[typeCode=AUT].role

authorReference

Data type

authorString

string

Data type

string

time

0..1

dateTime

There are no (further) constraints on this element

Element id

Immunization.note.time

Short description

When the annotation was made

Definition

Indicates when this particular annotation was made.

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.effectiveTime

text

1..1

markdown

There are no (further) constraints on this element

Element id

Immunization.note.text

Short description

The annotation - text content (as markdown)

Definition

The text of the annotation in markdown format.

Comments

Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/

Data type

markdown

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.text

reasonCode

0..*

CodeableConcept

There are no (further) constraints on this element

Element id

Immunization.reasonCode

Short description

Why immunization occurred

Definition

Reasons why the vaccine was administered.

Comments

Data type

CodeableConcept

Binding

The reason why a vaccine was administered.

ImmunizationReasonCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.reasonCode
rim: [actionNegationInd=false].reasonCode

reasonReference

0..*

Reference(Condition | DiagnosticReport | Observation)

There are no (further) constraints on this element

Element id

Immunization.reasonReference

Short description

Why immunization occurred

Definition

Condition, Observation or DiagnosticReport that supports why the immunization was administered.

Comments

Data type

Reference(Condition | DiagnosticReport | Observation)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.reasonReference
rim: N/A

isSubpotent

Σ ?!

0..1

boolean

There are no (further) constraints on this element

Element id

Immunization.isSubpotent

Short description

Dose potency

Definition

Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.

Comments

Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.

Meaning when missing

By default, a dose should be considered to be potent.

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: RXA-20 = PA (partial administration)
rim: N/A

subpotentReason

0..*

CodeableConcept

There are no (further) constraints on this element

Element id

Immunization.subpotentReason

Short description

Reason for being subpotent

Definition

Reason why a dose is considered to be subpotent.

Comments

Data type

CodeableConcept

Binding

The reason why a dose is considered to be subpotent.

ImmunizationSubpotentReason (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: N/A

education

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Immunization.education

Short description

Educational material presented to patient

Definition

Educational material presented to the patient (or guardian) at the time of vaccine administration.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
imm-1: One of documentType or reference SHALL be present
documentType.exists() or reference.exists()

Mappings

rim: n/a
rim: N/A

0..1

string

There are no (further) constraints on this element

Element id

Immunization.education.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.education.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.education.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

documentType

0..1

string

There are no (further) constraints on this element

Element id

Immunization.education.documentType

Short description

Educational material document identifier

Definition

Identifier of the material presented to the patient.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: OBX-5 : OBX-3 = 69764-9
rim: N/A

reference

0..1

uri

There are no (further) constraints on this element

Element id

Immunization.education.reference

Short description

Educational material reference pointer

Definition

Reference pointer to the educational material given to the patient if the information was on line.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

publicationDate

0..1

dateTime

There are no (further) constraints on this element

Element id

Immunization.education.publicationDate

Short description

Educational material publication date

Definition

Date the educational material was published.

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: OBX-5 : OBX-3 = 29768-9
rim: N/A

presentationDate

0..1

dateTime

There are no (further) constraints on this element

Element id

Immunization.education.presentationDate

Short description

Educational material presentation date

Definition

Date the educational material was given to the patient.

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: OBX-5 : OBX-3 = 29769-7
rim: N/A

programEligibility

0..*

CodeableConcept

There are no (further) constraints on this element

Element id

Immunization.programEligibility

Short description

Patient eligibility for a vaccination program

Definition

Indicates a patient's eligibility for a funding program.

Comments

Data type

CodeableConcept

Binding

The patient's eligibility for a vaccation program.

ImmunizationProgramEligibility (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: OBX-5 : OBX-3 = 64994-7
rim: N/A

fundingSource

0..1

CodeableConcept

There are no (further) constraints on this element

Element id

Immunization.fundingSource

Short description

Funding source for the vaccine

Definition

Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).

Comments

Data type

CodeableConcept

Binding

The source of funding used to purchase the vaccine administered.

ImmunizationFundingSource (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: N/A

reaction

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Immunization.reaction

Short description

Details of a reaction that follows immunization

Definition

Categorical data indicating that an adverse event is associated in time to an immunization.

Comments

A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: OBX-3
rim: Observation[classCode=obs].code

0..1

string

There are no (further) constraints on this element

Element id

Immunization.reaction.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.reaction.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.reaction.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

date

0..1

dateTime

There are no (further) constraints on this element

Element id

Immunization.reaction.date

Short description

When reaction started

Definition

Date of reaction to the immunization.

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the HL7 v2 VXU message - most likely would appear in OBX segments if at all)
rim: .effectiveTime

detail

0..1

Reference(CareConnect-GPC-Observation-1)

Element id

Immunization.reaction.detail

Short description

Additional information on reaction

Definition

Details of the reaction.

Comments

Data type

Reference(CareConnect-GPC-Observation-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: OBX-5
rim: .value

reported

0..1

boolean

There are no (further) constraints on this element

Element id

Immunization.reaction.reported

Short description

Indicates self-reported reaction

Definition

Self-reported indicator.

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (HL7 v2 doesn't seem to provide for this)
rim: .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)

protocolApplied

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Immunization.protocolApplied

Short description

Protocol followed by the provider

Definition

The protocol (set of recommendations) being followed by the provider who administered the dose.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

0..1

string

There are no (further) constraints on this element

Element id

Immunization.protocolApplied.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.protocolApplied.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Immunization.protocolApplied.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

series

0..1

string

There are no (further) constraints on this element

Element id

Immunization.protocolApplied.series

Short description

Name of vaccine series

Definition

One possible path to achieve presumed immunity against a disease - within the context of an authority.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

authority

0..1

Reference(Organization)

There are no (further) constraints on this element

Element id

Immunization.protocolApplied.authority

Short description

Who is responsible for publishing the recommendations

Definition

Indicates the authority who published the protocol (e.g. ACIP) that is being followed.

Comments

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: N/A

targetDisease

0..*

CodeableConcept

There are no (further) constraints on this element

Element id

Immunization.protocolApplied.targetDisease

Short description

Vaccine preventatable disease being targetted

Definition

The vaccine preventable disease the dose is being administered against.

Comments

Data type

CodeableConcept

Binding

The vaccine preventable disease the dose is being administered for.

ImmunizationTargetDiseaseCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: N/A

doseNumber[x]

1..1

There are no (further) constraints on this element

Element id

Immunization.protocolApplied.doseNumber[x]

Short description

Dose number within series

Definition

Nominal position in a series.

Comments

The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

doseNumberPositiveInt

positiveInt

There are no (further) constraints on this element

Data type

positiveInt

doseNumberString

string

There are no (further) constraints on this element

Data type

string

seriesDoses[x]

0..1

There are no (further) constraints on this element

Element id

Immunization.protocolApplied.seriesDoses[x]

Short description

Recommended number of doses for immunity

Definition

The recommended number of doses to achieve immunity.

Comments

The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

seriesDosesPositiveInt

positiveInt

There are no (further) constraints on this element

Data type

positiveInt

seriesDosesString

string

There are no (further) constraints on this element

Data type

string

date

There are no (further) constraints on this element

Element id

Immunization.date

practitioner

There are no (further) constraints on this element

Element id

Immunization.practitioner

explanation

There are no (further) constraints on this element

Element id

Immunization.explanation

vaccinationProtocol

There are no (further) constraints on this element

Element id

Immunization.vaccinationProtocol

Immunization C

Short Immunization event information

Definition

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

Cardinality 0..*

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-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
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
workflow: Event
v2: VXU_V04
rim: SubstanceAdministration

Immunization.id Σ

Short Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality 0..1

Type

Summary True

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Immunization.meta Σ

Short Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Cardinality 0..1

Type

Meta

Summary True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Immunization.meta.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.meta.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.meta.versionId Σ

Short Version specific identifier

Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Cardinality 0..1

Type

Summary True

Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Immunization.meta.lastUpdated Σ

Short When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

Cardinality 0..1

Type

instant

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Immunization.meta.source Σ

Short Identifies where the resource comes from

Definition

Cardinality 0..1

Type

uri

Summary True

Comments

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Immunization.meta.profile Σ

Short Profiles this resource claims to conform to

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Cardinality 1..*

Type canonical(StructureDefinition)

Summary True

Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Immunization.meta.security Σ

Short Security Labels applied to this resource

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Cardinality 0..*

Type

Coding

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

AllSecurityLabels (extensible)

Summary True

Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

Immunization.meta.tag Σ

Short Tags applied to this resource

Definition

Cardinality 0..*

Type

Coding

Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)

Summary True

Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

Immunization.implicitRules Σ ?!

Short A set of rules under which this content was created

Definition

Cardinality 0..1

Type

uri

Modifier True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Immunization.language

Short Language of the resource content

Definition

The base language in which the resource is written.

Cardinality 0..1

Type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

MaxValueSet	AllLanguages

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Immunization.text

Short Text summary of the resource, for human interpretation

Definition

Cardinality 0..1

Type

Narrative

Alias narrative, html, xhtml, display

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

Immunization.contained

Short Contained, inline Resources

Definition

Cardinality 0..*

Type

Resource

Alias inline resources, anonymous resources, contained resources

Comments

Mappings

rim: Entity. Role, or Act
rim: N/A

Immunization.extension C

Short Additional content defined by implementations

Definition

Cardinality 2..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.extension:parentPresent S C

Short Additional content defined by implementations

Definition

Cardinality 0..1

Type

Extension

Must Support True

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.extension:parentPresent.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.extension:parentPresent.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.extension:parentPresent.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Type

uri

Comments

Fixed Value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1

Mappings

rim: N/A

Immunization.extension:parentPresent.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Immunization.extension:recordedDate C

Short The date that the Vaccination was recorded

Definition

Cardinality 1..1

Type

Extension

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.extension:recordedDate.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.extension:recordedDate.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.extension:recordedDate.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Type

uri

Comments

Fixed Value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1

Mappings

rim: N/A

Immunization.extension:recordedDate.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Immunization.extension:vaccinationProcedure C

Short The procedure code describing the vaccine that was administered.

Definition

Cardinality 1..1

Type

Extension

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.extension:vaccinationProcedure.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.extension:vaccinationProcedure.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.extension:vaccinationProcedure.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Type

uri

Comments

Fixed Value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-VaccinationProcedure-1

Mappings

rim: N/A

Immunization.extension:vaccinationProcedure.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 0..1

Type

CodeableConcept

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Immunization.modifierExtension ?! C

Short Extensions that cannot be ignored

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Type

Extension

Modifier True

Alias extensions, user content

Requirements

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.identifier

Short Business identifier

Definition

A unique identifier assigned to this immunization record.

Cardinality 1..*

Type

Identifier

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Event.identifier
w5: FiveWs.identifier
rim: .id
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id

Immunization.identifier.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.identifier.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.identifier.use Σ ?!

Short usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Cardinality 0..1

Type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Modifier True

Summary True

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

Immunization.identifier.type Σ

Short Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Cardinality 0..1

Type

CodeableConcept

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

IdentifierTypeCodes (extensible)

Summary True

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

Immunization.identifier.system Σ

Short The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality 1..1

Type

uri

Summary True

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples

General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

Immunization.identifier.value Σ

Short The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality 1..1

Type

string

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples

General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

Immunization.identifier.period Σ C

Short Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Cardinality 0..1

Type

Period

Summary True

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

Immunization.identifier.assigner Σ C

Short Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Cardinality 0..1

Type Reference(CareConnect-GPC-Organization-1)

Summary True

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

Immunization.status Σ ?!

Short completed

Definition

Indicates the current status of the immunization event.

Cardinality 1..1

Type

code

Binding

A set of codes indicating the current status of an Immunization.

ImmunizationStatusCodes (required)

Modifier True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed Value

completed

Mappings

rim: n/a
workflow: Event.status
w5: FiveWs.status
rim: statusCode

Immunization.statusReason

Short Reason not done

Definition

Indicates the reason the immunization event was not performed.

Cardinality 0..1

Type

CodeableConcept

Binding

The reason why a vaccine was not administered.

ImmunizationStatusReasonCodes (example)

Comments

This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.statusReason
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde

Immunization.vaccineCode Σ

Short Vaccine product administered

Definition

Vaccine that was administered or was to be administered.

Cardinality 1..1

Type

CodeableConcept

Binding

The code for vaccine product administered.

VaccineAdministeredValueSet (extensible)

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.code
w5: FiveWs.what[x]
v2: RXA-5
rim: .code
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code

Immunization.vaccineCode.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.vaccineCode.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.vaccineCode.coding Σ

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..*

Type

Coding

Summary True

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Slicing

Unordered, Open, by system(Value)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Immunization.vaccineCode.coding:snomedCT Σ

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..1

Type

Coding

Summary True

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Immunization.vaccineCode.coding:snomedCT.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.vaccineCode.coding:snomedCT.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID C

Short The SNOMED CT Description ID for the display

Definition

The SNOMED CT Description ID for the display.

Cardinality 0..1

Type Extension(Complex)

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension C

Short Additional content defined by implementations

Definition

Cardinality 1..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId C

Short The SNOMED CT Description ID

Definition

Cardinality 1..1

Type

Extension

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..0

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Type

uri

Comments

Fixed Value

descriptionId

Mappings

rim: N/A

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionId.value[x]

Short The SNOMED CT Description ID

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 0..1

Type

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay C

Short The SNOMED CT display for the description ID

Definition

Cardinality 0..1

Type

Extension

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..0

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Type

uri

Comments

Fixed Value

descriptionDisplay

Mappings

rim: N/A

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension:descriptionDisplay.value[x]

Short The SNOMED CT display for the description ID

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 0..1

Type

string

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Type

uri

Comments

Fixed Value

https://fhir.nhs.uk/STU3/StructureDefinition/Extension-coding-sctdescid

Mappings

rim: N/A

Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 0..0

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Immunization.vaccineCode.coding:snomedCT.system Σ

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 1..1

Type

uri

Summary True

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed Value

http://snomed.info/sct

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Immunization.vaccineCode.coding:snomedCT.version Σ

Short Version of the system - if relevant

Definition

Cardinality 0..0

Type

string

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

Immunization.vaccineCode.coding:snomedCT.code Σ

Short Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality 1..1

Type

code

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Immunization.vaccineCode.coding:snomedCT.display Σ

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 1..1

Type

string

Summary True

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

Immunization.vaccineCode.coding:snomedCT.userSelected Σ

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality 0..1

Type

boolean

Summary True

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

Immunization.vaccineCode.text Σ

Short Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality 0..1

Type

string

Summary True

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

Immunization.patient Σ C

Short Who was immunized

Definition

The patient who either received or did not receive the immunization.

Cardinality 1..1

Type Reference(CareConnect-GPC-Patient-1)

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.subject
w5: FiveWs.subject[x]
v2: PID-3
rim: .partipication[ttypeCode=].role
w5: FiveWs.subject

Immunization.encounter S C

Short Encounter immunization was part of

Definition

The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

Cardinality 0..1

Type Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1)

Must Support True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.context
w5: FiveWs.context
v2: PV1-19
rim: component->EncounterEvent

Immunization.occurrence[x] Σ

Short Vaccine administration date

Definition

Date vaccine administered or was to be administered.

Cardinality 1..1

Type dateTime | string

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Event.occurrence[x]
w5: FiveWs.done[x]
v2: RXA-3
rim: .effectiveTime
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value

Immunization.recorded

Short When the immunization was first captured in the subject's record

Definition

The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.

Cardinality 0..1

Type

dateTime

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.recorded
rim: .participation[typeCode=AUT].time

Immunization.primarySource Σ

Short Indicates context the data was recorded in

Definition

An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.

Cardinality 0..1

Type

boolean

Summary True

Comments

Reflects the “reliability” of the content.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Default value

true

Mappings

rim: n/a
w5: FiveWs.source
v2: RXA-9
rim: immunization.uncertaintycode (if primary source=false, uncertainty=U)

Immunization.reportOrigin S

Short Indicates the source of a secondarily reported record

Definition

The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.

Cardinality 0..1

Type

CodeableConcept

Binding

The source of the data for a record which is not from a primary source.

ImmunizationOriginCodes (example)

Must Support True

Comments

Should not be populated if primarySource = True, not required even if primarySource = False.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.source
v2: RXA-9
rim: .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported) .participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional) .participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)

Immunization.location S C

Short Where immunization occurred

Definition

The service delivery location where the vaccine administration occurred.

Cardinality 0..1

Type Reference(CareConnect-GPC-Location-1)

Must Support True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.location
w5: FiveWs.where[x]
v2: RXA-27 (or RXA-11, deprecated as of v2.7)
rim: .participation[typeCode=LOC].COCT_MT240000UV

Immunization.manufacturer S C

Short Vaccine manufacturer

Definition

Name of vaccine manufacturer.

Cardinality 0..1

Type Reference(CareConnect-GPC-Organization-1)

Must Support True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: RXA-17
rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name

Immunization.lotNumber S

Short Vaccine lot number

Definition

Lot number of the vaccine product.

Cardinality 0..1

Type

string

Must Support True

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: RXA-15
rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText

Immunization.expirationDate S

Short Vaccine expiration date

Definition

Date vaccine batch expires.

Cardinality 0..1

Type

date

Must Support True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: RXA-16
rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime

Immunization.site S

Short Body site vaccine was administered

Definition

Body site where vaccine was administered.

Cardinality 0..1

Type

CodeableConcept

Binding

The site at which the vaccine was administered.

CodesForImmunizationSiteOfAdministration (example)

Must Support True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: RXR-2
rim: observation.targetSiteCode
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code

Immunization.site.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.site.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.site.coding Σ

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..*

Type

Coding

Summary True

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Slicing

Unordered, Open, by system(Value)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Immunization.site.coding:snomedCT Σ

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..1

Type

Coding

Summary True

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Immunization.site.coding:snomedCT.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.site.coding:snomedCT.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.site.coding:snomedCT.extension:snomedCTDescriptionID C

Short Additional content defined by implementations

Definition

Cardinality 0..1

Type

Extension

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.site.coding:snomedCT.extension:snomedCTDescriptionID.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.site.coding:snomedCT.extension:snomedCTDescriptionID.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.site.coding:snomedCT.extension:snomedCTDescriptionID.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Type

uri

Comments

Fixed Value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid

Mappings

rim: N/A

Immunization.site.coding:snomedCT.extension:snomedCTDescriptionID.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Immunization.site.coding:snomedCT.system Σ

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 1..1

Type

uri

Summary True

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed Value

http://snomed.info/sct

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Immunization.site.coding:snomedCT.version Σ

Short Version of the system - if relevant

Definition

Cardinality 0..1

Type

string

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

Immunization.site.coding:snomedCT.code Σ

Short Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality 1..1

Type

code

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Immunization.site.coding:snomedCT.display Σ

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 1..1

Type

string

Summary True

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

Immunization.site.coding:snomedCT.userSelected Σ

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality 0..1

Type

boolean

Summary True

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

Immunization.site.text Σ

Short Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality 0..1

Type

string

Summary True

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

Immunization.route S

Short How vaccine entered body

Definition

The path by which the vaccine product is taken into the body.

Cardinality 0..1

Type

CodeableConcept

Binding

The route by which the vaccine was administered.

ImmunizationRouteCodes (example)

Must Support True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: RXR-1
rim: .routeCode
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code

Immunization.route.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.route.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.route.coding Σ

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..*

Type

Coding

Summary True

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Slicing

Unordered, Open, by system(Value)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Immunization.route.coding:snomedCT Σ

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..1

Type

Coding

Binding

A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration.

(unbound) (example)

Summary True

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Immunization.route.coding:snomedCT.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.route.coding:snomedCT.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.route.coding:snomedCT.extension:snomedCTDescriptionID C

Short Additional content defined by implementations

Definition

Cardinality 0..1

Type

Extension

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.route.coding:snomedCT.extension:snomedCTDescriptionID.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.route.coding:snomedCT.extension:snomedCTDescriptionID.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.route.coding:snomedCT.extension:snomedCTDescriptionID.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Type

uri

Comments

Fixed Value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid

Mappings

rim: N/A

Immunization.route.coding:snomedCT.extension:snomedCTDescriptionID.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Immunization.route.coding:snomedCT.system Σ

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 1..1

Type

uri

Summary True

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Fixed Value

http://snomed.info/sct

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Immunization.route.coding:snomedCT.version Σ

Short Version of the system - if relevant

Definition

Cardinality 0..1

Type

string

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

Immunization.route.coding:snomedCT.code Σ

Short Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality 1..1

Type

code

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Immunization.route.coding:snomedCT.display Σ

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 1..1

Type

string

Summary True

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

Immunization.route.coding:snomedCT.userSelected Σ

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality 0..1

Type

boolean

Summary True

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

Immunization.route.text Σ

Short Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality 0..1

Type

string

Summary True

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

Immunization.doseQuantity S C

Short Amount of vaccine administered

Definition

The quantity of vaccine product that was administered.

Cardinality 0..1

Type

SimpleQuantity

Must Support True

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: RXA-6 / RXA-7
rim: .doseQuantity

Immunization.performer Σ

Short Who performed event

Definition

Indicates who performed the immunization event.

Cardinality 0..*

Type

BackboneElement

Summary True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Event.performer
v2: ORC-12 / RXA-10
rim: .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]

Immunization.performer.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.performer.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.performer.modifierExtension Σ ?! C

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Type

Extension

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.performer.function Σ

Short What type of performance was done

Definition

Describes the type of performance (e.g. ordering provider, administering provider, etc.).

Cardinality 0..1

Type

CodeableConcept

Binding

The role a practitioner or organization plays in the immunization event.

ImmunizationFunctionCodes (extensible)

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.performer.function
rim: .participation.functionCode

Immunization.performer.actor Σ C

Short Individual or organization who was performing

Definition

The practitioner or organization who performed the action.

Cardinality 1..1

Type Reference(Organization | Practitioner | PractitionerRole)

Summary True

Comments

When the individual practitioner who performed the action is known, it is best to send.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.performer.actor
w5: FiveWs.actor
rim: .player

Immunization.note S Σ

Short Additional immunization notes

Definition

Extra information about the immunization that is not conveyed by the other attributes.

Cardinality 0..*

Type

Annotation

Must Support True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act
workflow: Event.note
v2: OBX-5 : OBX-3 = 48767-8
rim: note

Immunization.note.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.note.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.note.author[x] Σ

Short Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Cardinality 0..1

Type Reference(RelatedPerson) | Reference(CareConnect-GPC-Practitioner-1) | Reference(CareConnect-GPC-Patient-1) | string

Summary True

Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.participant[typeCode=AUT].role

Immunization.note.time Σ

Short When the annotation was made

Definition

Indicates when this particular annotation was made.

Cardinality 0..1

Type

dateTime

Summary True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.effectiveTime

Immunization.note.text Σ

Short The annotation - text content (as markdown)

Definition

The text of the annotation in markdown format.

Cardinality 1..1

Type

markdown

Summary True

Comments

Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.text

Immunization.reasonCode

Short Why immunization occurred

Definition

Reasons why the vaccine was administered.

Cardinality 0..*

Type

CodeableConcept

Binding

The reason why a vaccine was administered.

ImmunizationReasonCodes (example)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.reasonCode
rim: [actionNegationInd=false].reasonCode

Immunization.reasonReference C

Short Why immunization occurred

Definition

Condition, Observation or DiagnosticReport that supports why the immunization was administered.

Cardinality 0..*

Type Reference(Condition | DiagnosticReport | Observation)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.reasonReference
rim: N/A

Immunization.isSubpotent Σ ?!

Short Dose potency

Definition

Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.

Cardinality 0..1

Type

boolean

Modifier True

Summary True

Comments

Meaning when missing

By default, a dose should be considered to be potent.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: RXA-20 = PA (partial administration)
rim: N/A

Immunization.subpotentReason

Short Reason for being subpotent

Definition

Reason why a dose is considered to be subpotent.

Cardinality 0..*

Type

CodeableConcept

Binding

The reason why a dose is considered to be subpotent.

ImmunizationSubpotentReason (example)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: N/A

Immunization.education C

Short Educational material presented to patient

Definition

Educational material presented to the patient (or guardian) at the time of vaccine administration.

Cardinality 0..*

Type

BackboneElement

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
imm-1: One of documentType or reference SHALL be present
documentType.exists() or reference.exists()

Mappings

rim: n/a
rim: N/A

Immunization.education.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.education.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.education.modifierExtension Σ ?! C

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Type

Extension

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.education.documentType

Short Educational material document identifier

Definition

Identifier of the material presented to the patient.

Cardinality 0..1

Type

string

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: OBX-5 : OBX-3 = 69764-9
rim: N/A

Immunization.education.reference

Short Educational material reference pointer

Definition

Reference pointer to the educational material given to the patient if the information was on line.

Cardinality 0..1

Type

uri

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Immunization.education.publicationDate

Short Educational material publication date

Definition

Date the educational material was published.

Cardinality 0..1

Type

dateTime

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: OBX-5 : OBX-3 = 29768-9
rim: N/A

Immunization.education.presentationDate

Short Educational material presentation date

Definition

Date the educational material was given to the patient.

Cardinality 0..1

Type

dateTime

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: OBX-5 : OBX-3 = 29769-7
rim: N/A

Immunization.programEligibility

Short Patient eligibility for a vaccination program

Definition

Indicates a patient's eligibility for a funding program.

Cardinality 0..*

Type

CodeableConcept

Binding

The patient's eligibility for a vaccation program.

ImmunizationProgramEligibility (example)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: OBX-5 : OBX-3 = 64994-7
rim: N/A

Immunization.fundingSource

Short Funding source for the vaccine

Definition

Cardinality 0..1

Type

CodeableConcept

Binding

The source of funding used to purchase the vaccine administered.

ImmunizationFundingSource (example)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: N/A

Immunization.reaction

Short Details of a reaction that follows immunization

Definition

Categorical data indicating that an adverse event is associated in time to an immunization.

Cardinality 0..*

Type

BackboneElement

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: OBX-3
rim: Observation[classCode=obs].code

Immunization.reaction.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.reaction.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.reaction.modifierExtension Σ ?! C

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Type

Extension

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.reaction.date

Short When reaction started

Definition

Date of reaction to the immunization.

Cardinality 0..1

Type

dateTime

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the HL7 v2 VXU message - most likely would appear in OBX segments if at all)
rim: .effectiveTime

Immunization.reaction.detail C

Short Additional information on reaction

Definition

Details of the reaction.

Cardinality 0..1

Type Reference(CareConnect-GPC-Observation-1)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: OBX-5
rim: .value

Immunization.reaction.reported

Short Indicates self-reported reaction

Definition

Self-reported indicator.

Cardinality 0..1

Type

boolean

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: (HL7 v2 doesn't seem to provide for this)
rim: .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)

Immunization.protocolApplied

Short Protocol followed by the provider

Definition

The protocol (set of recommendations) being followed by the provider who administered the dose.

Cardinality 0..*

Type

BackboneElement

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Immunization.protocolApplied.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Type

string

Mappings

rim: n/a

Immunization.protocolApplied.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.protocolApplied.modifierExtension Σ ?! C

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Type

Extension

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Immunization.protocolApplied.series

Short Name of vaccine series

Definition

One possible path to achieve presumed immunity against a disease - within the context of an authority.

Cardinality 0..1

Type

string

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Immunization.protocolApplied.authority C

Short Who is responsible for publishing the recommendations

Definition

Indicates the authority who published the protocol (e.g. ACIP) that is being followed.

Cardinality 0..1

Type Reference(Organization)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: N/A

Immunization.protocolApplied.targetDisease

Short Vaccine preventatable disease being targetted

Definition

The vaccine preventable disease the dose is being administered against.

Cardinality 0..*

Type

CodeableConcept

Binding

The vaccine preventable disease the dose is being administered for.

ImmunizationTargetDiseaseCodes (example)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: N/A

Immunization.protocolApplied.doseNumber[x]

Short Dose number within series

Definition

Nominal position in a series.

Cardinality 1..1

Type positiveInt | string

Comments

The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Immunization.protocolApplied.seriesDoses[x]

Short Recommended number of doses for immunity

Definition

The recommended number of doses to achieve immunity.

Cardinality 0..1

Type positiveInt | string

Comments

The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Immunization.date S

Must Support True

Immunization.practitioner S

Must Support True

Immunization.explanation

Immunization.vaccinationProtocol

<meta>
<lastUpdated value="2026-10-29T16:51:45.8049093+00:00" />
</meta>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="pher" />
</extension>
<url value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Immunization-1" />
<version value="1.5.0" />
<name value="CareConnect-GPC-Immunization-1" />
<status value="draft" />
<date value="2020-02-17" />
<publisher value="HL7 UK" />
<contact>
<name value="INTEROPen" />
<telecom>
<system value="email" />
<value value="admin@interopen.org" />
<use value="work" />
</telecom>
</contact>
<description value="This Immunization Resource 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 and may include vaccine reaction information and what vaccination protocol was followed." />
<purpose value="CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/" />
<copyright value="Copyright © 2020 HL7 UK\n\nLicensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n\nHL7® FHIR® standard Copyright © 2011+ HL7\n\nThe HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at\n\nhttps://www.hl7.org/fhir/license.html" />
<fhirVersion value="3.0.2" />
<kind value="resource" />
<abstract value="false" />
<type value="Immunization" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Immunization" />
<derivation value="constraint" />
<differential>
<element id="Immunization.meta">
<path value="Immunization.meta" />
</element>
<element id="Immunization.meta.profile">
<path value="Immunization.meta.profile" />
<min value="1" />
</element>
<element id="Immunization.extension">
<path value="Immunization.extension" />
<min value="2" />
</element>
<element id="Immunization.extension:parentPresent">
<path value="Immunization.extension" />
<sliceName value="parentPresent" />
<max value="1" />
<type>
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1" />
</type>
<mustSupport value="true" />
</element>
<element id="Immunization.extension:parentPresent.url">
<path value="Immunization.extension.url" />
<fixedUri value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1" />
</element>
<element id="Immunization.extension:recordedDate">
<path value="Immunization.extension" />
<sliceName value="recordedDate" />
<short value="The date that the Vaccination was recorded" />
<min value="1" />
<max value="1" />
<type>
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1" />
</type>
</element>
<element id="Immunization.extension:recordedDate.url">
<path value="Immunization.extension.url" />
<fixedUri value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1" />
</element>
<element id="Immunization.extension:vaccinationProcedure">
<path value="Immunization.extension" />
<sliceName value="vaccinationProcedure" />
<short value="The procedure code describing the vaccine that was administered." />
<min value="1" />
<max value="1" />
<type>
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-VaccinationProcedure-1" />
</type>
</element>
<element id="Immunization.extension:vaccinationProcedure.url">
<path value="Immunization.extension.url" />
<fixedUri value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-VaccinationProcedure-1" />
</element>
<element id="Immunization.extension:vaccinationProcedure.value[x]">
<path value="Immunization.extension.value[x]" />
<type>
<code value="CodeableConcept" />
</type>
</element>
<element id="Immunization.identifier">
<path value="Immunization.identifier" />
<min value="1" />
</element>
<element id="Immunization.identifier.system">
<path value="Immunization.identifier.system" />
<min value="1" />
</element>
<element id="Immunization.identifier.value">
<path value="Immunization.identifier.value" />
<min value="1" />
</element>
<element id="Immunization.identifier.assigner">
<path value="Immunization.identifier.assigner" />
<type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1" />
</type>
</element>
<element id="Immunization.status">
<path value="Immunization.status" />
<short value="completed" />
<fixedCode value="completed" />
</element>
<element id="Immunization.vaccineCode">
<path value="Immunization.vaccineCode" />
<binding>
<strength value="extensible" />
</binding>
</element>
<element id="Immunization.vaccineCode.coding">
<path value="Immunization.vaccineCode.coding" />
<slicing>
<discriminator>
<type value="value" />
<path value="system" />
</discriminator>
<rules value="open" />
</slicing>
</element>
<element id="Immunization.vaccineCode.coding:snomedCT">
<path value="Immunization.vaccineCode.coding" />
<sliceName value="snomedCT" />
<max value="1" />
</element>
<element id="Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID">
<path value="Immunization.vaccineCode.coding.extension" />
<sliceName value="snomedCTDescriptionID" />
<type>
<code value="Extension" />
<profile value="https://fhir.nhs.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</type>
</element>
<element id="Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension">
<path value="Immunization.vaccineCode.coding.extension.extension" />
<min value="1" />
</element>
<element id="Immunization.vaccineCode.coding:snomedCT.system">
<path value="Immunization.vaccineCode.coding.system" />
<min value="1" />
<fixedUri value="http://snomed.info/sct" />
</element>
<element id="Immunization.vaccineCode.coding:snomedCT.version">
<path value="Immunization.vaccineCode.coding.version" />
<max value="0" />
</element>
<element id="Immunization.vaccineCode.coding:snomedCT.code">
<path value="Immunization.vaccineCode.coding.code" />
<min value="1" />
</element>
<element id="Immunization.vaccineCode.coding:snomedCT.display">
<path value="Immunization.vaccineCode.coding.display" />
<min value="1" />
</element>
<element id="Immunization.patient">
<path value="Immunization.patient" />
<type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1" />
</type>
</element>
<element id="Immunization.encounter">
<path value="Immunization.encounter" />
<type>
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1" />
</type>
<mustSupport value="true" />
</element>
<element id="Immunization.date">
<path value="Immunization.date" />
<mustSupport value="true" />
</element>
<element id="Immunization.primarySource">
<path value="Immunization.primarySource" />
<defaultValueBoolean value="true" />
</element>
<element id="Immunization.reportOrigin">
<path value="Immunization.reportOrigin" />
<mustSupport value="true" />
</element>
<element id="Immunization.location">
<path value="Immunization.location" />
<type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Location-1" />
</type>
<mustSupport value="true" />
</element>
<element id="Immunization.manufacturer">
<path value="Immunization.manufacturer" />
<type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1" />
</type>
<mustSupport value="true" />
</element>
<element id="Immunization.lotNumber">
<path value="Immunization.lotNumber" />
<mustSupport value="true" />
</element>
<element id="Immunization.expirationDate">
<path value="Immunization.expirationDate" />
<mustSupport value="true" />
</element>
<element id="Immunization.site">
<path value="Immunization.site" />
<mustSupport value="true" />
</element>
<element id="Immunization.site.coding">
<path value="Immunization.site.coding" />
<slicing>
<discriminator>
<type value="value" />
<path value="system" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
</element>
<element id="Immunization.site.coding:snomedCT">
<path value="Immunization.site.coding" />
<sliceName value="snomedCT" />
<max value="1" />
</element>
<element id="Immunization.site.coding:snomedCT.extension:snomedCTDescriptionID">
<path value="Immunization.site.coding.extension" />
<sliceName value="snomedCTDescriptionID" />
<max value="1" />
<type>
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</type>
</element>
<element id="Immunization.site.coding:snomedCT.extension:snomedCTDescriptionID.url">
<path value="Immunization.site.coding.extension.url" />
<fixedUri value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</element>
<element id="Immunization.site.coding:snomedCT.system">
<path value="Immunization.site.coding.system" />
<min value="1" />
<fixedUri value="http://snomed.info/sct" />
</element>
<element id="Immunization.site.coding:snomedCT.code">
<path value="Immunization.site.coding.code" />
<min value="1" />
</element>
<element id="Immunization.site.coding:snomedCT.display">
<path value="Immunization.site.coding.display" />
<min value="1" />
</element>
<element id="Immunization.route">
<path value="Immunization.route" />
<mustSupport value="true" />
</element>
<element id="Immunization.route.coding">
<path value="Immunization.route.coding" />
<slicing>
<discriminator>
<type value="value" />
<path value="system" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
</element>
<element id="Immunization.route.coding:snomedCT">
<path value="Immunization.route.coding" />
<sliceName value="snomedCT" />
<max value="1" />
<binding>
<strength value="example" />
<description value="A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration." />
</binding>
</element>
<element id="Immunization.route.coding:snomedCT.extension:snomedCTDescriptionID">
<path value="Immunization.route.coding.extension" />
<sliceName value="snomedCTDescriptionID" />
<max value="1" />
<type>
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</type>
</element>
<element id="Immunization.route.coding:snomedCT.extension:snomedCTDescriptionID.url">
<path value="Immunization.route.coding.extension.url" />
<fixedUri value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</element>
<element id="Immunization.route.coding:snomedCT.system">
<path value="Immunization.route.coding.system" />
<min value="1" />
<fixedUri value="http://snomed.info/sct" />
</element>
<element id="Immunization.route.coding:snomedCT.code">
<path value="Immunization.route.coding.code" />
<min value="1" />
</element>
<element id="Immunization.route.coding:snomedCT.display">
<path value="Immunization.route.coding.display" />
<min value="1" />
</element>
<element id="Immunization.doseQuantity">
<path value="Immunization.doseQuantity" />
<mustSupport value="true" />
</element>
<element id="Immunization.practitioner">
<path value="Immunization.practitioner" />
<mustSupport value="true" />
</element>
<element id="Immunization.practitioner.role">
<path value="Immunization.practitioner.role" />
<mustSupport value="true" />
</element>
<element id="Immunization.practitioner.actor">
<path value="Immunization.practitioner.actor" />
<type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1" />
</type>
</element>
<element id="Immunization.note">
<path value="Immunization.note" />
<mustSupport value="true" />
</element>
<element id="Immunization.note.author[x]">
<path value="Immunization.note.author[x]" />
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
</type>
<type>
<code value="string" />
</type>
<type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1" />
</type>
<type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1" />
</type>
</element>
<element id="Immunization.explanation.reason">
<path value="Immunization.explanation.reason" />
<mustSupport value="true" />
<binding>
<strength value="example" />
</binding>
</element>
<element id="Immunization.explanation.reasonNotGiven">
<path value="Immunization.explanation.reasonNotGiven" />
<mustSupport value="true" />
<binding>
<strength value="extensible" />
</binding>
</element>
<element id="Immunization.reaction.detail">
<path value="Immunization.reaction.detail" />
<type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Observation-1" />
</type>
</element>
<element id="Immunization.vaccinationProtocol.doseSequence">
<path value="Immunization.vaccinationProtocol.doseSequence" />
<min value="1" />
</element>
<element id="Immunization.vaccinationProtocol.description">
<path value="Immunization.vaccinationProtocol.description" />
<mustSupport value="true" />
</element>
<element id="Immunization.vaccinationProtocol.authority">
<path value="Immunization.vaccinationProtocol.authority" />
<type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1" />
</type>
</element>
<element id="Immunization.vaccinationProtocol.seriesDoses">
<path value="Immunization.vaccinationProtocol.seriesDoses" />
<mustSupport value="true" />
</element>
<element id="Immunization.vaccinationProtocol.targetDisease.coding">
<path value="Immunization.vaccinationProtocol.targetDisease.coding" />
<slicing>
<discriminator>
<type value="value" />
<path value="system" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
</element>
<element id="Immunization.vaccinationProtocol.targetDisease.coding:snomedCT">
<path value="Immunization.vaccinationProtocol.targetDisease.coding" />
<sliceName value="snomedCT" />
<max value="1" />
</element>
<element id="Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.extension:snomedCTDescriptionID">
<path value="Immunization.vaccinationProtocol.targetDisease.coding.extension" />
<sliceName value="snomedCTDescriptionID" />
<max value="1" />
<type>
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</type>
</element>
<element id="Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.extension:snomedCTDescriptionID.url">
<path value="Immunization.vaccinationProtocol.targetDisease.coding.extension.url" />
<fixedUri value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</element>
<element id="Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.system">
<path value="Immunization.vaccinationProtocol.targetDisease.coding.system" />
<min value="1" />
<fixedUri value="http://snomed.info/sct" />
</element>
<element id="Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.code">
<path value="Immunization.vaccinationProtocol.targetDisease.coding.code" />
<min value="1" />
</element>
<element id="Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.display">
<path value="Immunization.vaccinationProtocol.targetDisease.coding.display" />
<min value="1" />
</element>
<element id="Immunization.vaccinationProtocol.doseStatus.coding.system">
<path value="Immunization.vaccinationProtocol.doseStatus.coding.system" />
<min value="1" />
</element>
<element id="Immunization.vaccinationProtocol.doseStatus.coding.code">
<path value="Immunization.vaccinationProtocol.doseStatus.coding.code" />
<min value="1" />
<fixedCode value="count" />
</element>
<element id="Immunization.vaccinationProtocol.doseStatus.coding.display">
<path value="Immunization.vaccinationProtocol.doseStatus.coding.display" />
<min value="1" />
</element>
</differential>

</StructureDefinition>

{

"resourceType": "StructureDefinition",
"meta": {
"lastUpdated": "2026-10-29T16:51:45.8049093+00:00"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "pher"
}
],
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Immunization-1",
"version": "1.5.0",
"name": "CareConnect-GPC-Immunization-1",
"status": "draft",
"date": "2020-02-17",
"publisher": "HL7 UK",
"contact": [
{
"name": "INTEROPen",
"telecom": [
{
"system": "email",
"value": "admin@interopen.org",
"use": "work"
}
]
}
],
"description": "This Immunization Resource 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 and may include vaccine reaction information and what vaccination protocol was followed.",
"purpose": "CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/",
"copyright": "Copyright © 2020 HL7 UK\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n\nHL7® FHIR® standard Copyright © 2011+ HL7\n\nThe HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at\n\nhttps://www.hl7.org/fhir/license.html",
"fhirVersion": "3.0.2",
"kind": "resource",
"abstract": false,
"type": "Immunization",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Immunization.meta",
"path": "Immunization.meta"
},
{
"id": "Immunization.meta.profile",
"path": "Immunization.meta.profile",
"min": 1
},
{
"id": "Immunization.extension",
"path": "Immunization.extension",
"min": 2
},
{
"id": "Immunization.extension:parentPresent",
"path": "Immunization.extension",
"sliceName": "parentPresent",
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1"
]
}
],
"mustSupport": true
},
{
"id": "Immunization.extension:parentPresent.url",
"path": "Immunization.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1"
},
{
"id": "Immunization.extension:recordedDate",
"path": "Immunization.extension",
"sliceName": "recordedDate",
"short": "The date that the Vaccination was recorded",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1"
]
}
]
},
{
"id": "Immunization.extension:recordedDate.url",
"path": "Immunization.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1"
},
{
"id": "Immunization.extension:vaccinationProcedure",
"path": "Immunization.extension",
"sliceName": "vaccinationProcedure",
"short": "The procedure code describing the vaccine that was administered.",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-VaccinationProcedure-1"
]
}
]
},
{
"id": "Immunization.extension:vaccinationProcedure.url",
"path": "Immunization.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-VaccinationProcedure-1"
},
{
"id": "Immunization.extension:vaccinationProcedure.value[x]",
"path": "Immunization.extension.value[x]",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "Immunization.identifier",
"path": "Immunization.identifier",
"min": 1
},
{
"id": "Immunization.identifier.system",
"path": "Immunization.identifier.system",
"min": 1
},
{
"id": "Immunization.identifier.value",
"path": "Immunization.identifier.value",
"min": 1
},
{
"id": "Immunization.identifier.assigner",
"path": "Immunization.identifier.assigner",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1"
]
}
]
},
{
"id": "Immunization.status",
"path": "Immunization.status",
"short": "completed",
"fixedCode": "completed"
},
{
"id": "Immunization.vaccineCode",
"path": "Immunization.vaccineCode",
"binding": {
"valueSetReference": {
"reference": "https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-VaccineCode-1"
},
"strength": "extensible"
}
},
{
"id": "Immunization.vaccineCode.coding",
"path": "Immunization.vaccineCode.coding",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "system"
}
],
"rules": "open"
}
},
{
"id": "Immunization.vaccineCode.coding:snomedCT",
"path": "Immunization.vaccineCode.coding",
"sliceName": "snomedCT",
"max": "1"
},
{
"id": "Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID",
"path": "Immunization.vaccineCode.coding.extension",
"sliceName": "snomedCTDescriptionID",
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
]
}
]
},
{
"id": "Immunization.vaccineCode.coding:snomedCT.extension:snomedCTDescriptionID.extension",
"path": "Immunization.vaccineCode.coding.extension.extension",
"min": 1
},
{
"id": "Immunization.vaccineCode.coding:snomedCT.system",
"path": "Immunization.vaccineCode.coding.system",
"min": 1,
"fixedUri": "http://snomed.info/sct"
},
{
"id": "Immunization.vaccineCode.coding:snomedCT.version",
"path": "Immunization.vaccineCode.coding.version",
"max": "0"
},
{
"id": "Immunization.vaccineCode.coding:snomedCT.code",
"path": "Immunization.vaccineCode.coding.code",
"min": 1
},
{
"id": "Immunization.vaccineCode.coding:snomedCT.display",
"path": "Immunization.vaccineCode.coding.display",
"min": 1
},
{
"id": "Immunization.patient",
"path": "Immunization.patient",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1"
]
}
]
},
{
"id": "Immunization.encounter",
"path": "Immunization.encounter",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1"
]
}
],
"mustSupport": true
},
{
"id": "Immunization.date",
"path": "Immunization.date",
"mustSupport": true
},
{
"id": "Immunization.primarySource",
"path": "Immunization.primarySource",
"defaultValueBoolean": true
},
{
"id": "Immunization.reportOrigin",
"path": "Immunization.reportOrigin",
"mustSupport": true
},
{
"id": "Immunization.location",
"path": "Immunization.location",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Location-1"
]
}
],
"mustSupport": true
},
{
"id": "Immunization.manufacturer",
"path": "Immunization.manufacturer",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1"
]
}
],
"mustSupport": true
},
{
"id": "Immunization.lotNumber",
"path": "Immunization.lotNumber",
"mustSupport": true
},
{
"id": "Immunization.expirationDate",
"path": "Immunization.expirationDate",
"mustSupport": true
},
{
"id": "Immunization.site",
"path": "Immunization.site",
"mustSupport": true
},
{
"id": "Immunization.site.coding",
"path": "Immunization.site.coding",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "system"
}
],
"ordered": false,
"rules": "open"
}
},
{
"id": "Immunization.site.coding:snomedCT",
"path": "Immunization.site.coding",
"sliceName": "snomedCT",
"max": "1"
},
{
"id": "Immunization.site.coding:snomedCT.extension:snomedCTDescriptionID",
"path": "Immunization.site.coding.extension",
"sliceName": "snomedCTDescriptionID",
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
]
}
]
},
{
"id": "Immunization.site.coding:snomedCT.extension:snomedCTDescriptionID.url",
"path": "Immunization.site.coding.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
},
{
"id": "Immunization.site.coding:snomedCT.system",
"path": "Immunization.site.coding.system",
"min": 1,
"fixedUri": "http://snomed.info/sct"
},
{
"id": "Immunization.site.coding:snomedCT.code",
"path": "Immunization.site.coding.code",
"min": 1
},
{
"id": "Immunization.site.coding:snomedCT.display",
"path": "Immunization.site.coding.display",
"min": 1
},
{
"id": "Immunization.route",
"path": "Immunization.route",
"mustSupport": true
},
{
"id": "Immunization.route.coding",
"path": "Immunization.route.coding",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "system"
}
],
"ordered": false,
"rules": "open"
}
},
{
"id": "Immunization.route.coding:snomedCT",
"path": "Immunization.route.coding",
"sliceName": "snomedCT",
"max": "1",
"binding": {
"valueSetReference": {
"reference": "https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-MedicationDosageRoute-1"
},
"strength": "example",
"description": "A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration."
}
},
{
"id": "Immunization.route.coding:snomedCT.extension:snomedCTDescriptionID",
"path": "Immunization.route.coding.extension",
"sliceName": "snomedCTDescriptionID",
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
]
}
]
},
{
"id": "Immunization.route.coding:snomedCT.extension:snomedCTDescriptionID.url",
"path": "Immunization.route.coding.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
},
{
"id": "Immunization.route.coding:snomedCT.system",
"path": "Immunization.route.coding.system",
"min": 1,
"fixedUri": "http://snomed.info/sct"
},
{
"id": "Immunization.route.coding:snomedCT.code",
"path": "Immunization.route.coding.code",
"min": 1
},
{
"id": "Immunization.route.coding:snomedCT.display",
"path": "Immunization.route.coding.display",
"min": 1
},
{
"id": "Immunization.doseQuantity",
"path": "Immunization.doseQuantity",
"mustSupport": true
},
{
"id": "Immunization.practitioner",
"path": "Immunization.practitioner",
"mustSupport": true
},
{
"id": "Immunization.practitioner.role",
"path": "Immunization.practitioner.role",
"mustSupport": true
},
{
"id": "Immunization.practitioner.actor",
"path": "Immunization.practitioner.actor",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1"
]
}
]
},
{
"id": "Immunization.note",
"path": "Immunization.note",
"mustSupport": true
},
{
"id": "Immunization.note.author[x]",
"path": "Immunization.note.author[x]",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
},
{
"code": "string"
},
{
"code": "Reference",
"targetProfile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1"
]
},
{
"code": "Reference",
"targetProfile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1"
]
}
]
},
{
"id": "Immunization.explanation.reason",
"path": "Immunization.explanation.reason",
"mustSupport": true,
"binding": {
"valueSetReference": {
"reference": "https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-ImmunizationExplanationReason-2"
},
"strength": "example"
}
},
{
"id": "Immunization.explanation.reasonNotGiven",
"path": "Immunization.explanation.reasonNotGiven",
"mustSupport": true,
"binding": {
"valueSetReference": {
"reference": "https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-ReasonImmunizationNotAdministered-1"
},
"strength": "extensible"
}
},
{
"id": "Immunization.reaction.detail",
"path": "Immunization.reaction.detail",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Observation-1"
]
}
]
},
{
"id": "Immunization.vaccinationProtocol.doseSequence",
"path": "Immunization.vaccinationProtocol.doseSequence",
"min": 1
},
{
"id": "Immunization.vaccinationProtocol.description",
"path": "Immunization.vaccinationProtocol.description",
"mustSupport": true
},
{
"id": "Immunization.vaccinationProtocol.authority",
"path": "Immunization.vaccinationProtocol.authority",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1"
]
}
]
},
{
"id": "Immunization.vaccinationProtocol.seriesDoses",
"path": "Immunization.vaccinationProtocol.seriesDoses",
"mustSupport": true
},
{
"id": "Immunization.vaccinationProtocol.targetDisease.coding",
"path": "Immunization.vaccinationProtocol.targetDisease.coding",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "system"
}
],
"ordered": false,
"rules": "open"
}
},
{
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT",
"path": "Immunization.vaccinationProtocol.targetDisease.coding",
"sliceName": "snomedCT",
"max": "1"
},
{
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.extension:snomedCTDescriptionID",
"path": "Immunization.vaccinationProtocol.targetDisease.coding.extension",
"sliceName": "snomedCTDescriptionID",
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
]
}
]
},
{
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.extension:snomedCTDescriptionID.url",
"path": "Immunization.vaccinationProtocol.targetDisease.coding.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
},
{
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.system",
"path": "Immunization.vaccinationProtocol.targetDisease.coding.system",
"min": 1,
"fixedUri": "http://snomed.info/sct"
},
{
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.code",
"path": "Immunization.vaccinationProtocol.targetDisease.coding.code",
"min": 1
},
{
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.display",
"path": "Immunization.vaccinationProtocol.targetDisease.coding.display",
"min": 1
},
{
"id": "Immunization.vaccinationProtocol.doseStatus.coding.system",
"path": "Immunization.vaccinationProtocol.doseStatus.coding.system",
"min": 1
},
{
"id": "Immunization.vaccinationProtocol.doseStatus.coding.code",
"path": "Immunization.vaccinationProtocol.doseStatus.coding.code",
"min": 1,
"fixedCode": "count"
},
{
"id": "Immunization.vaccinationProtocol.doseStatus.coding.display",
"path": "Immunization.vaccinationProtocol.doseStatus.coding.display",
"min": 1
}
]
}

}

Command 'details' could not render: There is no placeholder called 'details'

Reference

Canonical URI: https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Immunization-1

The canonical URI is the stable FHIR identifier for this profile and is not currently available as a browsable web page.

Data model element usage

Element	Use	CareConnect (STU3)	UK Core (R4)	NHS Digital (R4)
id
meta.versionId
meta.lastUpdated
meta.profile
meta.security
meta.tag
extension(parentPresent)
extension(recordedDate)
extension(vaccinationProcedure)
identifier
status
notGiven
vaccineCode
patient
encounter
date
primarySource
reportOrigin
location
manufacturer
lotNumber
expirationDate
site
route
doseQuantity
practitioner.role
practitioner.actor
note
explanation.reason
explanation.reasonNotGiven
reaction
vaccinationProtocol
vaccinationProtocol.doseSequence
vaccinationProtocol.description
vaccinationProtocol.authority
vaccinationProtocol.series
vaccinationProtocol.seriesDoses
vaccinationProtocol.targetDisease
vaccinationProtocol.doseStatus
vaccinationProtocol.doseStatusReason

id

Usage

Optional

Guidance

The id is the logical identifier for the CareConnect-GPC-Immunization-1 profile.

Example

<id value="3d86f348-4e1d-11ed-bdc3-0242ac120002" />

meta.versionId

Usage

Optional

Guidance

The population of the meta.versionId element could be useful if sending an adendum of something previously sent to help the consumer (receiver) in understanding there is a "newer" version.

Example

<meta>
    <versionId value="1" />
</meta>

meta.lastUpdated

Usage

Optional

Guidance

The meta.lastUpdated element could be useful alongside the meta.versionIdelement could be useful if sending an adendum of something previously sent to help the consumer (receiver) in understanding there is a "newer" version.

Example

<meta>
    <lastUpdated value="2022-10-28T08:06:00+00:00" />
</meta>

meta.profile

Usage

Mandatory

Guidance

The meta.profile contains a fixed value of the URL for the CareConnect-GPC-Immunization-1 profile.

Example

<meta>
    <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Immunization-1" />
</meta>

meta.security

Usage

Optional

Guidance

The security label(s) applicable to the resource.

See Resources not to be disclosed to a patient for more details on how to populate the element.

Example

<meta>
    <security>
        <system value="http://hl7.org/fhir/v3/ActCode"/>
        <code value="NOPAT"/>
        <display value="no disclosure to patient, family or caregivers without attending provider's authorization"/>
    </security>
</meta>

meta.tag

Usage

Optional

Guidance

A use-case for the meta.tag element within GP Connect has not been defined.

Example

<meta>
    <tag>
        <coding>
            <system value="http://hl7.org/fhir/common-tags" />
            <code value="actionable" />
            <display value="Actionable" />
        </coding>
    </tag>
</meta>

extension(parentPresent)

Usage

Required

Guidance

Indicates whether a parent was present at the immunisation.

Example

<extension>
    <url value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1" />
    <valueBoolean value="true" />
</extension>

extension(recordedDate)

Usage

Mandatory

Guidance

Warning: This element is not present in FHIR R4 / UK Core.

This is the date the immunisation record (given or not given) was entered on the clinical system. This may be an audit trail date or equivalent for the record. If the immunisation has been transferred by GP2GP this SHOULD be the recorded date from the original record entry from the originating system.

Example

<extension>
    <url value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1" />
    <valueDateTime value="2022-10-17T14:21:00Z" />
</extension>

extension(vaccinationProcedure)

Usage

Mandatory

Guidance

The procedure code describing the vaccine that was administered or the situation code for a vaccination that was intended to be administered but was not done. See the profile for the valid codes.

Example

<extension>
    <url value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-VaccinationProcedure-1" />
    <valueCodeableConcept>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="1324681000000101" />
            <display value="Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)" />
        </coding>
    </valueCodeableConcept>
</extension>

identifier

Usage

Mandatory

Guidance

The identifier element MUST be populated with a globally unique and persistent identifier (that is, it doesn’t change between requests and therefore stored with the source data). This MUST be scoped by a provider specific namespace for the identifier.

Where consuming systems are integrating data from this resource to their local system, they MUST also persist this identifier at the same time.

Example

<identifier>
    <system value="https://foo.bar/id/immunization" />
    <value value="a58ca801-0858-47ce-8075-2df2c73935d1" />
</identifier>

status

Usage

Mandatory

Guidance

The status element has a fixed value of completed for all CareConnect profiles.

Example

<status value="completed" />

notGiven

Usage

Mandatory

Guidance

The status element MUST contain a boolean value:

false indicates a vaccination event which has been reported as given
true indicates that a vaccination was intended; however, was not given

Example

<notGiven value="false" />

vaccineCode

Usage

Mandatory

Guidance

Vaccine product administered or intended to be administered.

Where the vaccine product that was administered is not known then the null flavour value code UNK MUST be populated.

Example

Where the vaccine product is known.

<vaccineCode>
    <system value="http://snomed.info/sct" />
    <code value="1119349007" />
    <display value="Vaccine product containing only severe acute respiratory syndrome coronavirus 2 messenger ribonucleic acid (medicinal product)" />
</vaccineCode>

Where the vaccine product is not known.

<vaccineCode>
    <coding>
    <system value="http://hl7.org/fhir/v3/NullFlavor" />
    <code value="UNK" />
    <display value="Unknown" />
</vaccineCode>

patient

Usage

Mandatory

Guidance

A reference to the patient the vaccination event relates to.

Command 'pagelink' could not render: Page not found.

Example

<patient>
    <reference value="patient-4857773456" />
    <display value="TEAK, Anne (Mrs)" />
</patient>

encounter

Usage

Required

Guidance

The consultation within which this immunisation record was captured. This may represent when the vaccination was administered, intended to be administered or when the registered practice was informed of an immunisation administered elsewhere.

Command 'pagelink' could not render: Page not found.

Example

<encounter>
    <reference value="encounter-1234234" />
</encounter>

date

Usage

Required

Guidance

The date (and time if applicable) when the immunization was administered or intended to be administered. If the immunisation was administered elsewhere, this may be an estimated or partial date.

Example

<authoredOn value="2022-10-18T14:06:00Z" />

primarySource

Usage

Mandatory

Guidance

This indicates whether the record is based on information from the person who administered or intended to administer the vaccine.

This MUST be true where the immunisation record was recorded by the person who administered the vaccine or directly on behalf of the administrator of the vaccine (this includes recording the immunisation based on a complete, original, verifiable document from the administration of the vaccine).

This MUST be false where it is a secondary report of a vaccination for example the recollection of the patient, the patient’s parent, carer or guardian or a secondary document.

As this relates to the context of the original source of the immunisation record, a record from a GP2GP transfer is still a primary record if it was originally recorded as primary.

If it is not known whether the record of the vaccination was made from a primary or secondary source, then return the default value of true.

Example

<primarySource value="true" />

reportOrigin

Usage

Required

Guidance

This indicates the source of a secondary reported record.

This provides additional context to the source of the immunisation record where it is not based on information from the person who administered the vaccine. The reportOrigin element can be absent if the record is NOT from a primary source, but the origin of the record is otherwise not recorded / known.

This MUST be absent where the primarySource element has the value of true.

Example

<reportOrigin>
    <coding>
        <system value="http://hl7.org/fhir/stu3/valueset-immunization-origin.html">
        <code value="provider" />
        <display value="Other Provider" />
    </coding>
</reportOrigin>

location

Usage

Required

Guidance

The GP practice, branch surgery or other location where the vaccination occurred or was intended to occur, if known.

If the immunisation record in the GP Clinical System does not record a location for the vaccination, but is linked to a consultation then

if the vaccine was administered or was intended to be administered during the consultation the location MUST be populated with the location of the consultation
if the vaccine was NOT administered or intended to be administered during the consultation and the location for the vaccination is therefore unknown, then a location MUST be absent

Command 'pagelink' could not render: Page not found.

Example

<location>
    <reference value="location-992891" />
</location>

manufacturer

Usage

Required

Guidance

The manufacturer of the vaccine.

Command 'pagelink' could not render: Page not found.

Example

<manufacturer>
    <reference value="organization-29411" />
</manufacturer>

lotNumber

Usage

Required

Guidance

The batch number of the vaccine.

Example

<lotNumber value="29382/10AV" />

expirationDate

Usage

Required

Guidance

The expiry date of the batch the vaccine is from.

Example

<expirationDate value="2022-10-18T14:06:00Z" />

site

Usage

Required

Guidance

The site on the body where the vaccine was administered.

Note: This MUST be absent for an intended vaccination which was not given.

Example

<site>
    <coding>
        <system value="http://snomed.info/sct" />
        <code value="368208006" />
        <display value="Left upper arm structure (body structure)" />
    </coding>
</site>

route

Usage

Required

Guidance

The route through which the vaccine entered the body.

Note: This MUST be absent for an intended vaccination which was not given.

Example

<route>
    <coding>
        <system value="http://snomed.info/sct" />
        <code value="78421000" />
        <display value="Intramuscular route (qualifier value)" />
    </coding>
</route>

doseQuantity

Usage

Required

Guidance

The amount of the vaccine administered.

Note: This MUST be absent for an intended vaccination which was not given.

Example

<doseQuantity>
    <system value="http://snomed.info/sct" />
    <code value="3318611000001103" />
    <display value="pre-filled disposable injection (qualifier value)" />
</doseQuantity>

practitioner.role

Usage

Required

Guidance

The role of the referenced practitioner, if known, from the v2 Provider Role code system.

The code EP (Entering Provider) MUST be used to designate the practitioner as having recorded the vaccination (or reason not given).
The code AP (Administering Provider) MUST be used to designate the practitioner as having administered the vaccination or intending to if the vaccine was not given.

Note: This MUST be absent for if the practioner role is not known.

Example

<practitioner>
    <role>
        <coding>
            <system value="http://hl7.org/fhir/v2/0443" />
            <code value="AP" />
            <display value="Administering Provider" />
        </coding>
    </role>
</practitioner>

practitioner.actor

Usage

Mandatory

Guidance

A reference to the practitioner who administered and / or recorded the vaccine.

Where there is only a single practitioner recorded against the immunisation record:

if the practitioner recording the vaccination also administered it (or intended to), then associate a practitioner.role code AP (Administering Provider) with practitioner profile
if the GP Clinical System cannot determine whether the practitioner administered the vaccine or just recorded the vaccination event or both, then do not return a practitioner.role

Note: This is mandatory where the practitioner.role is populated.

Command 'pagelink' could not render: Page not found.

Example

<practitioner>
    <actor>
        <reference value="practitioner-9093012" />
    </actor>
</practitioner>

note

Usage

Required

Guidance

All notes that are associated with the vaccination event.

Example

<note>
    <author>
        <reference value="practitioner-948392" />
    </author>
    <time value="2022-10-13T16:59:00Z" />
    <text>
        Free text... R4 of the FHIR standard supports GitHub Flavoured Markdown (GFM).
    </text>
</note>

explanation.reason

Usage

Required

Guidance

The reason why the immunization was given, for example, travel, occupation, and so on. This MUST be absent if notGiven is true.

Note: This MUST be absent if notGiven has the value true.

Example

<explanation>
    <reason>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="443684005" />
            <display value="Disease outbreak" />
        </coding>
    </reason>
</explanation>

explanation.reasonNotGiven

Usage

Required

Guidance

The reason from the CareConnect Reason Immunization Not Administered value set to indicate the reason the immunization was not given.

Note: This MUST be present if notGiven has the value true.

Example

<explanation>
    <reasonNotGiven>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="281399006" />
            <display value="Did not attend (finding)" />
        </coding>
    </reasonNotGiven>
</explanation>

Immunization elements not in use

The following elements MUST NOT be populated:

reaction

Any reaction to an immunization MUST be sent seperately in an AllergyIntolerance profile.

Copy of 'GP Connect Data Model | FHIR STU3 Representation'

Profile: CareConnect-GPC-Immunization-1

Reference

Related links

Data model element usage

id

Usage

Guidance

Example

meta.versionId

Usage

Guidance

Example

meta.lastUpdated

Usage

Guidance

Example

meta.profile

Usage

Guidance

Example

meta.security

Usage

Guidance

Example

meta.tag

Usage

Guidance

Example

extension(parentPresent)

Usage

Guidance

Example

extension(recordedDate)

Usage

Guidance

Example

extension(vaccinationProcedure)

Usage

Guidance

Example

identifier

Usage

Guidance

Example

status

Usage

Guidance

Example

notGiven

Usage

Guidance

Example

vaccineCode

Usage

Guidance

Example

patient

Usage

Guidance

Example

encounter

Usage

Guidance

Example

date

Usage

Guidance

Example

primarySource

Usage

Guidance

Example

reportOrigin

Usage

Guidance

Example

location

Usage

Guidance