1. FHIR R4 APIs for Oracle Health Millennium Platform
  2. Tasks
  3. Immunization

Update an immunization

put

/Immunization/{ID}

Updates an immunizations.

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
Path Parameters
Header Parameters
Body ()
The body of the update operation
Root Schema : ImmunizationUpdate
Type: object
A summary representation of the update (PUT) operation for an immunization.
Show Source
  • doseQuantity
    The quantity of vaccine product that was administered.
    Example: 
    {
  "doseQuantity": {
    "value": 1.5,
    "unit": "mL",
    "system": "http://unitsofmeasure.org",
    "code": "mL"
  }
}
  • encounter
    The visit, admission, or other contact between the patient and healthcare provider the immunization was part of.
    Example: 
    {
  "encounter": {
    "reference": "Encounter/36209678"
  }
}
  • The date when the vaccine batch expires.
    Example: 
    {
  "expirationDate": "2019-07-30"
}
  • The logical ID of the resource.
    Example: 
    {
  "id": "M43434511"
}
  • The lot number of the vaccine product.
    Example: 
    {
  "lotNumber": "123ab",
}
  • manufacturer
    The name of the vaccine manufacturer.
    Example: 
    {
  "manufacturer": {
    "display": "Adams Laboratories"
  }
}
  • 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"
}
  • The date when the vaccine was administered or to be administered.
    Example: 
    {
  "occurrenceDateTime": "2019-07-05T10:35:00-05:00"
}
  • patient
    The patient who received or did not receive the immunization.
    Example: 
    {
  "patient": {
    "reference": "Patient/123820084",
    "display": "Immun, Test1"
  }
}
  • 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"
      }
    }
  ]
}
  • 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 when reportOrigin is populated.
    • For an update action, should not be set to true.
    Example: 
    {
  "primarySource": true
}
  • reportOrigin
    The source of an immunization record when not reported by the person who administered the vaccine.
    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"
  }
}
  • Allowed Values: [ "Immunization" ]
    The type of the FHIR resource.
  • 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
    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"
  }
}
  • Indicates the current status of the immunization event.
    Example: 
    {
  "status": "completed"
}
  • statusReason
    The reason why the immunization was not performed.
    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"
  }
}
  • vaccineCode
    The vaccine that was administered or will 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: 
{
  "doseQuantity": {
    "value": 1.5,
    "unit": "mL",
    "system": "http://unitsofmeasure.org",
    "code": "mL"
  }
}
Show Source
Nested Schema : encounter
Type: object
The visit, admission, or other contact between the patient and healthcare provider the immunization was part of.
Example: 
{
  "encounter": {
    "reference": "Encounter/36209678"
  }
}
Show Source
Nested Schema : manufacturer
Type: object
The name of the vaccine manufacturer.
Example: 
{
  "manufacturer": {
    "display": "Adams Laboratories"
  }
}
Show Source
Nested Schema : note
Type: array
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"
}
Show Source
Nested Schema : patient
Type: object
The patient who received or did not receive the immunization.
Example: 
{
  "patient": {
    "reference": "Patient/123820084",
    "display": "Immun, Test1"
  }
}
Show Source
Nested Schema : performer
Type: array
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"
      }
    }
  ]
}
Show Source
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 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"
  }
}
Show Source
Nested Schema : route
Type: object
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"
  }
}
Show Source
Nested Schema : site
Type: object
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"
  }
}
Show Source
Nested Schema : statusReason
Type: object
The reason why the immunization was not performed.
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"
  }
}
Show Source
Nested Schema : vaccineCode
Type: object
The vaccine that was administered or will 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"
  }
}
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : authorReference
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
  • performer.actor
    The practitioner or organization who performed the action.
    Example: 
    {
  "actor": {
    "reference": "Practitioner/7750958",
    "display": "Doe, John"
  }
}
  • 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: 
{
  "actor": {
    "reference": "Practitioner/7750958",
    "display": "Doe, John"
  }
}
Show Source
Nested Schema : performer.function
Type: object
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"
  }
}
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

Example Request: 
PUT https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/M197197986
Example Request Body: 
{
    'resourceType': 'Immunization',
    'id': 'M197197986',
    'status': 'completed',
    'occurrenceDateTime': '2019-07-15T10:35:00-05:00',
    'vaccineCode': {
      'coding': [
        {
          'system': 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72',
          'code': '2798767',
          'display': 'tetanus toxoid',
          'userSelected': true
        }
      ],
      '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'
    },
    'performer': [
      {
        'function': {
          'coding': [
            {
              'system': 'http://terminology.hl7.org/CodeSystem/v2-0443',
              'code': 'AP',
              'display': 'Administering Provider'
            }
          ],
          'text': 'Administering Provider'
        },
        'actor': {
          'reference': 'Practitioner/4122622'
        }
      }
    ]
  }
Example Response: 
  Cache-Control: no-cache
  Content-Length: 0
  Content-Type: application/fhir+json
  Date: Sun, 30 Jun 2019 10:40:00 GMT
  Etag: W/"2"
  Last-Modified: Sun, 30 Jun 2019 10:40:00 GMT
  Vary: Origin
  X-Request-Id: b72617f9-1a52-46ca-bb52-b0b3f976f9fb
The ETag response header indicates the current If-Match version to use on a subsequent update.
Headers
  • For Update or Patch versioning controls. Related to If-Match. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
  • For Update or Patch versioning controls. Related to Etag. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.
Back to Top