Immunization (CA-Core)
Additional information on this profile (including the JSON & XML structure and detailed element descriptions) can be found at package/structuredefinition-immunization-ca-core.json
This profile imposes the CA Baseline (v1.1.7) Immunization Profile.
Profile
ImmunizationCACore (Immunization) | I | Immunization | Element idImmunization Immunization event information DefinitionDescribes 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.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idImmunization.id Logical id of this artifact DefinitionThe 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. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idImmunization.meta Metadata about the resource DefinitionThe 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.
|
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 DefinitionA 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idImmunization.language Language of the resource content DefinitionThe 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idImmunization.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idImmunization.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | 0..* | Identifier | There are no (further) constraints on this element Element idImmunization.identifier Business identifier DefinitionA unique identifier assigned to this immunization record.
| |
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idImmunization.status completed | entered-in-error | not-done DefinitionIndicates 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. A set of codes indicating the current status of an Immunization.
|
statusReason | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idImmunization.statusReason Reason not done DefinitionIndicates 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. The reason why a vaccine was not administered.
| |
vaccineCode | S Σ | 1..1 | CodeableConceptBinding | Element idImmunization.vaccineCode Vaccine product administered DefinitionVaccine 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 Codes from the National Vaccine Catalogue Vaccine Administered Trade Name Code ValueSet.
|
id | 0..1 | string | There are no (further) constraints on this element Element idImmunization.vaccineCode.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.vaccineCode.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | S Σ | 1..* | Coding | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | code | Element idImmunization.vaccineCode.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | Element idImmunization.vaccineCode.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
id | 0..1 | string | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding.display.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding.display.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
translation | I | 0..* | Extension(Complex) | Element idImmunization.vaccineCode.coding.display.extension:translation Language Translation (Localization) Alternate namesextensions, user content DefinitionLanguage translation from base language of resource to another language. 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(Complex) Extension URLhttp://hl7.org/fhir/StructureDefinition/translation Constraints
|
value | 0..1 | System.String | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding.display.value Primitive value for string DefinitionPrimitive value for string System.String Maximum string length1048576 | |
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idImmunization.vaccineCode.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
patient | S Σ I | 1..1 | Reference(PatientCACore) | Element idImmunization.patient Who was immunized DefinitionThe 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.
|
encounter | I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idImmunization.encounter Encounter immunization was part of DefinitionThe 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.
|
occurrence[x] | Σ | 1..1 | Element idImmunization.occurrence[x] Vaccine administration date DefinitionDate 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
| |
(All Slices) | There are no (further) constraints on this element | |||
occurrenceString | string | There are no (further) constraints on this element Data type | ||
occurrenceDateTime | S Σ | 0..1 | dateTime | Element idImmunization.occurrence[x]:occurrenceDateTime Vaccine administration date DefinitionDate vaccine administered or was to be administered. Immunizations
|
recorded | 0..1 | dateTime | There are no (further) constraints on this element Element idImmunization.recorded When the immunization was first captured in the subject's record DefinitionThe date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
| |
primarySource | Σ | 0..1 | boolean | Element idImmunization.primarySource Indicates context the data was recorded in DefinitionAn 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. Immunization records created during an encounter event are expected to have occurrence populated
|
reportOrigin | S | 0..1 | CodeableConcept | Element idImmunization.reportOrigin Indicates the source of a secondarily reported record DefinitionThe source of the data when the report of the immunization event is not based on information from the person who administered the vaccine. The historical nature of an immunization that is patient reported is expected to be expressed in this field. The source of the data for a record which is not from a primary source.
|
id | 0..1 | string | There are no (further) constraints on this element Element idImmunization.reportOrigin.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.reportOrigin.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element idImmunization.reportOrigin.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idImmunization.reportOrigin.coding.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.reportOrigin.coding.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idImmunization.reportOrigin.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idImmunization.reportOrigin.coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | code | Element idImmunization.reportOrigin.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idImmunization.reportOrigin.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idImmunization.reportOrigin.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idImmunization.reportOrigin.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
location | I | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idImmunization.location Where immunization occurred DefinitionThe 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.
|
manufacturer | I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idImmunization.manufacturer Vaccine manufacturer DefinitionName 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.
|
lotNumber | 0..1 | string | There are no (further) constraints on this element Element idImmunization.lotNumber Vaccine lot number DefinitionLot number of the vaccine product. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
expirationDate | 0..1 | date | There are no (further) constraints on this element Element idImmunization.expirationDate Vaccine expiration date DefinitionDate vaccine batch expires.
| |
site | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idImmunization.site Body site vaccine was administered DefinitionBody site where 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. The site at which the vaccine was administered.
| |
route | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idImmunization.route How vaccine entered body DefinitionThe path by which the vaccine product is taken into the body. 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. The route by which the vaccine was administered.
| |
doseQuantity | I | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idImmunization.doseQuantity Amount of vaccine administered DefinitionThe 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.
|
performer | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idImmunization.performer Who performed event DefinitionIndicates who performed the immunization event.
|
id | 0..1 | string | There are no (further) constraints on this element Element idImmunization.performer.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.performer.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
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 namesextensions, user content, modifiers DefinitionMay 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.
|
function | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idImmunization.performer.function What type of performance was done DefinitionDescribes 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. The role a practitioner or organization plays in the immunization event.
|
actor | Σ I | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element idImmunization.performer.actor Individual or organization who was performing DefinitionThe practitioner or organization who performed the action. When the individual practitioner who performed the action is known, it is best to send. Reference(Practitioner | PractitionerRole | Organization) Constraints
|
note | Σ | 0..* | Annotation | There are no (further) constraints on this element Element idImmunization.note Additional immunization notes DefinitionExtra 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).
|
reasonCode | 0..* | CodeableConcept | There are no (further) constraints on this element Element idImmunization.reasonCode Why immunization occurred DefinitionReasons 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. The reason why a vaccine was administered.
| |
reasonReference | I | 0..* | Reference(Condition | Observation | DiagnosticReport) | There are no (further) constraints on this element Element idImmunization.reasonReference Why immunization occurred DefinitionCondition, 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
|
isSubpotent | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idImmunization.isSubpotent Dose potency DefinitionIndication 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.
|
subpotentReason | 0..* | CodeableConcept | There are no (further) constraints on this element Element idImmunization.subpotentReason Reason for being subpotent DefinitionReason 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. The reason why a dose is considered to be subpotent.
| |
education | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idImmunization.education Educational material presented to patient DefinitionEducational material presented to the patient (or guardian) at the time of vaccine administration.
|
id | 0..1 | string | There are no (further) constraints on this element Element idImmunization.education.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.education.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
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 namesextensions, user content, modifiers DefinitionMay 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.
|
documentType | 0..1 | string | There are no (further) constraints on this element Element idImmunization.education.documentType Educational material document identifier DefinitionIdentifier of the material presented to the patient. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
reference | 0..1 | uri | There are no (further) constraints on this element Element idImmunization.education.reference Educational material reference pointer DefinitionReference pointer to the educational material given to the patient if the information was on line. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
| |
publicationDate | 0..1 | dateTime | There are no (further) constraints on this element Element idImmunization.education.publicationDate Educational material publication date DefinitionDate the educational material was published.
| |
presentationDate | 0..1 | dateTime | There are no (further) constraints on this element Element idImmunization.education.presentationDate Educational material presentation date DefinitionDate the educational material was given to the patient.
| |
programEligibility | 0..* | CodeableConcept | There are no (further) constraints on this element Element idImmunization.programEligibility Patient eligibility for a vaccination program DefinitionIndicates 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. The patient's eligibility for a vaccation program.
| |
fundingSource | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idImmunization.fundingSource Funding source for the vaccine DefinitionIndicates 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. The source of funding used to purchase the vaccine administered.
| |
reaction | 0..* | BackboneElement | There are no (further) constraints on this element Element idImmunization.reaction Details of a reaction that follows immunization DefinitionCategorical data indicating that an adverse event is associated in time to an immunization. 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idImmunization.reaction.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.reaction.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
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 namesextensions, user content, modifiers DefinitionMay 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.
|
date | 0..1 | dateTime | There are no (further) constraints on this element Element idImmunization.reaction.date When reaction started DefinitionDate of reaction to the immunization.
| |
detail | I | 0..1 | Reference(Observation) | There are no (further) constraints on this element Element idImmunization.reaction.detail Additional information on reaction DefinitionDetails of the reaction. 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.
|
reported | 0..1 | boolean | There are no (further) constraints on this element Element idImmunization.reaction.reported Indicates self-reported reaction DefinitionSelf-reported indicator.
| |
protocolApplied | 0..* | BackboneElement | There are no (further) constraints on this element Element idImmunization.protocolApplied Protocol followed by the provider DefinitionThe protocol (set of recommendations) being followed by the provider who administered the dose.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idImmunization.protocolApplied.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.protocolApplied.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
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 namesextensions, user content, modifiers DefinitionMay 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.
|
series | 0..1 | string | There are no (further) constraints on this element Element idImmunization.protocolApplied.series Name of vaccine series DefinitionOne 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
| |
authority | I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idImmunization.protocolApplied.authority Who is responsible for publishing the recommendations DefinitionIndicates 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.
|
targetDisease | 0..* | CodeableConcept | There are no (further) constraints on this element Element idImmunization.protocolApplied.targetDisease Vaccine preventatable disease being targetted DefinitionThe 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. The vaccine preventable disease the dose is being administered for.
| |
doseNumber[x] | 1..1 | There are no (further) constraints on this element Element idImmunization.protocolApplied.doseNumber[x] Dose number within series DefinitionNominal 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).
| ||
doseNumberPositiveInt | positiveInt | There are no (further) constraints on this element Data type | ||
doseNumberString | string | There are no (further) constraints on this element Data type | ||
seriesDoses[x] | 0..1 | There are no (further) constraints on this element Element idImmunization.protocolApplied.seriesDoses[x] Recommended number of doses for immunity DefinitionThe 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).
| ||
seriesDosesPositiveInt | positiveInt | There are no (further) constraints on this element Data type | ||
seriesDosesString | string | There are no (further) constraints on this element Data type |
Obligations
Obligations are a new (and evolving) mechanism in FHIR to provide a consistent and machine processable way for profiles to define their expectations for system behaviors.
This profile utilizes the Obligation Extension to convey these expectations.
Note: Simplifier is working on rendering of Obligations. In the meantime the Obligations applied on the profile (see JSON & XML structure) have been rendered as a table below for easier viewing.
Obligation Code | Actor | Elements |
---|---|---|
SHALL:able-to-populate | Server Actor (CA Core) | vaccineCode, vaccineCode.coding, vaccineCode.coding.code, vaccineCode.coding.display, patient, occurrence[x]:occurrenceDateTime, reportOrigin, reportOrigin.coding, reportOrigin.coding.code |
SHALL:handle | Client Actor (CA Core) | vaccineCode, vaccineCode.coding, vaccineCode.coding.code, vaccineCode.coding.display, patient, occurrence[x]:occurrenceDateTime, reportOrigin, reportOrigin.coding, reportOrigin.coding.code |
Terminology
This version of the guide is based on the early content development of the pan-Canadian Health Data Content Framework (pCHDCF) and CACDI. The pCHDCF is beginning to introduce recommended terminology for select concepts. Implementers should be aware that the identification of preferred terminology continues to progress and that some coded elements may have terminology recommendations added in future releases.
Note: Implementers should be aware of the limitations in some terminology referenced in this guide that is not fully expressed as an enumerated FHIR ValueSet or resolvable FHIR CodeSystems. Readers should refer to the Known Issues & Future Development page.
Bindings
Primary bindings are expressed in the rendering of the profile above (as well as can be found in the JSON/XML file).
Additional terminology bindings are also expressed in this profile to surface Alternate Value Sets expressed in the pCHDCF Data Content Standard.
Additional terminology bindings can be viewed by scrolling over the element in the table above.
Note: In future releases, 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
Mappings to pCHDCF-CACDI Logical Data Model
Mapping | CACDI Logical Data Model Element | FHIR Profile Element | Comment |
---|---|---|---|
pCHDCF-CACDI | Immunization | Immunization | |
pCHDCF-CACDI | Drug | Immunization.vaccineCode | |
Immunization.vaccineCode.coding | |||
pCHDCF-CACDI | Drug Code | Immunization.vaccineCode.coding.code | |
pCHDCF-CACDI; pCHDCF-CACDI | Drug English Description; Drug French Description | Immunization.vaccineCode.coding.display | Display may be populated with english or french description depending on the context of the primary language for the user at the time this code is selected. Secondary or translated coding.display values should be conveyed using the translation extension; Display may be populated with english or french description depending on the context of the primary language for the user at the time this code is selected. Secondary or translated coding.display values should be conveyed using the translation extension |
Immunization.vaccineCode.coding.display.extension:translation | |||
pCHDCF-CACDI | Patient | Immunization.patient | |
Immunization.occurrence[x] | |||
pCHDCF-CACDI; pCHDCF-CACDI | Patient Provided Immunization Date; Event Start Date Time | Immunization.occurrence[x]:occurrenceDateTime | |
Immunization.primarySource | |||
Immunization.reportOrigin | |||
Immunization.reportOrigin.coding | |||
pCHDCF-CACDI | Immunization Reporting Source Code | Immunization.reportOrigin.coding.code |
Additional Mapping Notes
Immunization.vaccineCode.coding.display
- Display may be populated with english or french description depending on the context of the primary language for the user at the time this code is selected. Secondary or translated coding.display values should be conveyed using the translation extension