Immunization Profile
This Immunization profile is part of the set of resource profiles supported by the API Server used with the athenaPractice 12.3 and athenaFlow 9.12 products. It further describes read, search, create and update capabilities of these products.
Overview
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.
Scope and Usage
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.
Source
The Immunization resource is derived from the Immunization tables in athenaPractice and athenaFlow. Specific detail can be found in the Mappings section below.
Supported Operations
The operations supported by this resource are listed below.
Read Operation
Read operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To read a Immunization, an application shall perform an HTTP GET, specifying the identifier of the resources being retrieved.
GET [base]/fhir/Immunization/[id]{?_format=[json|xml]&_summary=[true|data]}
Read Operation Parameters
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
| [id] | Specifies the identifier of the Immunization resource to retrieve |
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
| [_summary] | Filters the output to include only summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides slightly improved API response times. |
Read Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 200 OK | The requested resource was found and is contained within the body of the HTTP response. |
| 401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
| 404 Not Found | The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates that the resource could not be found. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
Search Operation
Search operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Immunization resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.
GET [base]/fhir/Immunization?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}
Search Operation Parameters
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
| [_count] | Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results Immunization resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the AthenaHealth Partner program. Note: The API Server support the HL7 FHIR Paging capability. |
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
| [_summary] | Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets. |
| _id (token ) | The ID of the resource |
| _lastUpdated (date ) | |
| _lastUpdated-fromnow (quantity ) | Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time , e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| _security (token ) | |
| _tag (token ) | |
| date (date ) | Vaccination (non)-Administration Date |
| date-fromnow (quantity ) | Like date except expressed as a positive or negative offset from the current time in units of time , e.g. date-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| dose-sequence (number ) | Dose number within series |
| encounter (reference ) | |
| encounter-or-historical (reference ) | |
| identifier (token ) | Business identifier |
| location (reference ) | The service delivery location or facility in which the vaccine was / was to be administered |
| lot-number (string ) | Vaccine Lot Number |
| notgiven (token ) | Administrations which were not given |
| patient (reference ) | The patient for the vaccination record |
| performer (reference ) | The practitioner who administered the vaccination |
| reaction (reference ) | Additional information on reaction |
| reaction-date (date ) | When reaction started |
| reaction-date-fromnow (quantity ) | Like reaction-date except expressed as a positive or negative offset from the current time in units of time , e.g. reaction-date-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
| reason (token ) | Why immunization occurred |
| reason-not-given (token ) | Explanation of reason vaccination was not administered |
| status (token ) | Immunization event status |
| vaccine-code (token ) | Vaccine Product Administered |
Search Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 200 OK | The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found. |
| 401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
Create Operation
Create operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To create a new Immunization resource, an application must perform an HTTP POST, specifying the content of the resource in the body of the request.
POST [base]/fhir/Immunization?{_format=[json|xml]}
Create Operation Parameters
| Parameter | Description |
|---|---|
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
Create Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 201 Created | The resource was created at the location specified in the HTTP Location header. Note: Unsupported fields will be accepted in a request but will not be persisted to the database. Some fields may be mapped to database specific codes which closely but not perfectly match the input. See the HL7 FHIR specification for more detail on server permitted changes. |
| 400 Bad Request | The resource could not be parsed, or failed basic validation rules. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure. |
| 401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
| 422 Unprocessable Entity | The proposed resource violated server business rules. For example, a required field may be missing or a field may contain a value that is not supported by the API Server. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
Update Operation
Update operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To create a new Immunization resource, an application must perform an HTTP PUT, specifying the content of the resource in the body of the request.
PUT [base]/fhir/Immunization/[id]?{_format=[json|xml]}
Update Operation Parameters
| Parameter | Description |
|---|---|
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
Update Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 200 OK | The resource was updated at the location specified in the HTTP Location header. Note: Unsupported fields will be accepted in a request but will not be persisted to the database. Some fields may be mapped to database specific codes which closely but not perfectly match the input. See the HL7 FHIR specification for more detail on server permitted changes. |
| 400 Bad Request | The resource could not be parsed, or failed basic validation rules. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure. |
| 401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
| 422 Unprocessable Entity | The proposed resource violated server business rules. For example, a required field may be missing or a field may contain a value that is not supported by the API Server. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
Profile Content
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/immunization-profile
Immunization event information
| Name | Flags | Card. | Type | Description & Constraints | |
|---|---|---|---|---|---|
  Immunization | I | 0..* | Immunization | Immunization event information imm-2: If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent. imm-1: If immunization was not administred (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present | |
 meta | S ∑ | 0..1 | Meta | Metadata about the resource | |
 implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created | |
| language | 0..1 | code | Language of the resource content Binding: IETF BCP-47  (required ) | ||
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | ||
 extension | 0..1 | ?? [UriType[http://hl7.org/fhir/StructureDefinition/immunization-VFCEligibility]] | Extensionhttp://hl7.org/fhir/StructureDefinition/immunization-VFCEligibility | ||
 extension | 0..* | Extension | Additional Content defined by implementations | ||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/immunization-VFCEligibility" | ||
 valueString | 1..1 | string | 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 | in-progress | on-hold | completed | entered-in-error | stopped Binding: MedicationAdministrationStatus (required ) | |
| date | 0..1 | dateTime | Vaccination administration date | ||
| vaccineCode | 1..1 | CodeableConcept | Vaccine product administered Binding: Vaccine Administered Value Set (example ) | ||
| extension | 0..* | Extension | Additional Content defined by implementations | ||
 coding | ∑ | Coding | Code defined by a terminology system Slice: Unordered, Closed, by system | ||
| coding | ∑ | 0..2 | Coding | Code defined by a terminology system | |
| coding | ∑ | 0..1 | Coding | Code defined by a terminology system | |
| coding | ∑ | 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 | ||
| wasNotGiven | ?! | 1..1 | boolean | Flag for whether immunization was given | |
| reported | 1..1 | boolean | Indicates a self-reported record | ||
| performer | 0..1 | Reference (Practitioner ) | Who administered vaccine | ||
| requester | 0..1 | Reference (Practitioner ) | Who ordered vaccination | ||
| encounter | 0..1 | Reference (Encounter ) | Encounter administered as part of | ||
| manufacturer | 0..1 | Reference (Organization ) | Vaccine manufacturer | ||
| location | 0..1 | Reference (Location ) | Where vaccination occurred | ||
| lotNumber | 0..1 | string | Vaccine lot number | ||
| expirationDate | 0..1 | date | Vaccine expiration date | ||
| site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: Codes for Immunization Site of Administration (example ) | ||
| route | 0..1 | CodeableConcept | How vaccine entered body Binding: Immunization Route Codes (example ) | ||
| doseQuantity | ∑ I | 0..1 | SimpleQuantity | Amount of vaccine administered qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | |
| note | ∑ | 0..* | Annotation | Vaccination notes | |
| explanation | 0..1 | BackboneElement | Administration/non-administration reasons | ||
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| reason | 0..* | CodeableConcept | Why immunization occurred Binding: Immunization Reason Codes (example ) | ||
| reasonNotGiven | 0..* | CodeableConcept | Why immunization did not occur Binding: Immunization Reasons for Not Immunizing Codes (example ) | ||
| reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | ||
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| date | 0..1 | dateTime | When reaction started | ||
| detail | 0..1 | Reference (Observation ) | Additional information on reaction | ||
| reported | 0..1 | boolean | Indicates self-reported reaction | ||
| vaccinationProtocol | 0..* | BackboneElement | What protocol was followed | ||
 extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| doseSequence | 1..1 | positiveInt | Dose number within series | ||
| description | 0..1 | string | Details of vaccine protocol | ||
| authority | 0..1 | Reference (Organization ) | Who is responsible for protocol | ||
| series | 0..1 | string | Name of vaccine series | ||
| seriesDoses | 0..1 | positiveInt | Recommended number of doses for immunity | ||
| targetDisease | 1..* | CodeableConcept | Disease immunized against Binding: Vaccination Protocol Dose Target Codes (example ) | ||
| doseStatus | 1..1 | CodeableConcept | Indicates if dose counts towards immunity Binding: Vaccination Protocol Dose Status codes (example ) | ||
| doseStatusReason | 0..1 | CodeableConcept | Why dose does (not) count Binding: Vaccination Protocol Dose Status Reason codes (example ) | ||
athenaFlow Mapping
The mappings in this section represent the how data stored within athenaFlow is served through the product's APIs. Use of this information is subject to the the API Server Terms and Conditions.
| Immunization Profile | ||
| Immunization | Immunization-Profile | FHIR_IMMUNIZATIONVIEW |
| ├ id | %IMMUNIZATIONGROUPID% | |
| ├ extension | VFCEligibility | |
| │ └ valueString | %VFCELIGIBILITY% | |
| ├ identifier | External Immunization Identifier | MakeIdentifier("U",getSiteSystem("ImmunizationId"),%IMMUNIZATIONGROUPID%) |
| ├ status | MapCode(%GIVENSTATUS%, "IMMUNIZATIONGIVENSTATUS") | |
| ├ date | MakeDateToPrecision(%ADMINISTEREDDATE%,%ADMINISTEREDDATETYPE%) | |
| │ ├ coding | Vaccine codes | |
| │ ├ coding | CVX Code | MakeCoding(%CVXCODE%,"http://hl7.org/fhir/sid/cvx", %VACCINENAME%) |
| │ └ coding | MVX Code | MakeCoding(%MANUFACTURERCODE%,"http://hl7.org/fhir/sid/mvx", %MANUFACTURER%) |
| ├ patient | MakeReference("PATIENT",%PID%,"Patient") | |
| ├ wasNotGiven | Equals("N",%WASGIVEN%) | |
| ├ reported | Equals("Y",%HISTORICAL%) | |
| ├ performer | MakeReference("USR",%ADMINISTEREDBYPVID%,"Practitioner") | |
| ├ encounter | MakeReference("DOCUMENT",%SDID%,"Encounter") | |
| ├ location | MakeReference("LOCREG",%DOCLOCATIONID%,"Location") | |
| ├ lotNumber | %LOTNUMBER% | |
| ├ expirationDate | %EXPIRATIONDATE% | |
| ├ site | MapConcept(%SITECODE%,"IMMUNIZATIONSITE") | |
| ├ route | MakeConcept(%ROUTECODE%,"http://ncimeta.nci.nih.gov",%ROUTE%) | |
| ├ doseQuantity | MakeNonZeroQuantity(%ADMINISTEREDDOSE%,%ADMINISTEREDDOSEUNITS%) | |
| └ note | IfEqual( %WASGIVEN%,"N").Then(MakeAnnotation(%ADMINISTEREDCOMMENTS%)) | |
| ├ reason | IfEqual( %WASGIVEN%,"Y").Then(MakeTextConcept(%ADMINISTEREDCOMMENTS%)) | |
| ├ reasonNotGiven | IfEqual( %WASGIVEN%,"N").Then(MakeTextConcept(%REASONNOTGIVEN%)) | |
| ├ date | MakeDateToPrecision(%ADVREACTIONDATETIME%, %ADVREACTIONDATETIMETYPE%) | |
| ├ detail | MakeTextReference(%ADVREACTIONCOMMENTS%) | |
| ├ doseSequence | %SERIES% | |
| └ description | %VACCINEGROUPNAME% | |