Vaccine Document
Source Object: Vaccine Document
Overview: The "Vaccine Document" source object contains information related to vaccine administration, documenting crucial details about vaccines administered to patients.
Key Data Fields:
- Appointment ID: Identifier for the associated appointment.
- Facility ID: Unique identifier of the healthcare facility.
- Contraindication Reason: Code and description for contraindication reasons.
- Created Date/Time: Timestamp of document creation.
- Declined Reason: Code, description, and text for declined reasons.
- Department ID: Identifier of the healthcare department.
- Document Type: Classification and description of the document.
- Encounter ID: Identifier for the healthcare encounter.
- Observation Date/Time: Timestamp associated with vaccine administration.
- Patient ID: Identifier of the patient receiving the vaccine.
- Status: Document status (e.g., pending, reviewed, administered).
- Subject: Subject or type of vaccine administered.
- Administer Lot Number: Lot number of the vaccine administered.
- Administer Site: Site on the patient's body where the vaccine was administered.
- Manufacturer: Name of the vaccine manufacturer.
- NDC: National Drug Code for the vaccine.
- Partially Administered: Indicates if the vaccine was partially administered.
- Quantity Unit and Value: Measurement unit and quantity administered.
- VIS Given Date: Date on which Vaccine Information Statement (VIS) was provided.
- Last Modified User: User who last modified the document.
- Order Type: Type of vaccine order (e.g., initial, booster, follow-up).
Vaccine documents are crucial for tracking immunization records and ensuring patient safety.
Mapping Table
| Data Field | Example Value | Source Data Field Description | Source Field Data Type | Source Data Field Cardinality | Mapped FHIR++ Resource | Mapped FHIR Data Field | Augmented Mapping | Associated Coding System | Associated FHIR Data Field Extension | Mapping Context |
|---|---|---|---|---|---|---|---|---|---|---|
| appointmentid | - | The appointment ID for this document. | number | 0..1 | DocumentReference | context.related.reference | - | Top Level | ||
| assignedto | - | Person the document is assigned to | string | 0..1 | DocumentReference | extension.valueString | assigned-to | Top Level | ||
| facilityid | - | The ID of the clinical provider associated with this clinical document. Clinical providers are a master list of providers throughout the country. These include providers as well as radiology centers, labs and pharmacies. | number | 0..1 | DocumentReference | custodian.reference | Top Level | |||
| contraindicationreason.code | - | The code indicating why the order was contraindicated. | string | 0..1 | Immunization | statusReason.coding.code | Contained | |||
| contraindicationreason.codeset | - | The codeset that the code belongs to. | string | 0..1 | Immunization | statusReason.coding.system | Contained | |||
| contraindicationreason.description | - | The plaintext description of the contraindication reason. | string | 0..1 | Immunization | statusReason.coding.display | Contained | |||
| createddatetime | - | Date/Time (ISO 8601) the document was created | string | 0..1 | DocumentReference | date | Top Level | |||
| declinedreason.code | - | The code indicating why the order was contraindicated. | string | 0..1 | Immunization | statusReason.coding.code | Contained | |||
| declinedreason.codeset | - | The codeset that the code belongs to. | string | 0..1 | Immunization | statusReason.coding.system | Contained | |||
| declinedreason.description | - | The plaintext description of the contraindication reason. | string | 0..1 | Immunization | statusReason.coding.display | Contained | |||
| declinedreasontext | - | The user-facing description of the reason the order was not given. | string | 0..1 | Immunization | statusReason.text | declined-reason-text | Contained | ||
| deleteddatetime | - | Date/time (ISO 8601) the document was deleted | string | 0..1 | DocumentReference | extension.valueDateTime | deleted-datetime | Top Level | ||
| departmentid | - | Department for the document | string | 0..1 | DocumentReference | extension.valueString | department-id | Top Level | ||
| documentclass | - | Class of document | string | 0..1 | DocumentReference | category.coding.code | Top Level | |||
| documentdescription | - | Description of the document type | string | 0..1 | DocumentReference | description | Top Level | |||
| documentsource | - | Explains where this document originated (e.g. ENCOUNTER, PORTAL, etc.) | string | 0..1 | DocumentReference | extension.valueString | document-source | Top Level | ||
| documentsubclass | - | Specific type of document | string | 0..1 | DocumentReference | category.extension.valueString | document-subclass | Top Level | ||
| documenttypeid | - | The ID of the description for this document | number | 0..1 | DocumentReference | extension.valueString | document-type-id | Top Level | ||
| encounterid | - | Encounter ID | string | 0..1 | DocumentReference | context.encounter.reference | Top Level | |||
| externalaccessionid | - | The external accession ID for this document. Format depends on the system the ID belongs to. | string | 0..1 | DocumentReference | extension.valueString | external-accession-id | Top Level | ||
| externalnote | - | External note for the patient | string | 0..1 | DocumentReference | extension.valueString | external-note | Top Level | ||
| vaccineid | - | ID of a vaccine document | number | 0..1 | DocumentReference | id | Top Level | |||
| internalaccessionid | - | The internal accession ID for this document. Format depends on the system the ID belongs to. | string | 0..1 | DocumentReference | extension.valueString | internal-accession-id | Top Level | ||
| internalnote | - | The 'Internal Note' attached to this document | string | 0..1 | DocumentReference | extension.valueString | internal-note | Top Level | ||
| lastmodifieddatetime | - | Date/time (ISO 8601) the document was last modified | string | 0..1 | DocumentReference | extension.valueDateTime | last-modified-datetime | Top Level | ||
| observationdatetime | - | Date/time (ISO 8601) the observation was taken | string | 0..1 | DocumentReference | extension.valueDateTime | observation-datetime | Top Level | ||
| patientid | - | The athenaNet patient ID | number | 0..1 | DocumentReference | subject.reference | Top Level | |||
| priority | - | Document priority, when available. | number | 0..1 | DocumentReference | extension.valueString | priority | Top Level | ||
| providerid | - | Provider ID for this document | number | 0..1 | DocumentReference | author.reference | Top Level | |||
| patientnote | - | External note for the patient. | string | 0..1 | DocumentReference | extension.valueString | patient-note | Top Level | ||
| status | - | Status of the document | string | 0..1 | DocumentReference | status | Top Level | |||
| subject | - | Subject of the document | string | 0..1 | DocumentReference | extension.valueString | subject | Top Level | ||
| tietoorderid | - | Order ID of the order this document is tied to, if any | number | 0..1 | DocumentReference | context.related.reference | Top Level | |||
| administerlotnumber | - | Lot number of the medication or vaccine administered | string | 0..1 | Immunization | lotNumber | Contained | |||
| administersite | - | The site on the patient that the medication/vaccine/etc was administered | string | 0..1 | Immunization | site.coding.display | Contained | |||
| manufacturer | - | Manufacturer of the administered medication | string | 0..1 | Immunization | manufacturer | Contained | |||
| ndc | - | The National Drug Code for the document | string | 0..1 | Immunization | vaccineCode.coding.code | Contained | |||
| partiallyadministered | - | Whether the vaccine is partially administered or not | string | 0..1 | Immunization | extension.valueString | partially-administered | Contained | ||
| quantityunit | - | Unit for prescription quantity | string | 0..1 | Immunization | dosageQuantity.extension.valueString | quantity-unit | Contained | ||
| quantityvalue | - | Value for prescription quantity | number | 0..1 | Immunization | dosageQuantity.value | Contained | |||
| visgivendate | - | Date when the Vaccine Information Statement was given to the patient. | string | 0..1 | Immunization | extension.valueDate | vis-given-date | Contained | ||
| lastmodifieduser | - | The user who last modified this document. | string | 0..1 | DocumentReference | extension.valueString | last-modified-user | Top Level | ||
| ordertype | - | Order type group name | string | 0..1 | DocumentReference | extension.valueString | order-type | Top Level |