Create an immunization
post
/Immunization
Creates a new immunization.
Note: Only the body fields mentioned below are supported. Unsupported fields are ignored or can result in errors.
Authorization Types
This operation supports the following authorization types:
Request
Supported Media Types
- application/fhir+json
Header Parameters
-
Authorization(required): string
Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer token.
-
accept(required): string
The media type to be requested. See what the resource's operation produces for what is supported.
The body of the create operation
Root Schema : ImmunizationCreate
Type:
object
A summary representation of the create (POST) operation for an immunization.
Show Source
-
doseQuantity:
object doseQuantity
The quantity of vaccine product that was administered.
Example:{ "doseQuantity": { "value": 1.5, "unit": "mL", "system": "http://unitsofmeasure.org", "code": "mL" } }
-
encounter(required):
object encounter
The visit, admission, or other contact between the patient and healthcare provider that the immunization was part of.
Note:encounter
is a required field to create charted immunizations.encounter
is not a required field to create staged immunizations.
{ "encounter": { "reference": "Encounter/36209678" } }
-
expirationDate:
string
The date when the vaccine batch expires.
Example:{ "expirationDate": "2019-07-30" }
-
lotNumber:
string
The lot number of the vaccine product.
Example:{ "lotNumber": "123ab", }
-
manufacturer:
object manufacturer
The name of the vaccine manufacturer.
Example:{ "manufacturer": { "display": "Adams Laboratories" } }
-
note:
array note
Extra information about the immunization that is not conveyed by the other attributes.
Example:{ "authorReference": { "reference": "Practitioner/2028012", "display": "Doe, Jane" }, "time": "2019-06-09T14:03:26-05:00", "text": "Additional details" }
-
occurrenceDateTime(required):
string
The date when the vaccine was administered or to be administered.
Example:{ "occurrenceDateTime": "2019-07-05T10:35:00-05:00" }
-
patient(required):
object patient
The patient who received or did not receive the immunization.
Example:{ "patient": { "reference": "Patient/123820084", "display": "Immun, Test1" } }
-
performer:
array performer
Indicates who performed the immunization event.
Example:{ "performer": [ { "function": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0443", "code": "AP", "display": "Administering Provider" } ], "text": "Administering Provider" }, "actor": { "reference": "Practitioner/7750958", "display": "Doe, John" } } ] }
-
primarySource:
boolean
An indication that the content of the record is based on information from the person who administered the vaccine.
Note:- Set to
true
if not specified. - For a create action, should not be set to
true
whenreportOrigin
is populated. - For an update action, should not be set to
true
.
{ "primarySource": true }
- Set to
-
reportOrigin:
object reportOrigin
The source of an immunization record when not reported by the person who administered the vaccine.
Note: Should not be supplied whenprimarySource
is set totrue
.
Example:{ "reportOrigin": { "coding": [ { "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/30200", "code": "20738688", "display": "Primary Care Provider", "userSelected": false } ], "text": "Primary Care Provider" } }
-
resourceType(required):
string
Allowed Values:
[ "Immunization" ]
The type of the FHIR resource. -
route:
object route
The path by which the vaccine product was taken into the body.
Example:{ "route": { "coding": [ { "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4001", "code": "318167", "display": "IM", "userSelected": false } ], "text": "IM" } }
-
site:
object site
The body site where the vaccine was administered.
Example:{ "site": { "coding": [ { "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/97", "code": "576", "display": "Left Arm", "userSelected": false } ], "text": "Left Arm" } }
-
status(required):
string
Indicates the current status of the immunization event.
Example:{ "status": "completed" }
-
statusReason:
object statusReason
The reason the immunization was not performed.
Note: This parameter is generally only used for the status ofnot-done
.
Example:{ "statusReason": { "coding": [ { "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/30440", "code": "679607", "display": "Patient Refuses", "userSelected": true } ], "text": "Patient Refuses" } }
-
vaccineCode(required):
object vaccineCode
The vaccine that was administered or was to be administered.
Example:{ "vaccineCode": { "coding": [ { "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72", "code": "2797921", "display": "hepatitis A-hepatitis B vaccine", "userSelected": false } ], "text": "hepatitis A-hepatitis B vaccine" } }
Nested Schema : doseQuantity
Type:
object
The quantity of vaccine product that was administered.
Example:
Show Source
Example:
{
"doseQuantity": {
"value": 1.5,
"unit": "mL",
"system": "http://unitsofmeasure.org",
"code": "mL"
}
}
Nested Schema : encounter
Type:
object
The visit, admission, or other contact between the patient and healthcare provider that the immunization was part of.
Note:
Show Source
Note:
encounter
is a required field to create charted immunizations.encounter
is not a required field to create staged immunizations.
{
"encounter": {
"reference": "Encounter/36209678"
}
}
Nested Schema : manufacturer
Type:
object
The name of the vaccine manufacturer.
Example:
Show Source
Example:
{
"manufacturer": {
"display": "Adams Laboratories"
}
}
Nested Schema : note
Type:
array
Extra information about the immunization that is not conveyed by the other attributes.
Example:
Show Source
Example:
{
"authorReference": {
"reference": "Practitioner/2028012",
"display": "Doe, Jane"
},
"time": "2019-06-09T14:03:26-05:00",
"text": "Additional details"
}
Nested Schema : patient
Type:
object
The patient who received or did not receive the immunization.
Example:
Show Source
Example:
{
"patient": {
"reference": "Patient/123820084",
"display": "Immun, Test1"
}
}
Nested Schema : performer
Type:
array
Indicates who performed the immunization event.
Example:
Show Source
Example:
{
"performer": [
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0443",
"code": "AP",
"display": "Administering Provider"
}
],
"text": "Administering Provider"
},
"actor": {
"reference": "Practitioner/7750958",
"display": "Doe, John"
}
}
]
}
Nested Schema : reportOrigin
Type:
object
The source of an immunization record when not reported by the person who administered the vaccine.
Note: Should not be supplied when
Example:
Show Source
Note: Should not be supplied when
primarySource
is set to true
.Example:
{
"reportOrigin": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/30200",
"code": "20738688",
"display": "Primary Care Provider",
"userSelected": false
}
],
"text": "Primary Care Provider"
}
}
Nested Schema : route
Type:
object
The path by which the vaccine product was taken into the body.
Example:
Show Source
Example:
{
"route": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4001",
"code": "318167",
"display": "IM",
"userSelected": false
}
],
"text": "IM"
}
}
Nested Schema : site
Type:
object
The body site where the vaccine was administered.
Example:
Show Source
Example:
{
"site": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/97",
"code": "576",
"display": "Left Arm",
"userSelected": false
}
],
"text": "Left Arm"
}
}
Nested Schema : statusReason
Type:
object
The reason the immunization was not performed.
Note: This parameter is generally only used for the status of
Example:
Show Source
Note: This parameter is generally only used for the status of
not-done
.Example:
{
"statusReason": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/30440",
"code": "679607",
"display": "Patient Refuses",
"userSelected": true
}
],
"text": "Patient Refuses"
}
}
Nested Schema : vaccineCode
Type:
object
The vaccine that was administered or was to be administered.
Example:
Show Source
Example:
{
"vaccineCode": {
"coding": [
{
"system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
"code": "2797921",
"display": "hepatitis A-hepatitis B vaccine",
"userSelected": false
}
],
"text": "hepatitis A-hepatitis B vaccine"
}
}
Nested Schema : items
Type:
Show Source
object
-
performer.actor:
object performer.actor
The practitioner or organization who performed the action.
Example:{ "actor": { "reference": "Practitioner/7750958", "display": "Doe, John" } }
-
performer.function:
object performer.function
Describes the type of performance (such as ordering provider, administering provider, and so on).
Example:{ "function": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0443", "code": "OP", "display": "Ordering Provider" } ], "text": "Ordering Provider" } }
Nested Schema : performer.actor
Type:
object
The practitioner or organization who performed the action.
Example:
Show Source
Example:
{
"actor": {
"reference": "Practitioner/7750958",
"display": "Doe, John"
}
}
Nested Schema : performer.function
Type:
object
Describes the type of performance (such as ordering provider, administering provider, and so on).
Example:
Show Source
Example:
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0443",
"code": "OP",
"display": "Ordering Provider"
}
],
"text": "Ordering Provider"
}
}
Response
Supported Media Types
- application/fhir+json
Default Response
Example Request:
POST https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization
Example Request Body:
{
'resourceType': 'Immunization',
'status': 'completed',
'occurrenceDateTime': '2019-06-30T10:35:00-05:00',
'vaccineCode': {
'coding': [
{
'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72',
'code': '2798767',
'display': 'tetanus toxoid',
'userSelected': false
}
],
'text': 'tetanus toxoid'
},
'patient': {
'reference': 'Patient/12724066'
},
'encounter': {
'reference': 'Encounter/97939518'
},
'reportOrigin': {
'coding': [
{
'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/30200',
'code': '679978',
'display': 'Self',
'userSelected': true
}
],
'text': 'Self'
},
# TODO: Update Site and Route
'site': {
'coding': [
{
'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/97',
'code': '610',
'display': 'Right Hand',
'userSelected': false
}
],
'text': 'Right Hand'
},
'route': {
'coding': [
{
'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/4001',
'code': '318167',
'display': 'IM',
'userSelected': false
}
],
'text': 'IM'
}
}
Example Response:
Cache-Control: no-cache
Content-Length: 0
Content-Type: application/fhir+json
Date: Sun, 30 Jun 2019 10:35:00 GMT
Etag: W/"1"
Last-Modified: Sun, 30 Jun 2019 10:35:00 GMT
Location: https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/147391087
Vary: Origin
opc-request-id: /11111111111111111111111111111111/11111111111111111111111111111111
X-Request-Id: 11111111-1111-1111-1111-111111111111
The ETag
response header indicates the current If-Match
version to use on a subsequent update.
Headers
-
Etag: string
For Update or Patch versioning controls. Related to
If-Match
. When a resource performs an operation that creates or updates a record, anEtag
value is returned as a header. This same value should be included in request headers as anIf-Match
for any subsequent update to that record. -
X-Request-Id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
X-Request-Id
, if present. -
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the
opc-Request-Id
, if present.