# Create FHIR r4 immunization

Endpoint: POST /site/{siteId}/fhir/immunization
Version: 1.0
Security: bearer, bearer

## Path parameters:

  - `siteId` (string, required)
    Site identifier

## Request fields (application/json):

  - `resourceType` (any, required)
    This is a Immunization resource
    Enum: "Immunization"

  - `id` (string)
    Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters.  (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.)  Ids are case-insensitive.
    Example: "example-id"

  - `meta` (object)
    The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

  - `meta.id` (string)
    An extension object type #string.
    Example: "example-string"

  - `meta.extension` (array)
    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `meta.versionId` (object)
    An extension object type #id.

  - `meta._versionId` (object)
    An extension object type #Element.

  - `meta.lastUpdated` (object)
    An extension object type #instant.

  - `meta._lastUpdated` (object)
    An extension object type #Element.

  - `meta.source` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `meta._source` (object)
    An extension object type #Element.

  - `meta.profile` (array)
    A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
    Example: ["http://example.org/Profile"]

  - `meta.security` (array)
    Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

  - `meta.tag` (array)
    Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

  - `implicitRules` (string)
    String of characters used to identify a name or a resource
    Example: "https://example.org/resource"

  - `_implicitRules` (object)
    Base definition for all elements in a resource.

  - `language` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_language` (object)
    Base definition for all elements in a resource.

  - `text` (object)
    A human-readable summary of the resource conveying the essential clinical and business information for the resource.

  - `text.status` (any)
    The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
    Enum: "generated", "extensions", "additional", "empty"

  - `text._status` (object)
    An extension object type #Element.

  - `text.div` (string, required)
    An extension object type #xhtml.
    Example: "<div>Example</div>"

  - `contained` (array)
    These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

  - `extension` (array)
    May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `extension.url` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `extension._url` (object)
    An extension object type #Element.

  - `extension.valueBase64Binary` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "U2FtcGxl"

  - `extension._valueBase64Binary` (object)
    An extension object type #Element.

  - `extension.valueBoolean` (boolean)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: true

  - `extension._valueBoolean` (object)
    An extension object type #Element.

  - `extension.valueCanonical` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "http://example.org/Profile"

  - `extension._valueCanonical` (object)
    An extension object type #Element.

  - `extension.valueCode` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "sample-code"

  - `extension._valueCode` (object)
    An extension object type #Element.

  - `extension.valueDate` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01"

  - `extension._valueDate` (object)
    An extension object type #Element.

  - `extension.valueDateTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueDateTime` (object)
    An extension object type #Element.

  - `extension.valueDecimal` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1.23

  - `extension._valueDecimal` (object)
    An extension object type #Element.

  - `extension.valueId` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-id"

  - `extension._valueId` (object)
    An extension object type #Element.

  - `extension.valueInstant` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueInstant` (object)
    An extension object type #Element.

  - `extension.valueInteger` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valueInteger` (object)
    An extension object type #Element.

  - `extension.valueMarkdown` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "Sample markdown text"

  - `extension._valueMarkdown` (object)
    An extension object type #Element.

  - `extension.valueOid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:oid:1.2.3.4.5"

  - `extension._valueOid` (object)
    An extension object type #Element.

  - `extension.valuePositiveInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valuePositiveInt` (object)
    An extension object type #Element.

  - `extension.valueString` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-string"

  - `extension._valueString` (object)
    An extension object type #Element.

  - `extension.valueTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "12:00:00"

  - `extension._valueTime` (object)
    An extension object type #Element.

  - `extension.valueUnsignedInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).

  - `extension._valueUnsignedInt` (object)
    An extension object type #Element.

  - `extension.valueUri` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org/resource"

  - `extension._valueUri` (object)
    An extension object type #Element.

  - `extension.valueUrl` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org"

  - `extension._valueUrl` (object)
    An extension object type #Element.

  - `extension.valueUuid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"

  - `extension._valueUuid` (object)
    An extension object type #Element.

  - `extension.valueAddress` (object)
    An extension object type #Address.

  - `extension.valueAge` (object)
    An extension object type #Age.

  - `extension.valueAnnotation` (object)
    An extension object type #Annotation.

  - `extension.valueAttachment` (object)
    An extension object type #Attachment.

  - `extension.valueCodeableConcept` (object)
    An extension object type #CodeableConcept.

  - `extension.valueCoding` (object)
    An extension object type #Coding.

  - `extension.valueContactPoint` (object)
    An extension object type #ContactPoint.

  - `extension.valueCount` (object)
    An extension object type #Count.

  - `extension.valueDistance` (object)
    An extension object type #Distance.

  - `extension.valueDuration` (object)
    An extension object type #Duration.

  - `extension.valueHumanName` (object)
    An extension object type #HumanName.

  - `extension.valueIdentifier` (object)
    An extension object type #Identifier.

  - `extension.valueMoney` (object)
    An extension object type #Money.

  - `extension.valuePeriod` (object)
    An extension object type #Period.

  - `extension.valueQuantity` (object)
    An extension object type #Quantity.

  - `extension.valueRange` (object)
    An extension object type #Range.

  - `extension.valueRatio` (object)
    An extension object type #Ratio.

  - `extension.valueReference` (object)
    An extension object type #Reference.

  - `extension.valueSampledData` (object)
    An extension object type #SampledData.

  - `extension.valueSignature` (object)
    An extension object type #Signature.

  - `extension.valueTiming` (object)
    An extension object type #Timing.

  - `extension.valueContactDetail` (object)
    An extension object type #ContactDetail.

  - `extension.valueContributor` (object)
    An extension object type #Contributor.

  - `extension.valueDataRequirement` (object)
    An extension object type #DataRequirement.

  - `extension.valueExpression` (object)
    An extension object type #Expression.

  - `extension.valueParameterDefinition` (object)
    An extension object type #ParameterDefinition.

  - `extension.valueRelatedArtifact` (object)
    An extension object type #RelatedArtifact.

  - `extension.valueTriggerDefinition` (object)
    An extension object type #TriggerDefinition.

  - `extension.valueUsageContext` (object)
    An extension object type #UsageContext.

  - `extension.valueDosage` (object)
    An extension object type #Dosage.

  - `extension.valueMeta` (object)
    An extension object type #Meta.

  - `modifierExtension` (array)
    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `identifier` (array)
    A unique identifier assigned to this immunization record.
    Example: [{"system":"urn:ietf:rfc:3986","value":"urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"}]

  - `identifier.use` (any)
    The purpose of this identifier.
    Enum: "usual", "official", "temp", "secondary", "old"

  - `identifier._use` (object)
    An extension object type #Element.

  - `identifier.type` (object)
    An extension object type #CodeableConcept.

  - `identifier.system` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `identifier._system` (object)
    An extension object type #Element.

  - `identifier.value` (string)
    An extension object type #string.
    Example: "example-string"

  - `identifier._value` (object)
    An extension object type #Element.

  - `identifier.period` (object)
    An extension object type #Period.

  - `identifier.assigner` (object)
    An extension object type #Reference.

  - `status` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_status` (object)
    Base definition for all elements in a resource.

  - `statusReason` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `statusReason.coding` (array)
    A reference to a code defined by a terminology system.

  - `statusReason.text` (string)
    An extension object type #string.
    Example: "example-string"

  - `statusReason._text` (object)
    An extension object type #Element.

  - `vaccineCode` (object, required)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `patient` (object, required)
    A reference from one resource to another.

  - `patient.reference` (string)
    An extension object type #string.
    Example: "example-string"

  - `patient._reference` (object)
    An extension object type #Element.

  - `patient.type` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `patient._type` (object)
    An extension object type #Element.

  - `patient.identifier` (object)
    An extension object type #Identifier.

  - `patient.display` (string)
    An extension object type #string.
    Example: "example-string"

  - `patient._display` (object)
    An extension object type #Element.

  - `encounter` (object)
    A reference from one resource to another.

  - `occurrenceDateTime` (string)
    Date vaccine administered or was to be administered.
    Example: "2013-01-10"

  - `_occurrenceDateTime` (object)
    Base definition for all elements in a resource.

  - `occurrenceString` (string)
    Date vaccine administered or was to be administered.
    Example: "example-string"

  - `_occurrenceString` (object)
    Base definition for all elements in a resource.

  - `recorded` (string)
    A date, date-time or partial date (e.g. just year or year + month).  If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored.                 Dates SHALL be valid dates.
    Example: "2024-01-01T00:00:00Z"

  - `_recorded` (object)
    Base definition for all elements in a resource.

  - `primarySource` (boolean)
    Value of "true" or "false"
    Example: true

  - `_primarySource` (object)
    Base definition for all elements in a resource.

  - `reportOrigin` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `location` (object)
    A reference from one resource to another.

  - `manufacturer` (object)
    A reference from one resource to another.

  - `lotNumber` (string)
    A sequence of Unicode characters
    Example: "example-string"

  - `_lotNumber` (object)
    Base definition for all elements in a resource.

  - `expirationDate` (string)
    A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date.  Dates SHALL be valid dates.
    Example: "2024-01-01"

  - `_expirationDate` (object)
    Base definition for all elements in a resource.

  - `site` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `route` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `doseQuantity` (object)
    A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

  - `doseQuantity.value` (number)
    An extension object type #decimal.
    Example: 1.23

  - `doseQuantity.comparator` (any)
    How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
    Enum: "<", "<=", ">=", ">"

  - `doseQuantity._comparator` (object)
    An extension object type #Element.

  - `doseQuantity.unit` (string)
    An extension object type #string.
    Example: "example-string"

  - `doseQuantity._unit` (object)
    An extension object type #Element.

  - `doseQuantity.code` (string)
    An extension object type #code.
    Example: "sample-code"

  - `doseQuantity._code` (object)
    An extension object type #Element.

  - `performer` (array)
    Indicates who performed the immunization event.
    Example: [{"function":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0443","code":"OP"}]},"actor":{"reference":"Practitioner/example"}},{"function":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0443","code":"AP"}]},"actor":{"reference":"Practitioner/example"}}]

  - `performer.modifierExtension` (array)
    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `performer.function` (object)
    An extension object type #CodeableConcept.

  - `performer.actor` (object, required)
    An extension object type #Reference.

  - `note` (array)
    Extra information about the immunization that is not conveyed by the other attributes.
    Example: [{"text":"Notes on adminstration of vaccine"}]

  - `note.authorReference` (object)
    An extension object type #Reference.

  - `note.authorString` (string)
    The individual responsible for making the annotation.
    Example: "example-string"

  - `note._authorString` (object)
    An extension object type #Element.

  - `note.time` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `note._time` (object)
    An extension object type #Element.

  - `note.text` (object)
    An extension object type #markdown.

  - `reasonCode` (array)
    Reasons why the vaccine was administered.
    Example: [{"coding":[{"system":"http://snomed.info/sct","code":"429060002"}]}]

  - `reasonReference` (array)
    Condition, Observation or DiagnosticReport that supports why the immunization was administered.

  - `isSubpotent` (boolean)
    Value of "true" or "false"
    Example: true

  - `_isSubpotent` (object)
    Base definition for all elements in a resource.

  - `subpotentReason` (array)
    Reason why a dose is considered to be subpotent.

  - `education` (array)
    Educational material presented to the patient (or guardian) at the time of vaccine administration.
    Example: [{"documentType":"253088698300010311120702","publicationDate":"2012-07-02","presentationDate":"2013-01-10"}]

  - `education.documentType` (string)
    An extension object type #string.
    Example: "example-string"

  - `education._documentType` (object)
    An extension object type #Element.

  - `education.reference` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `education.publicationDate` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `education._publicationDate` (object)
    An extension object type #Element.

  - `education.presentationDate` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `education._presentationDate` (object)
    An extension object type #Element.

  - `programEligibility` (array)
    Indicates a patient's eligibility for a funding program.
    Example: [{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/immunization-program-eligibility","code":"ineligible"}]}]

  - `fundingSource` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `reaction` (array)
    Categorical data indicating that an adverse event is associated in time to an immunization.

  - `reaction.date` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `reaction._date` (object)
    An extension object type #Element.

  - `reaction.detail` (object)
    An extension object type #Reference.

  - `reaction.reported` (boolean)
    An extension object type #boolean.
    Example: true

  - `reaction._reported` (object)
    An extension object type #Element.

  - `protocolApplied` (array)
    The protocol (set of recommendations) being followed by the provider who administered the dose.

  - `protocolApplied.series` (string)
    An extension object type #string.
    Example: "example-string"

  - `protocolApplied._series` (object)
    An extension object type #Element.

  - `protocolApplied.authority` (object)
    An extension object type #Reference.

  - `protocolApplied.targetDisease` (array)
    The vaccine preventable disease the dose is being administered against.

  - `protocolApplied.doseNumberPositiveInt` (number)
    Nominal position in a series.
    Example: 1

  - `protocolApplied._doseNumberPositiveInt` (object)
    An extension object type #Element.

  - `protocolApplied.doseNumberString` (string)
    Nominal position in a series.
    Example: "example-string"

  - `protocolApplied._doseNumberString` (object)
    An extension object type #Element.

  - `protocolApplied.seriesDosesPositiveInt` (number)
    The recommended number of doses to achieve immunity.
    Example: 1

  - `protocolApplied._seriesDosesPositiveInt` (object)
    An extension object type #Element.

  - `protocolApplied.seriesDosesString` (string)
    The recommended number of doses to achieve immunity.
    Example: "example-string"

  - `protocolApplied._seriesDosesString` (object)
    An extension object type #Element.

## Response 200 fields (application/json):

  - `resourceType` (any, required)
    This is a Immunization resource
    Enum: "Immunization"

  - `id` (string)
    Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters.  (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.)  Ids are case-insensitive.
    Example: "example-id"

  - `meta` (object)
    The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

  - `meta.id` (string)
    An extension object type #string.
    Example: "example-string"

  - `meta.extension` (array)
    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `meta.versionId` (object)
    An extension object type #id.

  - `meta._versionId` (object)
    An extension object type #Element.

  - `meta.lastUpdated` (object)
    An extension object type #instant.

  - `meta._lastUpdated` (object)
    An extension object type #Element.

  - `meta.source` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `meta._source` (object)
    An extension object type #Element.

  - `meta.profile` (array)
    A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
    Example: ["http://example.org/Profile"]

  - `meta.security` (array)
    Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

  - `meta.tag` (array)
    Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

  - `implicitRules` (string)
    String of characters used to identify a name or a resource
    Example: "https://example.org/resource"

  - `_implicitRules` (object)
    Base definition for all elements in a resource.

  - `language` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_language` (object)
    Base definition for all elements in a resource.

  - `text` (object)
    A human-readable summary of the resource conveying the essential clinical and business information for the resource.

  - `text.status` (any)
    The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
    Enum: "generated", "extensions", "additional", "empty"

  - `text._status` (object)
    An extension object type #Element.

  - `text.div` (string, required)
    An extension object type #xhtml.
    Example: "<div>Example</div>"

  - `contained` (array)
    These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

  - `extension` (array)
    May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

  - `extension.url` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `extension._url` (object)
    An extension object type #Element.

  - `extension.valueBase64Binary` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "U2FtcGxl"

  - `extension._valueBase64Binary` (object)
    An extension object type #Element.

  - `extension.valueBoolean` (boolean)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: true

  - `extension._valueBoolean` (object)
    An extension object type #Element.

  - `extension.valueCanonical` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "http://example.org/Profile"

  - `extension._valueCanonical` (object)
    An extension object type #Element.

  - `extension.valueCode` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "sample-code"

  - `extension._valueCode` (object)
    An extension object type #Element.

  - `extension.valueDate` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01"

  - `extension._valueDate` (object)
    An extension object type #Element.

  - `extension.valueDateTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueDateTime` (object)
    An extension object type #Element.

  - `extension.valueDecimal` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1.23

  - `extension._valueDecimal` (object)
    An extension object type #Element.

  - `extension.valueId` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-id"

  - `extension._valueId` (object)
    An extension object type #Element.

  - `extension.valueInstant` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "2024-01-01T00:00:00Z"

  - `extension._valueInstant` (object)
    An extension object type #Element.

  - `extension.valueInteger` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valueInteger` (object)
    An extension object type #Element.

  - `extension.valueMarkdown` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "Sample markdown text"

  - `extension._valueMarkdown` (object)
    An extension object type #Element.

  - `extension.valueOid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:oid:1.2.3.4.5"

  - `extension._valueOid` (object)
    An extension object type #Element.

  - `extension.valuePositiveInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: 1

  - `extension._valuePositiveInt` (object)
    An extension object type #Element.

  - `extension.valueString` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "example-string"

  - `extension._valueString` (object)
    An extension object type #Element.

  - `extension.valueTime` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "12:00:00"

  - `extension._valueTime` (object)
    An extension object type #Element.

  - `extension.valueUnsignedInt` (number)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).

  - `extension._valueUnsignedInt` (object)
    An extension object type #Element.

  - `extension.valueUri` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org/resource"

  - `extension._valueUri` (object)
    An extension object type #Element.

  - `extension.valueUrl` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "https://example.org"

  - `extension._valueUrl` (object)
    An extension object type #Element.

  - `extension.valueUuid` (string)
    Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
    Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"

  - `extension._valueUuid` (object)
    An extension object type #Element.

  - `extension.valueAddress` (object)
    An extension object type #Address.

  - `extension.valueAge` (object)
    An extension object type #Age.

  - `extension.valueAnnotation` (object)
    An extension object type #Annotation.

  - `extension.valueAttachment` (object)
    An extension object type #Attachment.

  - `extension.valueCodeableConcept` (object)
    An extension object type #CodeableConcept.

  - `extension.valueCoding` (object)
    An extension object type #Coding.

  - `extension.valueContactPoint` (object)
    An extension object type #ContactPoint.

  - `extension.valueCount` (object)
    An extension object type #Count.

  - `extension.valueDistance` (object)
    An extension object type #Distance.

  - `extension.valueDuration` (object)
    An extension object type #Duration.

  - `extension.valueHumanName` (object)
    An extension object type #HumanName.

  - `extension.valueIdentifier` (object)
    An extension object type #Identifier.

  - `extension.valueMoney` (object)
    An extension object type #Money.

  - `extension.valuePeriod` (object)
    An extension object type #Period.

  - `extension.valueQuantity` (object)
    An extension object type #Quantity.

  - `extension.valueRange` (object)
    An extension object type #Range.

  - `extension.valueRatio` (object)
    An extension object type #Ratio.

  - `extension.valueReference` (object)
    An extension object type #Reference.

  - `extension.valueSampledData` (object)
    An extension object type #SampledData.

  - `extension.valueSignature` (object)
    An extension object type #Signature.

  - `extension.valueTiming` (object)
    An extension object type #Timing.

  - `extension.valueContactDetail` (object)
    An extension object type #ContactDetail.

  - `extension.valueContributor` (object)
    An extension object type #Contributor.

  - `extension.valueDataRequirement` (object)
    An extension object type #DataRequirement.

  - `extension.valueExpression` (object)
    An extension object type #Expression.

  - `extension.valueParameterDefinition` (object)
    An extension object type #ParameterDefinition.

  - `extension.valueRelatedArtifact` (object)
    An extension object type #RelatedArtifact.

  - `extension.valueTriggerDefinition` (object)
    An extension object type #TriggerDefinition.

  - `extension.valueUsageContext` (object)
    An extension object type #UsageContext.

  - `extension.valueDosage` (object)
    An extension object type #Dosage.

  - `extension.valueMeta` (object)
    An extension object type #Meta.

  - `modifierExtension` (array)
    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `identifier` (array)
    A unique identifier assigned to this immunization record.
    Example: [{"system":"urn:ietf:rfc:3986","value":"urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"}]

  - `identifier.use` (any)
    The purpose of this identifier.
    Enum: "usual", "official", "temp", "secondary", "old"

  - `identifier._use` (object)
    An extension object type #Element.

  - `identifier.type` (object)
    An extension object type #CodeableConcept.

  - `identifier.system` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `identifier._system` (object)
    An extension object type #Element.

  - `identifier.value` (string)
    An extension object type #string.
    Example: "example-string"

  - `identifier._value` (object)
    An extension object type #Element.

  - `identifier.period` (object)
    An extension object type #Period.

  - `identifier.assigner` (object)
    An extension object type #Reference.

  - `status` (string)
    A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
    Example: "sample-code"

  - `_status` (object)
    Base definition for all elements in a resource.

  - `statusReason` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `statusReason.coding` (array)
    A reference to a code defined by a terminology system.

  - `statusReason.text` (string)
    An extension object type #string.
    Example: "example-string"

  - `statusReason._text` (object)
    An extension object type #Element.

  - `vaccineCode` (object, required)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `patient` (object, required)
    A reference from one resource to another.

  - `patient.reference` (string)
    An extension object type #string.
    Example: "example-string"

  - `patient._reference` (object)
    An extension object type #Element.

  - `patient.type` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `patient._type` (object)
    An extension object type #Element.

  - `patient.identifier` (object)
    An extension object type #Identifier.

  - `patient.display` (string)
    An extension object type #string.
    Example: "example-string"

  - `patient._display` (object)
    An extension object type #Element.

  - `encounter` (object)
    A reference from one resource to another.

  - `occurrenceDateTime` (string)
    Date vaccine administered or was to be administered.
    Example: "2013-01-10"

  - `_occurrenceDateTime` (object)
    Base definition for all elements in a resource.

  - `occurrenceString` (string)
    Date vaccine administered or was to be administered.
    Example: "example-string"

  - `_occurrenceString` (object)
    Base definition for all elements in a resource.

  - `recorded` (string)
    A date, date-time or partial date (e.g. just year or year + month).  If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored.                 Dates SHALL be valid dates.
    Example: "2024-01-01T00:00:00Z"

  - `_recorded` (object)
    Base definition for all elements in a resource.

  - `primarySource` (boolean)
    Value of "true" or "false"
    Example: true

  - `_primarySource` (object)
    Base definition for all elements in a resource.

  - `reportOrigin` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `location` (object)
    A reference from one resource to another.

  - `manufacturer` (object)
    A reference from one resource to another.

  - `lotNumber` (string)
    A sequence of Unicode characters
    Example: "example-string"

  - `_lotNumber` (object)
    Base definition for all elements in a resource.

  - `expirationDate` (string)
    A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date.  Dates SHALL be valid dates.
    Example: "2024-01-01"

  - `_expirationDate` (object)
    Base definition for all elements in a resource.

  - `site` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `route` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `doseQuantity` (object)
    A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

  - `doseQuantity.value` (number)
    An extension object type #decimal.
    Example: 1.23

  - `doseQuantity.comparator` (any)
    How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
    Enum: "<", "<=", ">=", ">"

  - `doseQuantity._comparator` (object)
    An extension object type #Element.

  - `doseQuantity.unit` (string)
    An extension object type #string.
    Example: "example-string"

  - `doseQuantity._unit` (object)
    An extension object type #Element.

  - `doseQuantity.code` (string)
    An extension object type #code.
    Example: "sample-code"

  - `doseQuantity._code` (object)
    An extension object type #Element.

  - `performer` (array)
    Indicates who performed the immunization event.
    Example: [{"function":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0443","code":"OP"}]},"actor":{"reference":"Practitioner/example"}},{"function":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0443","code":"AP"}]},"actor":{"reference":"Practitioner/example"}}]

  - `performer.modifierExtension` (array)
    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

  - `performer.function` (object)
    An extension object type #CodeableConcept.

  - `performer.actor` (object, required)
    An extension object type #Reference.

  - `note` (array)
    Extra information about the immunization that is not conveyed by the other attributes.
    Example: [{"text":"Notes on adminstration of vaccine"}]

  - `note.authorReference` (object)
    An extension object type #Reference.

  - `note.authorString` (string)
    The individual responsible for making the annotation.
    Example: "example-string"

  - `note._authorString` (object)
    An extension object type #Element.

  - `note.time` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `note._time` (object)
    An extension object type #Element.

  - `note.text` (object)
    An extension object type #markdown.

  - `reasonCode` (array)
    Reasons why the vaccine was administered.
    Example: [{"coding":[{"system":"http://snomed.info/sct","code":"429060002"}]}]

  - `reasonReference` (array)
    Condition, Observation or DiagnosticReport that supports why the immunization was administered.

  - `isSubpotent` (boolean)
    Value of "true" or "false"
    Example: true

  - `_isSubpotent` (object)
    Base definition for all elements in a resource.

  - `subpotentReason` (array)
    Reason why a dose is considered to be subpotent.

  - `education` (array)
    Educational material presented to the patient (or guardian) at the time of vaccine administration.
    Example: [{"documentType":"253088698300010311120702","publicationDate":"2012-07-02","presentationDate":"2013-01-10"}]

  - `education.documentType` (string)
    An extension object type #string.
    Example: "example-string"

  - `education._documentType` (object)
    An extension object type #Element.

  - `education.reference` (string)
    An extension object type #uri.
    Example: "https://example.org/resource"

  - `education.publicationDate` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `education._publicationDate` (object)
    An extension object type #Element.

  - `education.presentationDate` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `education._presentationDate` (object)
    An extension object type #Element.

  - `programEligibility` (array)
    Indicates a patient's eligibility for a funding program.
    Example: [{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/immunization-program-eligibility","code":"ineligible"}]}]

  - `fundingSource` (object)
    A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

  - `reaction` (array)
    Categorical data indicating that an adverse event is associated in time to an immunization.

  - `reaction.date` (string)
    An extension object type #dateTime.
    Example: "2024-01-01T00:00:00Z"

  - `reaction._date` (object)
    An extension object type #Element.

  - `reaction.detail` (object)
    An extension object type #Reference.

  - `reaction.reported` (boolean)
    An extension object type #boolean.
    Example: true

  - `reaction._reported` (object)
    An extension object type #Element.

  - `protocolApplied` (array)
    The protocol (set of recommendations) being followed by the provider who administered the dose.

  - `protocolApplied.series` (string)
    An extension object type #string.
    Example: "example-string"

  - `protocolApplied._series` (object)
    An extension object type #Element.

  - `protocolApplied.authority` (object)
    An extension object type #Reference.

  - `protocolApplied.targetDisease` (array)
    The vaccine preventable disease the dose is being administered against.

  - `protocolApplied.doseNumberPositiveInt` (number)
    Nominal position in a series.
    Example: 1

  - `protocolApplied._doseNumberPositiveInt` (object)
    An extension object type #Element.

  - `protocolApplied.doseNumberString` (string)
    Nominal position in a series.
    Example: "example-string"

  - `protocolApplied._doseNumberString` (object)
    An extension object type #Element.

  - `protocolApplied.seriesDosesPositiveInt` (number)
    The recommended number of doses to achieve immunity.
    Example: 1

  - `protocolApplied._seriesDosesPositiveInt` (object)
    An extension object type #Element.

  - `protocolApplied.seriesDosesString` (string)
    The recommended number of doses to achieve immunity.
    Example: "example-string"

  - `protocolApplied._seriesDosesString` (object)
    An extension object type #Element.

## Response 401 fields (application/json):

  - `message` (string, required)
    Error message indicating unauthorized access.
    Example: "Unauthorized"

  - `statusCode` (number, required)
    HTTP status code for unauthorized access.
    Example: 401


## Response 400 fields

## Response 404 fields