Implementation Guide
23.1.0 - R4 APIs
Publish Box goes here
Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-profile | Version: 23.1.0 | |||
Active as of 2022-03-01 | Computable Name: AthenaImmunization |
athena immunization profile
This Immunization profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.
This resource captures an immunization event for a patient. It records both events where the vaccine is successfully administered and events where the a vaccine was not given.
This profile is used to define the content that will be returned by the API Server in response to requests to access Immunization resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.
The profile also defines the content that must be supplied to the API Server in response to requests to populate Immunization resources. Fields which are marked as Mandatory in this profile are those that must be supplied to the API Server in content used to populate a resource.
The Immunization resource is derived from the Immunization table in athenaPractice and athenaFlow. Specific detail can be found in the Mappings tab in the profile detail page.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Immunization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | 0..* | Immunization | Immunization event information | |
id | 1..1 | id | Logical id of this artifact | |
meta | S | 0..1 | Meta | Metadata about the resource |
versionId | 0..1 | id | Version specific identifier | |
lastUpdated | 0..1 | instant | When the resource version last changed | |
Slices for profile | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | |
profile:USCore Immunization Profile | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | |
profile:Athena Immunization Profile | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-profile | |
Slices for security | 0..2 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding | |
security:SENSITIVECHART | 0..1 | Coding | Security Labels applied to this resource | |
security:CONFABBR | 0..1 | Coding | Security Labels applied to this resource | |
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
tag | 1..2 | Coding | Tags applied to this resource | |
Slices for extension | Content/Rules for all slices | |||
VFCEligibility | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-VFCEligibility | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-VFCEligibility" | |
value[x] | 1..1 | string | Value of extension | |
WasNotGiven | 0..1 | (Complex) | Flag for whether immunization was given URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-NotGiven | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-NotGiven" | |
value[x] | 1..1 | boolean | Value of extension | |
identifier | S | 0..* | Identifier | External ids for this item |
status | S | 1..1 | code | completed | entered-in-error | not-done |
statusReason | 0..1 | CodeableConcept | Reason not done | |
Slices for coding | 0..2 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:SNOMED | 0..1 | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
coding:ACT-REASON | 0..1 | Coding | Code defined by a terminology system | |
vaccineCode | 1..1 | CodeableConcept | Vaccine product administered | |
Slices for coding | 0..3 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:CVX Code | 0..1 | Coding | Code defined by a terminology system | |
coding:NDC Code | 0..1 | Coding | Code defined by a terminology system | |
patient | 1..1 | Reference(Patient) | Who was immunized | |
encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |
occurrence[x] | 1..1 | dateTime | Vaccine administration date | |
primarySource | 0..1 | boolean | Indicates context the data was recorded in | |
reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record | |
location | 0..1 | Reference(Location) | Where immunization occurred | |
manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |
lotNumber | 0..1 | string | Vaccine lot number | |
expirationDate | 0..1 | date | Vaccine expiration date | |
site | 0..1 | CodeableConcept | Body site vaccine was administered | |
route | 0..1 | CodeableConcept | How vaccine entered body | |
doseQuantity | 0..1 | Quantity | Amount of vaccine administered | |
performer | 0..* | BackboneElement | Who performed event | |
actor | 1..1 | Reference(Practitioner) | Individual or organization who was performing | |
note | 0..* | Annotation | Additional immunization notes | |
reasonCode | 0..* | CodeableConcept | Why immunization occurred | |
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |
date | 0..1 | dateTime | When reaction started | |
detail | 0..1 | Reference(Observation) | Additional information on reaction | |
protocolApplied | 0..* | BackboneElement | Protocol followed by the provider | |
series | 0..1 | string | Name of vaccine series | |
doseNumber[x] | 1..1 | positiveInt | Dose number within series | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | 0..* | Immunization | Immunization event information | |
id | Σ | 1..1 | id | Logical id of this artifact |
meta | SΣ | 0..1 | Meta | Metadata about the resource |
versionId | Σ | 0..1 | id | Version specific identifier |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
Slices for profile | Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri |
profile:USCore Immunization Profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization |
profile:Athena Immunization Profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-profile |
Slices for security | Σ | 0..2 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:SENSITIVECHART | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:CONFABBR | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
tag | Σ | 1..2 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
VFCEligibility | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-VFCEligibility | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-VFCEligibility" | |
value[x] | 1..1 | string | Value of extension | |
WasNotGiven | 0..1 | (Complex) | Flag for whether immunization was given URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-NotGiven | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-NotGiven" | |
value[x] | 1..1 | boolean | Value of extension | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 0..* | Identifier | External ids for this item |
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
statusReason | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | |
Slices for coding | Σ | 0..2 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:SNOMED | Σ | 0..1 | Coding | Code defined by a terminology system |
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
coding:ACT-REASON | Σ | 0..1 | Coding | Code defined by a terminology system |
vaccineCode | Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. |
Slices for coding | Σ | 0..3 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:CVX Code | Σ | 0..1 | Coding | Code defined by a terminology system |
coding:NDC Code | Σ | 0..1 | Coding | Code defined by a terminology system |
patient | Σ | 1..1 | Reference(Patient) | Who was immunized |
encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |
occurrence[x] | Σ | 1..1 | dateTime | Vaccine administration date |
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in |
reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |
location | 0..1 | Reference(Location) | Where immunization occurred | |
manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |
lotNumber | 0..1 | string | Vaccine lot number | |
expirationDate | 0..1 | date | Vaccine expiration date | |
site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |
route | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |
doseQuantity | 0..1 | Quantity | Amount of vaccine administered | |
performer | Σ | 0..* | BackboneElement | Who performed event |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actor | Σ | 1..1 | Reference(Practitioner) | Individual or organization who was performing |
note | Σ | 0..* | Annotation | Additional immunization notes |
reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency |
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
date | 0..1 | dateTime | When reaction started | |
detail | 0..1 | Reference(Observation) | Additional information on reaction | |
protocolApplied | 0..* | BackboneElement | Protocol followed by the provider | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
series | 0..1 | string | Name of vaccine series | |
doseNumber[x] | 1..1 | positiveInt | Dose number within series | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Immunization.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
Immunization.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
Immunization.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
Immunization.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | |
Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard | |
Immunization.statusReason | example | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard | |
Immunization.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard | |
Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard | |
Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard | |
Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard | |
Immunization.reasonCode | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Immunization | 0..* | Immunization | Immunization event information | |||||
id | Σ | 1..1 | id | Logical id of this artifact | ||||
meta | SΣ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
Slices for profile | Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | ||||
profile:USCore Immunization Profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | ||||
profile:Athena Immunization Profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-profile | ||||
Slices for security | Σ | 0..2 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:SENSITIVECHART | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:CONFABBR | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag | Σ | 1..2 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
VFCEligibility | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-VFCEligibility | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-VFCEligibility" | |||||
value[x] | 1..1 | string | Value of extension | |||||
WasNotGiven | 0..1 | (Complex) | Flag for whether immunization was given URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-NotGiven | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-NotGiven" | |||||
value[x] | 1..1 | boolean | Value of extension | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | S | 0..* | Identifier | External ids for this item | ||||
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
statusReason | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..2 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:SNOMED | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:ACT-REASON | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
vaccineCode | Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..3 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:CVX Code | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
coding:NDC Code | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
patient | Σ | 1..1 | Reference(Patient) | Who was immunized | ||||
encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
occurrence[x] | Σ | 1..1 | dateTime | Vaccine administration date | ||||
recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||
location | 0..1 | Reference(Location) | Where immunization occurred | |||||
manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |||||
lotNumber | 0..1 | string | Vaccine lot number | |||||
expirationDate | 0..1 | date | Vaccine expiration date | |||||
site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |||||
route | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
doseQuantity | 0..1 | Quantity | Amount of vaccine administered | |||||
performer | Σ | 0..* | BackboneElement | Who performed event | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||
actor | Σ | 1..1 | Reference(Practitioner) | Individual or organization who was performing | ||||
note | Σ | 0..* | Annotation | Additional immunization notes | ||||
reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||
subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
education | C | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
documentType | 0..1 | string | Educational material document identifier | |||||
reference | 0..1 | uri | Educational material reference pointer | |||||
publicationDate | 0..1 | dateTime | Educational material publication date | |||||
presentationDate | 0..1 | dateTime | Educational material presentation date | |||||
programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
date | 0..1 | dateTime | When reaction started | |||||
detail | 0..1 | Reference(Observation) | Additional information on reaction | |||||
reported | 0..1 | boolean | Indicates self-reported reaction | |||||
protocolApplied | 0..* | BackboneElement | Protocol followed by the provider | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
series | 0..1 | string | Name of vaccine series | |||||
authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
targetDisease | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
doseNumber[x] | 1..1 | positiveInt | Dose number within series | |||||
seriesDoses[x] | 0..1 | Recommended number of doses for immunity | ||||||
seriesDosesPositiveInt | positiveInt | |||||||
seriesDosesString | string | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Immunization.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Immunization.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Immunization.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Immunization.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Immunization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard | ||||
Immunization.statusReason | example | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard | ||||
Immunization.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard | ||||
Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard | ||||
Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard | ||||
Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard | ||||
Immunization.performer.function | extensible | ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard | ||||
Immunization.reasonCode | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard | ||||
Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard | ||||
Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard | ||||
Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard | ||||
Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-target-disease from the FHIR Standard |
This structure is derived from Immunization
Summary
Mandatory: 5 elements(11 nested mandatory elements)
Must-Support: 3 elements
Fixed: 5 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Immunization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | 0..* | Immunization | Immunization event information | |
id | 1..1 | id | Logical id of this artifact | |
meta | S | 0..1 | Meta | Metadata about the resource |
versionId | 0..1 | id | Version specific identifier | |
lastUpdated | 0..1 | instant | When the resource version last changed | |
Slices for profile | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | |
profile:USCore Immunization Profile | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | |
profile:Athena Immunization Profile | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-profile | |
Slices for security | 0..2 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding | |
security:SENSITIVECHART | 0..1 | Coding | Security Labels applied to this resource | |
security:CONFABBR | 0..1 | Coding | Security Labels applied to this resource | |
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
tag | 1..2 | Coding | Tags applied to this resource | |
Slices for extension | Content/Rules for all slices | |||
VFCEligibility | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-VFCEligibility | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-VFCEligibility" | |
value[x] | 1..1 | string | Value of extension | |
WasNotGiven | 0..1 | (Complex) | Flag for whether immunization was given URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-NotGiven | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-NotGiven" | |
value[x] | 1..1 | boolean | Value of extension | |
identifier | S | 0..* | Identifier | External ids for this item |
status | S | 1..1 | code | completed | entered-in-error | not-done |
statusReason | 0..1 | CodeableConcept | Reason not done | |
Slices for coding | 0..2 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:SNOMED | 0..1 | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 0..1 | code | Symbol in syntax defined by the system | |
display | 0..1 | string | Representation defined by the system | |
coding:ACT-REASON | 0..1 | Coding | Code defined by a terminology system | |
vaccineCode | 1..1 | CodeableConcept | Vaccine product administered | |
Slices for coding | 0..3 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:CVX Code | 0..1 | Coding | Code defined by a terminology system | |
coding:NDC Code | 0..1 | Coding | Code defined by a terminology system | |
patient | 1..1 | Reference(Patient) | Who was immunized | |
encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |
occurrence[x] | 1..1 | dateTime | Vaccine administration date | |
primarySource | 0..1 | boolean | Indicates context the data was recorded in | |
reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record | |
location | 0..1 | Reference(Location) | Where immunization occurred | |
manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |
lotNumber | 0..1 | string | Vaccine lot number | |
expirationDate | 0..1 | date | Vaccine expiration date | |
site | 0..1 | CodeableConcept | Body site vaccine was administered | |
route | 0..1 | CodeableConcept | How vaccine entered body | |
doseQuantity | 0..1 | Quantity | Amount of vaccine administered | |
performer | 0..* | BackboneElement | Who performed event | |
actor | 1..1 | Reference(Practitioner) | Individual or organization who was performing | |
note | 0..* | Annotation | Additional immunization notes | |
reasonCode | 0..* | CodeableConcept | Why immunization occurred | |
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |
date | 0..1 | dateTime | When reaction started | |
detail | 0..1 | Reference(Observation) | Additional information on reaction | |
protocolApplied | 0..* | BackboneElement | Protocol followed by the provider | |
series | 0..1 | string | Name of vaccine series | |
doseNumber[x] | 1..1 | positiveInt | Dose number within series | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | 0..* | Immunization | Immunization event information | |
id | Σ | 1..1 | id | Logical id of this artifact |
meta | SΣ | 0..1 | Meta | Metadata about the resource |
versionId | Σ | 0..1 | id | Version specific identifier |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
Slices for profile | Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri |
profile:USCore Immunization Profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization |
profile:Athena Immunization Profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-profile |
Slices for security | Σ | 0..2 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:SENSITIVECHART | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:CONFABBR | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
tag | Σ | 1..2 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
VFCEligibility | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-VFCEligibility | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-VFCEligibility" | |
value[x] | 1..1 | string | Value of extension | |
WasNotGiven | 0..1 | (Complex) | Flag for whether immunization was given URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-NotGiven | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-NotGiven" | |
value[x] | 1..1 | boolean | Value of extension | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 0..* | Identifier | External ids for this item |
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
statusReason | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | |
Slices for coding | Σ | 0..2 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:SNOMED | Σ | 0..1 | Coding | Code defined by a terminology system |
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
coding:ACT-REASON | Σ | 0..1 | Coding | Code defined by a terminology system |
vaccineCode | Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. |
Slices for coding | Σ | 0..3 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:CVX Code | Σ | 0..1 | Coding | Code defined by a terminology system |
coding:NDC Code | Σ | 0..1 | Coding | Code defined by a terminology system |
patient | Σ | 1..1 | Reference(Patient) | Who was immunized |
encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |
occurrence[x] | Σ | 1..1 | dateTime | Vaccine administration date |
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in |
reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |
location | 0..1 | Reference(Location) | Where immunization occurred | |
manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |
lotNumber | 0..1 | string | Vaccine lot number | |
expirationDate | 0..1 | date | Vaccine expiration date | |
site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |
route | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |
doseQuantity | 0..1 | Quantity | Amount of vaccine administered | |
performer | Σ | 0..* | BackboneElement | Who performed event |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
actor | Σ | 1..1 | Reference(Practitioner) | Individual or organization who was performing |
note | Σ | 0..* | Annotation | Additional immunization notes |
reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency |
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
date | 0..1 | dateTime | When reaction started | |
detail | 0..1 | Reference(Observation) | Additional information on reaction | |
protocolApplied | 0..* | BackboneElement | Protocol followed by the provider | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
series | 0..1 | string | Name of vaccine series | |
doseNumber[x] | 1..1 | positiveInt | Dose number within series | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Immunization.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
Immunization.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
Immunization.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
Immunization.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | |
Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard | |
Immunization.statusReason | example | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard | |
Immunization.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard | |
Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard | |
Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard | |
Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard | |
Immunization.reasonCode | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Immunization | 0..* | Immunization | Immunization event information | |||||
id | Σ | 1..1 | id | Logical id of this artifact | ||||
meta | SΣ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
Slices for profile | Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | ||||
profile:USCore Immunization Profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | ||||
profile:Athena Immunization Profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-profile | ||||
Slices for security | Σ | 0..2 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:SENSITIVECHART | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:CONFABBR | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag | Σ | 1..2 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
VFCEligibility | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-VFCEligibility | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-extension-VFCEligibility" | |||||
value[x] | 1..1 | string | Value of extension | |||||
WasNotGiven | 0..1 | (Complex) | Flag for whether immunization was given URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-NotGiven | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-extension-NotGiven" | |||||
value[x] | 1..1 | boolean | Value of extension | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | S | 0..* | Identifier | External ids for this item | ||||
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
statusReason | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..2 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:SNOMED | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:ACT-REASON | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
vaccineCode | Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..3 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:CVX Code | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
coding:NDC Code | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
patient | Σ | 1..1 | Reference(Patient) | Who was immunized | ||||
encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
occurrence[x] | Σ | 1..1 | dateTime | Vaccine administration date | ||||
recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||
location | 0..1 | Reference(Location) | Where immunization occurred | |||||
manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |||||
lotNumber | 0..1 | string | Vaccine lot number | |||||
expirationDate | 0..1 | date | Vaccine expiration date | |||||
site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |||||
route | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
doseQuantity | 0..1 | Quantity | Amount of vaccine administered | |||||
performer | Σ | 0..* | BackboneElement | Who performed event | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||
actor | Σ | 1..1 | Reference(Practitioner) | Individual or organization who was performing | ||||
note | Σ | 0..* | Annotation | Additional immunization notes | ||||
reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||
subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
education | C | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
documentType | 0..1 | string | Educational material document identifier | |||||
reference | 0..1 | uri | Educational material reference pointer | |||||
publicationDate | 0..1 | dateTime | Educational material publication date | |||||
presentationDate | 0..1 | dateTime | Educational material presentation date | |||||
programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
date | 0..1 | dateTime | When reaction started | |||||
detail | 0..1 | Reference(Observation) | Additional information on reaction | |||||
reported | 0..1 | boolean | Indicates self-reported reaction | |||||
protocolApplied | 0..* | BackboneElement | Protocol followed by the provider | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
series | 0..1 | string | Name of vaccine series | |||||
authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
targetDisease | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
doseNumber[x] | 1..1 | positiveInt | Dose number within series | |||||
seriesDoses[x] | 0..1 | Recommended number of doses for immunity | ||||||
seriesDosesPositiveInt | positiveInt | |||||||
seriesDosesString | string | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Immunization.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Immunization.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Immunization.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Immunization.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Immunization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Immunization.status | required | ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard | ||||
Immunization.statusReason | example | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard | ||||
Immunization.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard | ||||
Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard | ||||
Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard | ||||
Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard | ||||
Immunization.performer.function | extensible | ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard | ||||
Immunization.reasonCode | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard | ||||
Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard | ||||
Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard | ||||
Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard | ||||
Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-target-disease from the FHIR Standard |