| Immunization | I | | Immunization | There are no (further) constraints on this element Element idShort 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.
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()
- rim: Entity. Role, or Act
- workflow: Event
- v2: VXU_V04
- rim: SubstanceAdministration
|
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idShort 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.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
string |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idShort 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.
Meta Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idImmunization.implicitRules 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.
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.
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idShort description Language of the resource content Definition The base language in which the resource is written.
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).
code Binding CommonLanguages (preferred)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| text | | 0..1 | Narrative | There are no (further) constraints on this element Element idShort 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.
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.
Narrative Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A
- rim: Act.text?
|
| contained | | 0..* | Resource | There are no (further) constraints on this element Element idShort 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.
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.
Resource Mappings- rim: Entity. Role, or Act
- rim: N/A
|
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idShort 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| supportingInformation | I | 0..* | Extension | Element idImmunization.extension:supportingInformation 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.
This extension is used to pre-adopt an element from FHIR R5 Immunization
Extension Extension URL http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.supportingInformation 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()
- rim: n/a
- rim: N/A
- pCHDCF: Immunization Supporting Documents
|
| modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.modifierExtension 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).
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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| identifier | | 0..* | Identifier | There are no (further) constraints on this element Element idShort description Business identifier Definition A unique identifier assigned to this immunization record.
Identifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
|
| status | Σ ?! | 1..1 | codeBinding | Element idShort description completed | entered-in-error | not-done Definition Indicates the current status of the immunization event.
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.
code Binding A set of codes indicating the current status of an Immunization.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- workflow: Event.status
- w5: FiveWs.status
- rim: statusCode
- pCHDCF: Immunization Status
|
| statusReason | | 0..1 | CodeableConceptBinding | Element idImmunization.statusReason Reason not done Definition Indicates the reason the immunization event was not performed.
This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here.
CodeableConcept Binding The reason why a vaccine was not administered.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
- pCHDCF: Immunization Reason Not Performed
|
| vaccineCode | Σ | 1..1 | CodeableConceptBinding | Element idShort description Vaccine product administered Definition Vaccine that was administered or was to be administered.
The additionalBinding extension will be used to express the valueSet for additional negation/exclusion codes for reporting the known absence of immunizations. At the time of this release, the publisher of the current ValueSet for absence codes (IPS) is developing a SNOMED ValueSet that will replace the current http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips
CodeableConcept Binding Codes from the National Vaccine Catalogue Vaccine Administered Trade Name Code ValueSet.
Recommended for use when conveying vaccine generic names for scenarios when brand name is not known or does not exist (e.g., immunization history where provider does not have detail of the trade name, the product has been discontinued and/or never licensed in Canada).
per pCHDCF: Alternate value sets can be used when passive immunization products are used
per pCHDCF: Alternate value sets can be used when passive immunization products are used
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
- pCHDCF: Immunization Name
|
| patient | Σ I | 1..1 | Reference(package/structuredefinition-patient-ca-core.json) | Element idShort description Who was immunized Definition The patient who either received or did not receive the immunization.
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.
Reference(package/structuredefinition-patient-ca-core.json) 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- 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 | I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idShort 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.
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.
Reference(Encounter) 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- 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 | | Element idImmunization.occurrence[x] Vaccine administration date Definition Date vaccine administered or was to be administered.
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.
Unordered, Open, by $this(Type) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
- pCHDCF: Immunization Date*
- pCHDCF: Immunization Reason Not Performed Date*
|
| occurrenceDateTime | Σ | 0..1 | dateTime | Element idImmunization.occurrence[x]:occurrenceDateTime Vaccine administration date Definition Date vaccine administered or was to be administered.
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.
dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
- pCHDCF: Immunization Date
- pCHDCF: Immunization Reason Not Performed Date
|
| occurrenceString | Σ | 0..1 | string | Element idImmunization.occurrence[x]:occurrenceString Vaccine administration date Definition Date vaccine administered or was to be administered.
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.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
- pCHDCF: Immunization Date*
- pCHDCF: Immunization Reason Not Performed Date*
|
| recorded | | 0..1 | dateTime | There are no (further) constraints on this element Element idShort 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.
dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- w5: FiveWs.recorded
- rim: .participation[typeCode=AUT].time
|
| primarySource | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idImmunization.primarySource 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.
Reflects the “reliability” of the content.
boolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 idImmunization.reportOrigin 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.
Should not be populated if primarySource = True, not required even if primarySource = False.
CodeableConcept Binding The source of the data for a record which is not from a primary source.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 | I | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idShort description Where immunization occurred Definition The service delivery location where the vaccine administration occurred.
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.
Reference(Location) 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- 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 | I | 0..1 | Reference(package/structuredefinition-organization-ca-core.json | Organization) | Element idImmunization.manufacturer Vaccine manufacturer Definition Name of vaccine manufacturer.
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.
Reference(package/structuredefinition-organization-ca-core.json | Organization) 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- 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
- pCHDCF: Immunization Manufacturer
|
| lotNumber | | 0..1 | string | Element idShort description Vaccine lot number Definition Lot number of the vaccine product.
Note that FHIR strings SHALL NOT exceed 1MB in size
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
- pCHDCF: Immunization Lot Number
|
| expirationDate | | 0..1 | date | Element idImmunization.expirationDate Vaccine expiration date Definition Date vaccine batch expires.
date Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: RXA-16
- rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime
- pCHDCF: Immunization Expiration Date
|
| site | | 0..1 | CodeableConcept | Element idShort description Body site vaccine was administered Definition Body site where vaccine was administered.
The preferred binding for this element is forthcoming in pCHDCF
CodeableConcept Binding The site at which the vaccine was administered.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
- pCHDCF: Immunization Site
|
| route | | 0..1 | CodeableConcept | Element idShort description How vaccine entered body Definition The path by which the vaccine product is taken into the body.
The preferred binding for this element is forthcoming in pCHDCF
CodeableConcept Binding The route by which the vaccine was administered.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
- pCHDCF: Immunization Route of Administration
|
| doseQuantity | I | 0..1 | SimpleQuantity | Element idImmunization.doseQuantity Amount of vaccine administered Definition The quantity of vaccine product that was administered.
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.
SimpleQuantity 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()
- 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
- pCHDCF: Immunization Dose Volume
|
| performer | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idShort description Who performed event Definition Indicates who performed the immunization event.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- workflow: Event.performer
- v2: ORC-12 / RXA-10
- rim: .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idImmunization.performer.id 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.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.performer.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.performer.modifierExtension 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).
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.
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.
Extension 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()
|
| function | Σ | 0..1 | CodeableConceptBinding | Element idImmunization.performer.function What type of performance was done Definition Describes the type of performance (e.g. ordering provider, administering provider, etc.).
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.
CodeableConcept Binding The role a practitioner or organization plays in the immunization event.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow: Event.performer.function
- rim: .participation.functionCode
- pCHDCF: Immunization Reaction Reporter*
|
| actor | Σ I | 1..1 | Reference(package/structuredefinition-practitioner-ca-core.json | package/structuredefinition-practitionerrole-ca-core.json | package/structuredefinition-organization-ca-core.json | Practitioner | PractitionerRole | Organization) | Element idImmunization.performer.actor Individual or organization who was performing Definition The practitioner or organization who performed the action.
When the individual practitioner who performed the action is known, it is best to send.
Reference(package/structuredefinition-practitioner-ca-core.json | package/structuredefinition-practitionerrole-ca-core.json | package/structuredefinition-organization-ca-core.json | Practitioner | PractitionerRole | Organization) 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- 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
- pCHDCF: Immunization Reaction Reporter*
|
| note | Σ | 0..* | Annotation | There are no (further) constraints on this element Element idShort description Additional immunization notes Definition Extra information about the immunization that is not conveyed by the other attributes.
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).
Annotation Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: N/A
- rim: Act
- workflow: Event.note
- v2: OBX-5 : OBX-3 = 48767-8
- rim: note
|
| reasonCode | | 0..* | CodeableConceptBinding | Element idShort description Why immunization occurred Definition Reasons why the vaccine was administered.
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.
CodeableConcept Binding The reason why a vaccine was administered.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow: Event.reasonCode
- rim: [actionNegationInd=false].reasonCode
- pCHDCF: Immunization Reason
|
| reasonReference | I | 0..* | Reference(Condition | Observation | DiagnosticReport) | There are no (further) constraints on this element Element idImmunization.reasonReference Why immunization occurred Definition Condition, Observation or DiagnosticReport that supports why the immunization was administered.
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.
Reference(Condition | Observation | DiagnosticReport) 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- 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 idShort description Dose potency Definition Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
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.
By default, a dose should be considered to be potent.
boolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: RXA-20 = PA (partial administration)
- rim: N/A
|
| subpotentReason | | 0..* | CodeableConcept | Element idImmunization.subpotentReason Reason for being subpotent Definition Reason why a dose is considered to be subpotent.
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.
CodeableConcept Binding The reason why a dose is considered to be subpotent.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim: N/A
- pCHDCF: Immunization Subpotent Reason
|
| education | I | 0..* | BackboneElement | Element idShort description Educational material presented to patient Definition Educational material presented to the patient (or guardian) at the time of vaccine administration.
While the FHIR R4 Immunization resource has the education element, it was removed in later releases of FHIR and replaced with guidance to convey details on the education provided to the person using the Communication resource. To maximize compatibility with future versions of FHIR, Communication is recommended over Immunization.education
BackboneElement 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()
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idImmunization.education.id 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.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.education.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.education.modifierExtension 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).
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.
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.
Extension 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()
|
| documentType | | 0..1 | string | There are no (further) constraints on this element Element idImmunization.education.documentType Educational material document identifier Definition Identifier of the material presented to the patient.
Note that FHIR strings SHALL NOT exceed 1MB in size
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 idImmunization.education.reference Educational material reference pointer Definition Reference pointer to the educational material given to the patient if the information was on line.
see http://en.wikipedia.org/wiki/Uniform_resource_identifier
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| publicationDate | | 0..1 | dateTime | There are no (further) constraints on this element Element idImmunization.education.publicationDate Educational material publication date Definition Date the educational material was published.
dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 idImmunization.education.presentationDate Educational material presentation date Definition Date the educational material was given to the patient.
dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 idImmunization.programEligibility Patient eligibility for a vaccination program Definition Indicates a patient's eligibility for a funding program.
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.
CodeableConcept Binding The patient's eligibility for a vaccation program.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 idImmunization.fundingSource 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).
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.
CodeableConcept Binding The source of funding used to purchase the vaccine administered.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim: N/A
|
| reaction | | 0..* | BackboneElement | Element idShort description Details of a reaction that follows immunization Definition Categorical data indicating that an adverse event is associated in time to an immunization.
The FHIR Base Specification advises that if Immunization.reaction is deemed to be an indication of an allergy or intolerance, a separate AllergyIntolerance resource instance should be created to indicate it, as most systems will not query against past Immunization.reaction
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: OBX-3
- rim: Observation[classCode=obs].code
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idShort 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.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.reaction.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.reaction.modifierExtension 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).
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.
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.
Extension 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()
|
| date | | 0..1 | dateTime | Element idImmunization.reaction.date When reaction started Definition Date of reaction to the immunization.
dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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
- pCHDCF: Immunization Reaction Date
- pCHDCF: Immunization Reaction Time
|
| detail | I | 0..1 | Reference(Observation) | Element idImmunization.reaction.detail Additional information on reaction Definition 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.
Reference(Observation) 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2: OBX-5
- rim: .value
- pCHDCF: Immunization Reaction*
|
| reported | | 0..1 | boolean | There are no (further) constraints on this element Element idImmunization.reaction.reported Indicates self-reported reaction Definition Data type boolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- 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 | Element idImmunization.protocolApplied Protocol followed by the provider Definition The protocol (set of recommendations) being followed by the provider who administered the dose.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A
- pCHDCF: Immunization Protocol
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idImmunization.protocolApplied.id 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.
string Mappings |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.protocolApplied.extension 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.
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.
Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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()
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.protocolApplied.modifierExtension 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).
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.
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.
Extension 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()
|
| series | | 0..1 | string | Element idImmunization.protocolApplied.series Name of vaccine series Definition One possible path to achieve presumed immunity against a disease - within the context of an authority.
Note that FHIR strings SHALL NOT exceed 1MB in size
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A
- pCHDCF: Immunization Protocol Series
|
| authority | I | 0..1 | Reference(package/structuredefinition-organization-ca-core.json | Organization) | Element idImmunization.protocolApplied.authority Who is responsible for publishing the recommendations Definition Indicates the authority who published the protocol (e.g. ACIP) that is being followed.
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.
Reference(package/structuredefinition-organization-ca-core.json | Organization) 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
- rim: n/a
- rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- rim: N/A
- pCHDCF: Immunization Protocol Authority
|
| targetDisease | | 0..* | CodeableConceptBinding | Element idImmunization.protocolApplied.targetDisease Vaccine preventatable disease being targetted Definition The vaccine preventable disease the dose is being administered against.
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.
CodeableConcept Binding The vaccine preventable disease the dose is being administered for.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- v2: CE/CNE/CWE
- rim: CD
- orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim: N/A
- pCHDCF: Immunization Protocol Target Disease
|
| doseNumber[x] | | 1..1 | | Element idImmunization.protocolApplied.doseNumber[x] Dose number within series Definition Nominal position in a series.
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).
Unordered, Open, by $this(Type) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A
- pCHDCF: Immunization Dose Number*
|
| doseNumberPositiveInt | | 0..1 | positiveInt | Element idImmunization.protocolApplied.doseNumber[x]:doseNumberPositiveInt Dose number within series Definition Nominal position in a series.
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).
positiveInt Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A
- pCHDCF: Immunization Dose Number*
|
| doseNumberString | | 0..1 | string | Element idImmunization.protocolApplied.doseNumber[x]:doseNumberString Dose number within series Definition Nominal position in a series.
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).
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A
- pCHDCF: Immunization Dose Number
|
| seriesDoses[x] | | 0..1 | | Element idImmunization.protocolApplied.seriesDoses[x] Recommended number of doses for immunity Definition The recommended number of doses to achieve immunity.
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).
Unordered, Open, by $this(Type) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A
- pCHDCF: Immunization Series Doses*
|
| seriesDosesPositiveInt | | 0..1 | positiveInt | Element idImmunization.protocolApplied.seriesDoses[x]:seriesDosesPositiveInt Recommended number of doses for immunity Definition The recommended number of doses to achieve immunity.
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).
positiveInt Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A
- pCHDCF: Immunization Series Doses*
|
| seriesDosesString | | 0..1 | string | Element idImmunization.protocolApplied.seriesDoses[x]:seriesDosesString Recommended number of doses for immunity Definition The recommended number of doses to achieve immunity.
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).
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
- rim: n/a
- rim: N/A
- pCHDCF: Immunization Series Doses
|
