Vaccine Order
Source Object: Vaccine Order
Overview: The "Vaccine Order" source object contains data related to vaccine orders, including important details for administering vaccines to patients. This information is critical for managing vaccinations and ensuring patient safety.
Key Data Fields:
- Administer Note: Notes or instructions for administering the vaccine.
- Declined Date: Date when the vaccine order was declined.
- Declined Reason: Reason for declining the vaccine order.
- Diagnosis SNOMED Code: SNOMED code for the diagnosis associated with the vaccine order.
- Dispense as Written: Indication of whether the vaccine should be dispensed as written.
- Facility ID: Identifier of the healthcare facility where the vaccine order was placed.
- NDC: National Drug Code for the vaccine.
- Number of Refills Allowed: Maximum number of refills allowed for the vaccine.
- Ordering Mode: Mode of ordering the vaccine (e.g., electronic, paper).
- Order Type ID: Identifier for the type of vaccine order.
- Perform On Date: Date when the vaccine is scheduled to be administered.
- Pharmacy Note: Additional notes for the pharmacy related to the vaccine order.
- Provider Note: Notes or instructions for the healthcare provider.
- Unstructured SIG: Unstructured information about the vaccine order.
Vaccine orders are essential for maintaining vaccination records, tracking patient immunizations, and ensuring proper vaccine administration.
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 |
|---|---|---|---|---|---|---|---|---|---|---|
| administernote | - | An additional note to the provider or staff for administration. | String | 0..1 | serviceRequest | note[*].text | note[*].authorString=administer | - | - | Top Level |
| declineddate | - | The date on which the patient declined the vaccine. Required if the declined reason is passed in. | String | 0..1 | serviceRequest | extension[*].valueString | - | declined-date | Top Level | |
| declinedreason | - | To get a list of decline reasons for this input, call "GET /reference/order/vaccine/declinedreasons" | Integer | 0..1 | serviceRequest | extension[*].valueString | - | declined-reason | Top Level | |
| diagnosissnomedcode | - | The SNOMED code for diagnosis this order is for. | Integer | 1..1 | serviceRequest | reasonCode.[*].coding | system=http://snomed.info/sct | - | - | Top Level |
| dispenseaswritten | - | Whether the vaccine prescription should be marked as dispense as written (i.e., no substitutions without consulting the doctor). | Boolean | 0..1 | serviceRequest | extension[*].valueString | - | - | Top Level | |
| facilityid | - | The athena id of the pharmacy you want to send the vaccine prescription to. Defaults to the patient default pharmacy. Get a localized list using /chart/configuration/facilities. | String | 0..1 | serviceRequest | performer.[0].reference.split("/")?.[1] | - | - | Top Level | |
| ndc | - | The National Drug Code for the vaccine. | String | 0..1 | serviceRequest | extension[*].valueString | - | ndc | Top Level | |
| numrefillsallowed | - | The number of refills allowed for this vaccine prescription. Defaults to 0. | Integer | 0..1 | serviceRequest | extension[*].valueString | - | num-refills-allowed | Top Level | |
| orderingmode | - | Selects whether you wish to prescribe, administer, or decline this vaccine. | String | 0..1 | serviceRequest | extension[*].valueString | - | ordering-mode | Top Level | |
| ordertypeid | - | The athena ID of the vaccine to order. Must be an orderable vaccine. Get the IDs using /reference/order/vaccine | Integer | 1..1 | serviceRequest | code.coding[*].code | - | - | Top Level | |
| performondate | - | The date on which the Vaccine was administered. | String | 0..1 | serviceRequest | occurrenceDateTime | - | - | Top Level | |
| pharmacynote | - | A note to send to the pharmacy. | String | 0..1 | serviceRequest | note[*].text | note[*].authorString=organization | - | - | Top Level |
| providernote | - | An internal note for the provider or staff. | String | 0..1 | serviceRequest | note[*].text | note[*].authorString=practitioner | - | - | Top Level |
| unstructuredsig | - | The unstructured sig. | String | 0..1 | serviceRequest | extension[*].valueString | - | unstructured-sig | Top Level |