Jump to

• Request
• Response

Get an immunization by ID

get

/Immunization/{id}

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

Retrieves an individual immunization by the associated ID.

Request

Path Parameters

• id(required): string
  The logical resource ID.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

There's no request body for this operation.

Back to Top

Response

200 Response

The successful retrieve response.

Body ()

Root Schema : Immunization

Type: object

The FHIR R4 Immunization resource.

Show Source

• _occurrenceDateTime: object ElementForImmunization
• doseQuantity: object Quantity
• encounter: object ReferenceForImmunization
• expirationDate: string (date)
• id(required): string
• location: object ReferenceForImmunization
• lotNumber: string
• manufacturer: object ReferenceForImmunization
• meta: object meta
• note: array note
• occurrenceDateTime: string (date-time)
• patient(required): object ReferenceForImmunization
• performer: array performer
• primarySource(required): boolean
• protocolApplied(required): array protocolApplied
• reportOrigin: object CodeableConcept
• resourceType(required): string
  Allowed Values: [ "Immunization" ]
• route: object CodeableConcept
• site: object CodeableConcept
• status(required): string
  Allowed Values: [ "completed", "not-done", "entered-in-error" ]
• statusReason: object CodeableConcept
• text(required): object Narrative
• vaccineCode(required): object CodeableConcept

{
    "type":"object",
    "description":"The FHIR R4 Immunization resource.",
    "required":[
        "resourceType",
        "id",
        "text",
        "vaccineCode",
        "status",
        "patient",
        "primarySource",
        "protocolApplied"
    ],
    "additionalProperties":false,
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Immunization"
            ]
        },
        "id":{
            "type":"string"
        },
        "meta":{
            "type":"object",
            "properties":{
                "versionId":{
                    "type":"string"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time"
                },
                "security":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Coding"
                    }
                }
            }
        },
        "text":{
            "$ref":"#/components/schemas/Narrative"
        },
        "status":{
            "type":"string",
            "enum":[
                "completed",
                "not-done",
                "entered-in-error"
            ]
        },
        "statusReason":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "vaccineCode":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "patient":{
            "$ref":"#/components/schemas/ReferenceForImmunization"
        },
        "encounter":{
            "$ref":"#/components/schemas/ReferenceForImmunization"
        },
        "occurrenceDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "_occurrenceDateTime":{
            "$ref":"#/components/schemas/ElementForImmunization"
        },
        "primarySource":{
            "type":"boolean"
        },
        "reportOrigin":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "location":{
            "$ref":"#/components/schemas/ReferenceForImmunization"
        },
        "manufacturer":{
            "$ref":"#/components/schemas/ReferenceForImmunization"
        },
        "lotNumber":{
            "type":"string"
        },
        "expirationDate":{
            "type":"string",
            "format":"date"
        },
        "site":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "route":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "doseQuantity":{
            "$ref":"#/components/schemas/Quantity"
        },
        "performer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PerformerForImmunization"
            }
        },
        "note":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AnnotationForImmunization"
            }
        },
        "protocolApplied":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProtocolAppliedForImmunization"
            }
        }
    }
}

Nested Schema : ElementForImmunization

Type: object

Show Source

• extension: array extension

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForImmunization"
            }
        }
    }
}

Nested Schema : Quantity

Type: object

Show Source

• code: string
• comparator: string
• system: string
• unit: string
• value: number

{
    "type":"object",
    "properties":{
        "value":{
            "type":"number"
        },
        "comparator":{
            "type":"string"
        },
        "unit":{
            "type":"string"
        },
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Nested Schema : ReferenceForImmunization

Type: object

Show Source

• display: string
• reference: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "reference":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : meta

Type: object

Show Source

• lastUpdated: string (date-time)
• security: array security
• versionId: string

{
    "type":"object",
    "properties":{
        "versionId":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "security":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        }
    }
}

Nested Schema : note

Type: array

Show Source

• Array of: object AnnotationForImmunization

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AnnotationForImmunization"
    }
}

Nested Schema : performer

Type: array

Show Source

• Array of: object PerformerForImmunization

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PerformerForImmunization"
    }
}

Nested Schema : protocolApplied

Type: array

Show Source

• Array of: object ProtocolAppliedForImmunization

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProtocolAppliedForImmunization"
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : Narrative

Type: object

Show Source

• div: string
  The XHTML narrative content.
• status: string
  The narrative generation status.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"The narrative generation status."
        },
        "div":{
            "type":"string",
            "description":"The XHTML narrative content."
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForImmunization

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForImmunization"
    }
}

Nested Schema : ExtensionForImmunization

Type: object

Show Source

• url: string (uri)
• valueCode: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "url":{
            "type":"string",
            "format":"uri"
        },
        "valueCode":{
            "type":"string"
        }
    }
}

Nested Schema : security

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : AnnotationForImmunization

Type: object

Show Source

• authorReference: object ReferenceForImmunization
• text(required): string
• time: string (date-time)

{
    "type":"object",
    "additionalProperties":false,
    "required":[
        "text"
    ],
    "properties":{
        "authorReference":{
            "$ref":"#/components/schemas/ReferenceForImmunization"
        },
        "time":{
            "type":"string",
            "format":"date-time"
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : PerformerForImmunization

Type: object

Show Source

• actor: object ReferenceForImmunization
• function: object CodeableConcept

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "function":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "actor":{
            "$ref":"#/components/schemas/ReferenceForImmunization"
        }
    }
}

Nested Schema : ProtocolAppliedForImmunization

Type: object

Show Source

• doseNumberString(required): string
• targetDisease: array targetDisease

{
    "type":"object",
    "additionalProperties":false,
    "required":[
        "doseNumberString"
    ],
    "properties":{
        "targetDisease":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "doseNumberString":{
            "type":"string"
        }
    }
}

Nested Schema : targetDisease

Type: array

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top