Home
API reference
FHIR® API
FHIR® resources
Immunization
$write

Immunization $write

post/Immunization/$write
Page View

This resource contains details for a vaccine that was administered or recorded by a healthcare organization. The immunization record can be reported by the patient, clinician, or another entity. As a tip, the terms immunization and vaccination are used interchangeably in FHIR®.

You can receive, retrieve, or save immunization records.

$write

This operation allows you to save new or updated vaccine administration details for an immunization record in the patient’s chart.

Request parameters and payload

cURL request example

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Immunization/$write' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/fhir+json' \
5
--data '{
6
  "resourceType": "Bundle",
7
  "id": "RedoxImmunizationMessageExample",
8
  "type": "message",
9
  "timestamp": "2021-12-17T20:33:22.422Z",
10
  "entry": [
11
    {
12
      "resource": {
13
        "resourceType": "MessageHeader",
14
        "id": "RedoxMessageHeaderExample",
15
        "source": {
16
          "name": "Good Health Clinics",
17
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
18
        },
19
        "eventCoding": {
20
          "system": "urn:redox:event-type",
21
          "code": "Immunization-New"
22
        }
23
      }
24
    },
25
    {
26
      "resource": {
27
        "resourceType": "Immunization",
28
        "id": "RedoxImmunizationExampleMinimumCompleted",
29
        "identifier": [
30
          {
31
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
32
            "value": "4620975"
33
          }
34
        ],
35
        "patient": {
36
          "reference": "Patient/RedoxPatientExampleTimothy"
37
        },
38
        "occurrenceDateTime": "2022-02-07T18:00:00.000Z",
39
        "status": "completed",
40
        "vaccineCode": {
41
          "coding": [
42
            {
43
              "code": "88",
44
              "system": "urn:oid:2.16.840.1.113883.6.59",
45
              "display": "Influenza virus vaccine"
46
            }
47
          ]
48
        },
49
        "manufacturer": {
50
          "display": "Health LS - Immuno Inc."
51
        },
52
        "route": {
53
          "coding": [
54
            {
55
              "code": "C28161",
56
              "system": "urn:oid:2.16.840.1.113883.3.26.1.1",
57
              "display": "Intramuscular injection"
58
            }
59
          ]
60
        },
61
        "doseQuantity": {
62
          "value": 50,
63
          "unit": "mcg"
64
        },
65
        "lotNumber": "AAJN11K"
66
      }
67
    },
68
    {
69
      "resource": {
70
        "resourceType": "Patient",
71
        "id": "RedoxPatientExampleTimothyMinimal",
72
        "identifier": [
73
          {
74
            "value": "0000000001",
75
            "system": "urn:redox:health-one:MR"
76
          },
77
          {
78
            "value": "101-01-0001",
79
            "system": "http://hl7.org/fhir/sid/us-ssn"
80
          }
81
        ],
82
        "name": [
83
          {
84
            "given": [
85
              "Timothy",
86
              "Paul"
87
            ],
88
            "family": "Bixby"
89
          }
90
        ],
91
        "gender": "male",
92
        "birthDate": "2008-01-06"
93
      }
94
    }
95
  ]
96
}'

Request Body Schema

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Identifies this bundle as a message

    Value: message
  • entry
    required, Array of MessageHeader, Immunization, Patient or Other

    An array of FHIR resources. At a minimum, an Immunization should include the following entries:

    • Immunization - A record of an immunization that was administered to a patient
    • Patient - The patient who was administered the immunization

    If other resources are included, due to being referenced within an entry, they should conform to the applicable Redox profile.

      An entry in the bundle containing a FHIR resource

    • resource
      required, object

      Additional metadata about the message including the event

      • resourceType
        required, string

        Identifies the type of the resource

        Value: MessageHeader
      • source
        required, object

        Information about the sender of the message. This will typically be populated by Redox.

        • endpoint
          required, string

          Identifies the routing target to send acknowledgements to.

        • name
          string

          Human-readable name for the source system.

      • eventCoding
        required, object

        This describes the message being communicated

        • system
          string

          The identification of the code system that defines the meaning of the symbol in the code.

        • code
          string

          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

          Value: Immunization-New
  • timestamp
    string

    The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

Response fields and example

Example

1
"Operation Response"