Home
FHIR® API actions
Medication
Submit vaccination details to a state registry

Submit vaccination details to a state registry

This API action is useful if your organization administers and tracks vaccinations. State registries may find this data useful for tracking population health, like in the case of COVID-19 vaccinations. Typically, you can use this for: 

  • documenting administration of vaccines;
  • documenting historical vaccinations for a patient; and
  • sending details of completed vaccinations to a state organization.

Supported systems

You can send writeback messages for this API action with the Redox FHIR® API.

Your connection's system can receive and process writeback messages with their own FHIR® or proprietary API.

Things you need to know

Action steps

  • 1
    Submit vaccination details to a state registry
    required

This table has notes about how to use parameters for this API action specifically, but it's not exhaustive. Refer to the Immunization resource schema for more details.

Parameter
Required
Notes
Patient
Y
A reference to the related Patient resource for the patient that received the vaccine.
Immunization
Y
A unique identifier assigned to this immunization record.

Immunization/$write
curl 'https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Immunization/$write' \
--request POST \
--header 'Authorization: Bearer ${API_TOKEN}' \
--header 'Content-Type: application/json' \
--data '{
  "id": "KevaGreenFluImmunization",
  "meta": {
    "profile": [
      "https://fhir.redoxengine.com/StructureDefinition/redox-immunization-message-bundle"
    ]
  },
  "type": "message",
  "entry": [
    {
      "resource": {
        "id": "RedoxMessageHeaderExample",
        "meta": {
          "profile": [
            "https://fhir.redoxengine.com/StructureDefinition/redox-message-header"
          ]
        },
        "source": {
          "name": "Good Health Clinics",
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
        },
        "eventCoding": {
          "system": "urn:redox:event-type"
        },
        "resourceType": "MessageHeader"
      }
    },
    {
      "resource": {
        "id": "03e815f8-9804-38e8-0444-c8af20faa4a9",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
          ]
        },
        "status": "completed",
        "patient": {
          "reference": "Patient/81c2f5eb-f99f-40c4-b504-59483e6148d7"
        },
        "location": {
          "display": "AGELESS WELLNESS CENTER, INC",
          "reference": "Location/a5cc27d1-5c70-39f8-a9c4-2f3696988650"
        },
        "encounter": {
          "reference": "80a02b93-1ecb-f5e1-6430-1a31163f7618"
        },
        "lotNumber": "AAJN11K",
        "vaccineCode": {
          "text": "Influenza, seasonal, injectable, preservative free",
          "coding": [
            {
              "code": "140",
              "system": "http://hl7.org/fhir/sid/cvx",
              "display": "Influenza, seasonal, injectable, preservative free"
            }
          ]
        },
        "resourceType": "Immunization",
        "primarySource": true,
        "occurrenceDateTime": "2021-01-14T13:10:39-10:00"
      }
    },
    {
      "resource": {
        "id": "81c2f5eb-f99f-40c4-b504-59483e6148d7",
        "link": [
          {
            "type": "replaces",
            "other": {
              "reference": "Patient/69efd2ea-1256-4ae7-b4ec-5d0160427185"
            }
          }
        ],
        "meta": {
          "profile": [
            "https://fhir.redoxengine.com/StructureDefinition/redox-patient"
          ],
          "lastUpdated": "2022-12-01T21:57:23.879Z"
        },
        "name": [
          {
            "use": "official",
            "given": [
              "Keva"
            ],
            "family": "Green"
          }
        ],
        "active": true,
        "gender": "female",
        "address": [
          {
            "use": "home",
            "city": "Hillsboro",
            "line": [
              "932 Stehr Vista"
            ],
            "state": "OR",
            "country": "US",
            "postalCode": "97123"
          }
        ],
        "telecom": [
          {
            "use": "home",
            "value": "+18088675302",
            "system": "phone"
          },
          {
            "value": "Keva.Green-95@test.net",
            "system": "email"
          }
        ],
        "birthDate": "1995-08-26",
        "extension": [
          {
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
            "extension": [
              {
                "url": "text",
                "valueString": "White"
              },
              {
                "url": "ombCategory",
                "valueCoding": {
                  "code": "2106-3",
                  "system": "urn:oid:2.16.840.1.113883.6.238",
                  "display": "White"
                }
              }
            ]
          }
        ],
        "identifier": [
          {
            "value": "kyHGADnvX3xbkU4V9ayaqh",
            "system": "urn:redox:redox-fhir-sandbox:MR"
          },
          {
            "use": "secondary",
            "value": "483749",
            "system": "urn:redox:redox-fhir-sandbox:MR"
          }
        ],
        "resourceType": "Patient"
      }
    }
  ],
  "resourceType": "Bundle"
}'