Create FHIR r4 immunization

BiologicallyDerivedProduct
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Immunization
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Get FHIR r4 immunizations

Request

Security

bearer or bearer

Path

siteIdstringrequired

Site identifier

Query

_countnumber

Number of items to return (default=20).

Example: _count=10

_page_tokenstring

Token for fetching the next page of results.

Example: _page_token=CgYK...

_sortstring

Sort the results by a given field, e.g. _sort=family or _sort=-date.

Example: _sort=family

_elementsstring

Restrict returned fields, e.g. _elements=identifier,name.

Example: _elements=identifier,name

telecomstring

Filter by resource telecom, e.g. date=[SYSTEM]|[VALUE].

Example: telecom=telecom=phone|555-555-5555

_idstring

Search for a specific resource by ID, e.g. _id=abc123.

Example: _id=abc123

identifierstring

Search for resources by identifier token, e.g. identifier=http://hospital.org|12345.

Example: identifier=http://hospital.org|12345

_includeArray of strings

Include related resources, e.g. _include=Appointment:patient.

patientstring

Include related patient resources, e.g. patient=Patient/[id]&.

Example: patient=patient=Patient/[id]&

_revincludeArray of strings

Reverse include related resources, e.g. _revinclude=Observation:subject.

_hasstring

Reverse chaining, e.g. _has:Observation:subject:code=http://loinc.org|1234-5.

Example: _has=Observation:subject:code=http://loinc.org|1234-5

_tagstring

Search by tag on the resource meta, e.g. _tag=http://example.org/tags|sample-tag.

Example: _tag=http://example.org/tags|sample-tag

_securitystring

Search by security label on resource meta, e.g. _security=RBAC|CONFIDENTIAL.

Example: _security=RBAC|CONFIDENTIAL

_profilestring

Search by profile in resource meta, e.g. _profile=http://example.org/fhir/StructureDefinition/custom-profile.

Example: _profile=http://example.org/fhir/StructureDefinition/custom-profile

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/fhir/medications/site/{siteId}/fhir/immunization?_count=10&_page_token=CgYK...&_sort=family&_elements=identifier%2Cname&telecom=telecom%3Dphone%2C555-555-5555&_id=abc123&identifier=http%3A%2F%2Fhospital.org%2C12345&_include=string&patient=patient%3DPatient%2F%5Bid%5D%26&_revinclude=string&_has=Observation%3Asubject%3Acode%3Dhttp%3A%2F%2Floinc.org%2C1234-5&_tag=http%3A%2F%2Fexample.org%2Ftags%2Csample-tag&_security=RBAC%2CCONFIDENTIAL&_profile=http%3A%2F%2Fexample.org%2Ffhir%2FStructureDefinition%2Fcustom-profile' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

resourceTypeanyrequired

This is a Bundle resource

Value"Bundle"

Example: "Bundle"

idstring(id)^[A-Za-z0-9\-\.]{1,64}$

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"

metaobject(Meta)

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.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

Example: "https://example.org/resource"

_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

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"

_languageobject(Element)

Base definition for all elements in a resource.

identifierobject(Identifier)

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

typeany

Indicates the purpose of this bundle - how it is intended to be used.

Enum"document""message""transaction""transaction-response""batch""batch-response""history""searchset""collection"

Example: "searchset"

_typeobject(Element)

Base definition for all elements in a resource.

timestampstring(date-time)(instant)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

An instant in time - known at least to the second

Example: "2024-01-01T00:00:00Z"

_timestampobject(Element)

Base definition for all elements in a resource.

totalnumber(unsignedInt)^[0]|([1-9][0-9]*)$

An integer with a value that is not negative (e.g. >= 0)

Example: 0

_totalobject(Element)

Base definition for all elements in a resource.

linkArray of objects(Bundle_Link)

A series of links that provide context to this bundle.

Example: [{"relation":"search","url":"https://api.heydonto.com/fhir/immunization/?_count=20"},{"relation":"next","url":"https://api.heydonto.com/fhir/immunization/?_count=20&_page_token=TOKEN"},{"relation":"first","url":"https://api.heydonto.com/fhir/immunization/?_count=20"},{"relation":"self","url":"https://api.heydonto.com/fhir/immunization/?_count=20"}]

entryArray of objects(Immunization)

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Example: [{"resourceType":"Immunization","id":"example","text":{"status":"generated","div":"<div xmlns=\"http://www.w3.org/1999/xhtml\">Generated Narrative with Detailsid: exampleidentifier: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234status: completedvaccineCode: Fluvax (Influenza) (Details : {urn:oid:1.2.36.1.2001.1005.17 code 'FLUVAX' = 'Fluvax)patient: <a>Patient/example</a>encounter: <a>Encounter/example</a>occurrence: 10/01/2013primarySource: truelocation: <a>Location/1</a>manufacturer: <a>Organization/hl7</a>lotNumber: AAJN11KexpirationDate: 15/02/2015site: left arm (Details : {http://terminology.hl7.org/CodeSystem/v3-ActSite code 'LA' = 'left arm', given as 'left arm'})route: Injection, intramuscular (Details : {http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration code 'IM' = 'Injection, intramuscular', given as 'Injection, intramuscular'})doseQuantity: 5 mg (Details: UCUM code mg = 'mg')<blockquote>performerfunction: Ordering Provider (Details : {http://terminology.hl7.org/CodeSystem/v2-0443 code 'OP' = 'Ordering Provider)actor: <a>Practitioner/example</a></blockquote><blockquote>performerfunction: Administering Provider (Details : {http://terminology.hl7.org/CodeSystem/v2-0443 code 'AP' = 'Administering Provider)actor: <a>Practitioner/example</a></blockquote>note: Notes on adminstration of vaccinereasonCode: Procedure to meet occupational requirement (Details : {SNOMED CT code '429060002' = 'Procedure to meet occupational requirement)isSubpotent: true<h3>Educations</h3><table><tr><td>-</td><td>DocumentType</td><td>PublicationDate</td><td>PresentationDate</td></tr><tr><td>*</td><td>253088698300010311120702</td><td>02/07/2012</td><td>10/01/2013</td></tr></table>programEligibility: Not Eligible (Details : {http://terminology.hl7.org/CodeSystem/immunization-program-eligibility code 'ineligible' = 'Not Eligible)fundingSource: Private (Details : {http://terminology.hl7.org/CodeSystem/immunization-funding-source code 'private' = 'Private)</div>"},"identifier":[{"system":"urn:ietf:rfc:3986","value":"urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"}],"status":"completed","vaccineCode":{"coding":[{"system":"urn:oid:1.2.36.1.2001.1005.17","code":"FLUVAX"}],"text":"Fluvax (Influenza)"},"patient":{"reference":"Patient/example"},"encounter":{"reference":"Encounter/example"},"occurrenceDateTime":"2013-01-10","primarySource":true,"location":{"reference":"Location/1"},"manufacturer":{"reference":"Organization/hl7"},"lotNumber":"AAJN11K","expirationDate":"2015-02-15","site":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ActSite","code":"LA","display":"left arm"}]},"route":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration","code":"IM","display":"Injection, intramuscular"}]},"doseQuantity":{"value":5,"system":"http://unitsofmeasure.org","code":"mg"},"performer":[{"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"}}],"note":[{"text":"Notes on adminstration of vaccine"}],"reasonCode":[{"coding":[{"system":"http://snomed.info/sct","code":"429060002"}]}],"isSubpotent":true,"education":[{"documentType":"253088698300010311120702","publicationDate":"2012-07-02","presentationDate":"2013-01-10"}],"programEligibility":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/immunization-program-eligibility","code":"ineligible"}]}],"fundingSource":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/immunization-funding-source","code":"private"}]}}]

signatureobject(Signature)

A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.

Response

application/json

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 100,
  "link": [
    { … },
    { … },
    { … },
    { … }
  ],
  "entry": [
    { … }
  ]
}

Create FHIR r4 immunization

Request

Security

bearer or bearer

Path

siteIdstringrequired

Site identifier

Bodyapplication/jsonrequired

resourceTypeanyrequired

This is a Immunization resource

Value"Immunization"

Example: "Immunization"

idstring(id)^[A-Za-z0-9\-\.]{1,64}$

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"

metaobject(Meta)

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.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

Example: "https://example.org/resource"

_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

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"

_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(ResourceList)

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.

extensionArray of objects(Extension)

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.

modifierExtensionArray of objects(Extension)

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).

identifierArray of objects(Identifier)

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"}]

statusstring(code)^[^\s]+(\s[^\s]+)*$

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"

_statusobject(Element)

Base definition for all elements in a resource.

statusReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

vaccineCodeobject(CodeableConcept)required

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

vaccineCode.idstring

An extension object type #string.

Example: "example-string"

vaccineCode.extensionArray of objects(#Extension)

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.

vaccineCode.codingArray of objects(#Coding)

A reference to a code defined by a terminology system.

vaccineCode.textstring

An extension object type #string.

Example: "example-string"

vaccineCode._textobject(#Element)

An extension object type #Element.

patientobject(Reference)required

A reference from one resource to another.

patient.idstring

An extension object type #string.

Example: "example-string"

patient.extensionArray of objects(#Extension)

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.

patient.referencestring

An extension object type #string.

Example: "example-string"

patient._referenceobject(#Element)

An extension object type #Element.

patient.typestring

An extension object type #uri.

Example: "https://example.org/resource"

patient._typeobject(#Element)

An extension object type #Element.

patient.identifierobject(#Identifier)

An extension object type #Identifier.

patient.displaystring

An extension object type #string.

Example: "example-string"

patient._displayobject(#Element)

An extension object type #Element.

encounterobject(Reference)

A reference from one resource to another.

occurrenceDateTimestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Date vaccine administered or was to be administered.

Example: "2013-01-10"

_occurrenceDateTimeobject(Element)

Base definition for all elements in a resource.

occurrenceStringstring^[ \r\n\t\S]+$

Date vaccine administered or was to be administered.

Example: "example-string"

_occurrenceStringobject(Element)

Base definition for all elements in a resource.

recordedstring(date-time)(dateTime)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

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"

_recordedobject(Element)

Base definition for all elements in a resource.

primarySourceboolean(boolean)^true|false$

Value of "true" or "false"

Example: true

_primarySourceobject(Element)

Base definition for all elements in a resource.

reportOriginobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

locationobject(Reference)

A reference from one resource to another.

manufacturerobject(Reference)

A reference from one resource to another.

lotNumberstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

Example: "example-string"

_lotNumberobject(Element)

Base definition for all elements in a resource.

expirationDatestring(date)(date)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

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"

_expirationDateobject(Element)

Base definition for all elements in a resource.

siteobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

routeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

doseQuantityobject(Quantity)

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.

performerArray of objects(Immunization_Performer)

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"}}]

noteArray of objects(Annotation)

Extra information about the immunization that is not conveyed by the other attributes.

Example: [{"text":"Notes on adminstration of vaccine"}]

reasonCodeArray of objects(CodeableConcept)

Reasons why the vaccine was administered.

Example: [{"coding":[{"system":"http://snomed.info/sct","code":"429060002"}]}]

reasonReferenceArray of objects(Reference)

Condition, Observation or DiagnosticReport that supports why the immunization was administered.

isSubpotentboolean(boolean)^true|false$

Value of "true" or "false"

Example: true

_isSubpotentobject(Element)

Base definition for all elements in a resource.

subpotentReasonArray of objects(CodeableConcept)

Reason why a dose is considered to be subpotent.

educationArray of objects(Immunization_Education)

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"}]

programEligibilityArray of objects(CodeableConcept)

Indicates a patient's eligibility for a funding program.

Example: [{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/immunization-program-eligibility","code":"ineligible"}]}]

fundingSourceobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

reactionArray of objects(Immunization_Reaction)

Categorical data indicating that an adverse event is associated in time to an immunization.

protocolAppliedArray of objects(Immunization_ProtocolApplied)

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

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/fhir/medications/site/{siteId}/fhir/immunization' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "resourceType": "Immunization",
    "id": "example",
    "text": {
      "status": "generated",
      "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>identifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234</p><p><b>status</b>: completed</p><p><b>vaccineCode</b>: Fluvax (Influenza) <span>(Details : {urn:oid:1.2.36.1.2001.1005.17 code '\''FLUVAX'\'' = '\''Fluvax)</span></p><p><b>patient</b>: <a>Patient/example</a></p><p><b>encounter</b>: <a>Encounter/example</a></p><p><b>occurrence</b>: 10/01/2013</p><p><b>primarySource</b>: true</p><p><b>location</b>: <a>Location/1</a></p><p><b>manufacturer</b>: <a>Organization/hl7</a></p><p><b>lotNumber</b>: AAJN11K</p><p><b>expirationDate</b>: 15/02/2015</p><p><b>site</b>: left arm <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ActSite code '\''LA'\'' = '\''left arm'\'', given as '\''left arm'\''})</span></p><p><b>route</b>: Injection, intramuscular <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration code '\''IM'\'' = '\''Injection, intramuscular'\'', given as '\''Injection, intramuscular'\''})</span></p><p><b>doseQuantity</b>: 5 mg<span> (Details: UCUM code mg = '\''mg'\'')</span></p><blockquote><p><b>performer</b></p><p><b>function</b>: Ordering Provider <span>(Details : {http://terminology.hl7.org/CodeSystem/v2-0443 code '\''OP'\'' = '\''Ordering Provider)</span></p><p><b>actor</b>: <a>Practitioner/example</a></p></blockquote><blockquote><p><b>performer</b></p><p><b>function</b>: Administering Provider <span>(Details : {http://terminology.hl7.org/CodeSystem/v2-0443 code '\''AP'\'' = '\''Administering Provider)</span></p><p><b>actor</b>: <a>Practitioner/example</a></p></blockquote><p><b>note</b>: Notes on adminstration of vaccine</p><p><b>reasonCode</b>: Procedure to meet occupational requirement <span>(Details : {SNOMED CT code '\''429060002'\'' = '\''Procedure to meet occupational requirement)</span></p><p><b>isSubpotent</b>: true</p><h3>Educations</h3><table><tr><td>-</td><td><b>DocumentType</b></td><td><b>PublicationDate</b></td><td><b>PresentationDate</b></td></tr><tr><td>*</td><td>253088698300010311120702</td><td>02/07/2012</td><td>10/01/2013</td></tr></table><p><b>programEligibility</b>: Not Eligible <span>(Details : {http://terminology.hl7.org/CodeSystem/immunization-program-eligibility code '\''ineligible'\'' = '\''Not Eligible)</span></p><p><b>fundingSource</b>: Private <span>(Details : {http://terminology.hl7.org/CodeSystem/immunization-funding-source code '\''private'\'' = '\''Private)</span></p></div>"
    },
    "identifier": [
      {
        "system": "urn:ietf:rfc:3986",
        "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
      }
    ],
    "status": "completed",
    "vaccineCode": {
      "coding": [
        {
          "system": "urn:oid:1.2.36.1.2001.1005.17",
          "code": "FLUVAX"
        }
      ],
      "text": "Fluvax (Influenza)"
    },
    "patient": {
      "reference": "Patient/example"
    },
    "encounter": {
      "reference": "Encounter/example"
    },
    "occurrenceDateTime": "2013-01-10",
    "primarySource": true,
    "location": {
      "reference": "Location/1"
    },
    "manufacturer": {
      "reference": "Organization/hl7"
    },
    "lotNumber": "AAJN11K",
    "expirationDate": "2015-02-15",
    "site": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActSite",
          "code": "LA",
          "display": "left arm"
        }
      ]
    },
    "route": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",
          "code": "IM",
          "display": "Injection, intramuscular"
        }
      ]
    },
    "doseQuantity": {
      "value": 5,
      "system": "http://unitsofmeasure.org",
      "code": "mg"
    },
    "performer": [
      {
        "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"
        }
      }
    ],
    "note": [
      {
        "text": "Notes on adminstration of vaccine"
      }
    ],
    "reasonCode": [
      {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "429060002"
          }
        ]
      }
    ],
    "isSubpotent": true,
    "education": [
      {
        "documentType": "253088698300010311120702",
        "publicationDate": "2012-07-02",
        "presentationDate": "2013-01-10"
      }
    ],
    "programEligibility": [
      {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/immunization-program-eligibility",
            "code": "ineligible"
          }
        ]
      }
    ],
    "fundingSource": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/immunization-funding-source",
          "code": "private"
        }
      ]
    }
  }'

Responses

Bodyapplication/json

resourceTypeanyrequired

This is a Immunization resource

Value"Immunization"

Example: "Immunization"

idstring(id)^[A-Za-z0-9\-\.]{1,64}$

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"

metaobject(Meta)

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.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

Example: "https://example.org/resource"

_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

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"

_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(ResourceList)

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.

extensionArray of objects(Extension)

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.

modifierExtensionArray of objects(Extension)

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).

identifierArray of objects(Identifier)

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"}]

statusstring(code)^[^\s]+(\s[^\s]+)*$

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"

_statusobject(Element)

Base definition for all elements in a resource.

statusReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

vaccineCodeobject(CodeableConcept)required

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

vaccineCode.idstring

An extension object type #string.

Example: "example-string"

vaccineCode.extensionArray of objects(#Extension)

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.

vaccineCode.codingArray of objects(#Coding)

A reference to a code defined by a terminology system.

vaccineCode.textstring

An extension object type #string.

Example: "example-string"

vaccineCode._textobject(#Element)

An extension object type #Element.

patientobject(Reference)required

A reference from one resource to another.

patient.idstring

An extension object type #string.

Example: "example-string"

patient.extensionArray of objects(#Extension)

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.

patient.referencestring

An extension object type #string.

Example: "example-string"

patient._referenceobject(#Element)

An extension object type #Element.

patient.typestring

An extension object type #uri.

Example: "https://example.org/resource"

patient._typeobject(#Element)

An extension object type #Element.

patient.identifierobject(#Identifier)

An extension object type #Identifier.

patient.displaystring

An extension object type #string.

Example: "example-string"

patient._displayobject(#Element)

An extension object type #Element.

encounterobject(Reference)

A reference from one resource to another.

occurrenceDateTimestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Date vaccine administered or was to be administered.

Example: "2013-01-10"

_occurrenceDateTimeobject(Element)

Base definition for all elements in a resource.

occurrenceStringstring^[ \r\n\t\S]+$

Date vaccine administered or was to be administered.

Example: "example-string"

_occurrenceStringobject(Element)

Base definition for all elements in a resource.

recordedstring(date-time)(dateTime)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

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"

_recordedobject(Element)

Base definition for all elements in a resource.

primarySourceboolean(boolean)^true|false$

Value of "true" or "false"

Example: true

_primarySourceobject(Element)

Base definition for all elements in a resource.

reportOriginobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

locationobject(Reference)

A reference from one resource to another.

manufacturerobject(Reference)

A reference from one resource to another.

lotNumberstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

Example: "example-string"

_lotNumberobject(Element)

Base definition for all elements in a resource.

expirationDatestring(date)(date)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

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"

_expirationDateobject(Element)

Base definition for all elements in a resource.

siteobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

routeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

doseQuantityobject(Quantity)

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.

performerArray of objects(Immunization_Performer)

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"}}]

noteArray of objects(Annotation)

Extra information about the immunization that is not conveyed by the other attributes.

Example: [{"text":"Notes on adminstration of vaccine"}]

reasonCodeArray of objects(CodeableConcept)

Reasons why the vaccine was administered.

Example: [{"coding":[{"system":"http://snomed.info/sct","code":"429060002"}]}]

reasonReferenceArray of objects(Reference)

Condition, Observation or DiagnosticReport that supports why the immunization was administered.

isSubpotentboolean(boolean)^true|false$

Value of "true" or "false"

Example: true

_isSubpotentobject(Element)

Base definition for all elements in a resource.

subpotentReasonArray of objects(CodeableConcept)

Reason why a dose is considered to be subpotent.

educationArray of objects(Immunization_Education)

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"}]

programEligibilityArray of objects(CodeableConcept)

Indicates a patient's eligibility for a funding program.

Example: [{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/immunization-program-eligibility","code":"ineligible"}]}]

fundingSourceobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

reactionArray of objects(Immunization_Reaction)

Categorical data indicating that an adverse event is associated in time to an immunization.

protocolAppliedArray of objects(Immunization_ProtocolApplied)

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

Response

application/json

{
  "resourceType": "Immunization",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>identifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234</p><p><b>status</b>: completed</p><p><b>vaccineCode</b>: Fluvax (Influenza) <span>(Details : {urn:oid:1.2.36.1.2001.1005.17 code 'FLUVAX' = 'Fluvax)</span></p><p><b>patient</b>: <a>Patient/example</a></p><p><b>encounter</b>: <a>Encounter/example</a></p><p><b>occurrence</b>: 10/01/2013</p><p><b>primarySource</b>: true</p><p><b>location</b>: <a>Location/1</a></p><p><b>manufacturer</b>: <a>Organization/hl7</a></p><p><b>lotNumber</b>: AAJN11K</p><p><b>expirationDate</b>: 15/02/2015</p><p><b>site</b>: left arm <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ActSite code 'LA' = 'left arm', given as 'left arm'})</span></p><p><b>route</b>: Injection, intramuscular <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration code 'IM' = 'Injection, intramuscular', given as 'Injection, intramuscular'})</span></p><p><b>doseQuantity</b>: 5 mg<span> (Details: UCUM code mg = 'mg')</span></p><blockquote><p><b>performer</b></p><p><b>function</b>: Ordering Provider <span>(Details : {http://terminology.hl7.org/CodeSystem/v2-0443 code 'OP' = 'Ordering Provider)</span></p><p><b>actor</b>: <a>Practitioner/example</a></p></blockquote><blockquote><p><b>performer</b></p><p><b>function</b>: Administering Provider <span>(Details : {http://terminology.hl7.org/CodeSystem/v2-0443 code 'AP' = 'Administering Provider)</span></p><p><b>actor</b>: <a>Practitioner/example</a></p></blockquote><p><b>note</b>: Notes on adminstration of vaccine</p><p><b>reasonCode</b>: Procedure to meet occupational requirement <span>(Details : {SNOMED CT code '429060002' = 'Procedure to meet occupational requirement)</span></p><p><b>isSubpotent</b>: true</p><h3>Educations</h3><table><tr><td>-</td><td><b>DocumentType</b></td><td><b>PublicationDate</b></td><td><b>PresentationDate</b></td></tr><tr><td>*</td><td>253088698300010311120702</td><td>02/07/2012</td><td>10/01/2013</td></tr></table><p><b>programEligibility</b>: Not Eligible <span>(Details : {http://terminology.hl7.org/CodeSystem/immunization-program-eligibility code 'ineligible' = 'Not Eligible)</span></p><p><b>fundingSource</b>: Private <span>(Details : {http://terminology.hl7.org/CodeSystem/immunization-funding-source code 'private' = 'Private)</span></p></div>"
  },
  "identifier": [
    { … }
  ],
  "status": "completed",
  "vaccineCode": {
    "coding": [ … ],
    "text": "Fluvax (Influenza)"
  },
  "patient": {
    "reference": "Patient/example"
  },
  "encounter": {
    "reference": "Encounter/example"
  },
  "occurrenceDateTime": "2013-01-10",
  "primarySource": true,
  "location": {
    "reference": "Location/1"
  },
  "manufacturer": {
    "reference": "Organization/hl7"
  },
  "lotNumber": "AAJN11K",
  "expirationDate": "2015-02-15",
  "site": {
    "coding": [ … ]
  },
  "route": {
    "coding": [ … ]
  },
  "doseQuantity": {
    "value": 5,
    "system": "http://unitsofmeasure.org",
    "code": "mg"
  },
  "performer": [
    { … },
    { … }
  ],
  "note": [
    { … }
  ],
  "reasonCode": [
    { … }
  ],
  "isSubpotent": true,
  "education": [
    { … }
  ],
  "programEligibility": [
    { … }
  ],
  "fundingSource": {
    "coding": [ … ]
  }
}

Get FHIR r4 immunization by ID

Request

Security

bearer or bearer

Path

idstringrequired

ID of the Immunization

siteIdstringrequired

Site identifier

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/fhir/medications/site/{siteId}/fhir/immunization/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

resourceTypeanyrequired

This is a Immunization resource

Value"Immunization"

Example: "Immunization"

idstring(id)^[A-Za-z0-9\-\.]{1,64}$

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"

metaobject(Meta)

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.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

Example: "https://example.org/resource"

_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

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"

_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(ResourceList)

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.

extensionArray of objects(Extension)

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.

modifierExtensionArray of objects(Extension)

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).

identifierArray of objects(Identifier)

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"}]

statusstring(code)^[^\s]+(\s[^\s]+)*$

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"

_statusobject(Element)

Base definition for all elements in a resource.

statusReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

vaccineCodeobject(CodeableConcept)required

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

vaccineCode.idstring

An extension object type #string.

Example: "example-string"

vaccineCode.extensionArray of objects(#Extension)

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.

vaccineCode.codingArray of objects(#Coding)

A reference to a code defined by a terminology system.

vaccineCode.textstring

An extension object type #string.

Example: "example-string"

vaccineCode._textobject(#Element)

An extension object type #Element.

patientobject(Reference)required

A reference from one resource to another.

patient.idstring

An extension object type #string.

Example: "example-string"

patient.extensionArray of objects(#Extension)

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.

patient.referencestring

An extension object type #string.

Example: "example-string"

patient._referenceobject(#Element)

An extension object type #Element.

patient.typestring

An extension object type #uri.

Example: "https://example.org/resource"

patient._typeobject(#Element)

An extension object type #Element.

patient.identifierobject(#Identifier)

An extension object type #Identifier.

patient.displaystring

An extension object type #string.

Example: "example-string"

patient._displayobject(#Element)

An extension object type #Element.

encounterobject(Reference)

A reference from one resource to another.

occurrenceDateTimestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Date vaccine administered or was to be administered.

Example: "2013-01-10"

_occurrenceDateTimeobject(Element)

Base definition for all elements in a resource.

occurrenceStringstring^[ \r\n\t\S]+$

Date vaccine administered or was to be administered.

Example: "example-string"

_occurrenceStringobject(Element)

Base definition for all elements in a resource.

recordedstring(date-time)(dateTime)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

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"

_recordedobject(Element)

Base definition for all elements in a resource.

primarySourceboolean(boolean)^true|false$

Value of "true" or "false"

Example: true

_primarySourceobject(Element)

Base definition for all elements in a resource.

reportOriginobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

locationobject(Reference)

A reference from one resource to another.

manufacturerobject(Reference)

A reference from one resource to another.

lotNumberstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

Example: "example-string"

_lotNumberobject(Element)

Base definition for all elements in a resource.

expirationDatestring(date)(date)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

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"

_expirationDateobject(Element)

Base definition for all elements in a resource.

siteobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

routeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

doseQuantityobject(Quantity)

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.

performerArray of objects(Immunization_Performer)

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"}}]

noteArray of objects(Annotation)

Extra information about the immunization that is not conveyed by the other attributes.

Example: [{"text":"Notes on adminstration of vaccine"}]

reasonCodeArray of objects(CodeableConcept)

Reasons why the vaccine was administered.

Example: [{"coding":[{"system":"http://snomed.info/sct","code":"429060002"}]}]

reasonReferenceArray of objects(Reference)

Condition, Observation or DiagnosticReport that supports why the immunization was administered.

isSubpotentboolean(boolean)^true|false$

Value of "true" or "false"

Example: true

_isSubpotentobject(Element)

Base definition for all elements in a resource.

subpotentReasonArray of objects(CodeableConcept)

Reason why a dose is considered to be subpotent.

educationArray of objects(Immunization_Education)

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"}]

programEligibilityArray of objects(CodeableConcept)

Indicates a patient's eligibility for a funding program.

Example: [{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/immunization-program-eligibility","code":"ineligible"}]}]

fundingSourceobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

reactionArray of objects(Immunization_Reaction)

Categorical data indicating that an adverse event is associated in time to an immunization.

protocolAppliedArray of objects(Immunization_ProtocolApplied)

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

Response

application/json

{
  "resourceType": "Immunization",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>identifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234</p><p><b>status</b>: completed</p><p><b>vaccineCode</b>: Fluvax (Influenza) <span>(Details : {urn:oid:1.2.36.1.2001.1005.17 code 'FLUVAX' = 'Fluvax)</span></p><p><b>patient</b>: <a>Patient/example</a></p><p><b>encounter</b>: <a>Encounter/example</a></p><p><b>occurrence</b>: 10/01/2013</p><p><b>primarySource</b>: true</p><p><b>location</b>: <a>Location/1</a></p><p><b>manufacturer</b>: <a>Organization/hl7</a></p><p><b>lotNumber</b>: AAJN11K</p><p><b>expirationDate</b>: 15/02/2015</p><p><b>site</b>: left arm <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ActSite code 'LA' = 'left arm', given as 'left arm'})</span></p><p><b>route</b>: Injection, intramuscular <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration code 'IM' = 'Injection, intramuscular', given as 'Injection, intramuscular'})</span></p><p><b>doseQuantity</b>: 5 mg<span> (Details: UCUM code mg = 'mg')</span></p><blockquote><p><b>performer</b></p><p><b>function</b>: Ordering Provider <span>(Details : {http://terminology.hl7.org/CodeSystem/v2-0443 code 'OP' = 'Ordering Provider)</span></p><p><b>actor</b>: <a>Practitioner/example</a></p></blockquote><blockquote><p><b>performer</b></p><p><b>function</b>: Administering Provider <span>(Details : {http://terminology.hl7.org/CodeSystem/v2-0443 code 'AP' = 'Administering Provider)</span></p><p><b>actor</b>: <a>Practitioner/example</a></p></blockquote><p><b>note</b>: Notes on adminstration of vaccine</p><p><b>reasonCode</b>: Procedure to meet occupational requirement <span>(Details : {SNOMED CT code '429060002' = 'Procedure to meet occupational requirement)</span></p><p><b>isSubpotent</b>: true</p><h3>Educations</h3><table><tr><td>-</td><td><b>DocumentType</b></td><td><b>PublicationDate</b></td><td><b>PresentationDate</b></td></tr><tr><td>*</td><td>253088698300010311120702</td><td>02/07/2012</td><td>10/01/2013</td></tr></table><p><b>programEligibility</b>: Not Eligible <span>(Details : {http://terminology.hl7.org/CodeSystem/immunization-program-eligibility code 'ineligible' = 'Not Eligible)</span></p><p><b>fundingSource</b>: Private <span>(Details : {http://terminology.hl7.org/CodeSystem/immunization-funding-source code 'private' = 'Private)</span></p></div>"
  },
  "identifier": [
    { … }
  ],
  "status": "completed",
  "vaccineCode": {
    "coding": [ … ],
    "text": "Fluvax (Influenza)"
  },
  "patient": {
    "reference": "Patient/example"
  },
  "encounter": {
    "reference": "Encounter/example"
  },
  "occurrenceDateTime": "2013-01-10",
  "primarySource": true,
  "location": {
    "reference": "Location/1"
  },
  "manufacturer": {
    "reference": "Organization/hl7"
  },
  "lotNumber": "AAJN11K",
  "expirationDate": "2015-02-15",
  "site": {
    "coding": [ … ]
  },
  "route": {
    "coding": [ … ]
  },
  "doseQuantity": {
    "value": 5,
    "system": "http://unitsofmeasure.org",
    "code": "mg"
  },
  "performer": [
    { … },
    { … }
  ],
  "note": [
    { … }
  ],
  "reasonCode": [
    { … }
  ],
  "isSubpotent": true,
  "education": [
    { … }
  ],
  "programEligibility": [
    { … }
  ],
  "fundingSource": {
    "coding": [ … ]
  }
}

Update FHIR r4 immunization

Request

Security

bearer or bearer

Path

siteIdstringrequired

Site identifier

idstringrequired

ID of the Immunization to update

Bodyapplication/jsonrequired

resourceTypeanyrequired

This is a Immunization resource

Value"Immunization"

Example: "Immunization"

idstring(id)^[A-Za-z0-9\-\.]{1,64}$

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"

metaobject(Meta)

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.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

Example: "https://example.org/resource"

_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

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"

_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(ResourceList)

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.

extensionArray of objects(Extension)

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.

modifierExtensionArray of objects(Extension)

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).

identifierArray of objects(Identifier)

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"}]

statusstring(code)^[^\s]+(\s[^\s]+)*$

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"

_statusobject(Element)

Base definition for all elements in a resource.

statusReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

vaccineCodeobject(CodeableConcept)required

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

vaccineCode.idstring

An extension object type #string.

Example: "example-string"

vaccineCode.extensionArray of objects(#Extension)

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.

vaccineCode.codingArray of objects(#Coding)

A reference to a code defined by a terminology system.

vaccineCode.textstring

An extension object type #string.

Example: "example-string"

vaccineCode._textobject(#Element)

An extension object type #Element.

patientobject(Reference)required

A reference from one resource to another.

patient.idstring

An extension object type #string.

Example: "example-string"

patient.extensionArray of objects(#Extension)

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.

patient.referencestring

An extension object type #string.

Example: "example-string"

patient._referenceobject(#Element)

An extension object type #Element.

patient.typestring

An extension object type #uri.

Example: "https://example.org/resource"

patient._typeobject(#Element)

An extension object type #Element.

patient.identifierobject(#Identifier)

An extension object type #Identifier.

patient.displaystring

An extension object type #string.

Example: "example-string"

patient._displayobject(#Element)

An extension object type #Element.

encounterobject(Reference)

A reference from one resource to another.

occurrenceDateTimestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Date vaccine administered or was to be administered.

Example: "2013-01-10"

_occurrenceDateTimeobject(Element)

Base definition for all elements in a resource.

occurrenceStringstring^[ \r\n\t\S]+$

Date vaccine administered or was to be administered.

Example: "example-string"

_occurrenceStringobject(Element)

Base definition for all elements in a resource.

recordedstring(date-time)(dateTime)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

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"

_recordedobject(Element)

Base definition for all elements in a resource.

primarySourceboolean(boolean)^true|false$

Value of "true" or "false"

Example: true

_primarySourceobject(Element)

Base definition for all elements in a resource.

reportOriginobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

locationobject(Reference)

A reference from one resource to another.

manufacturerobject(Reference)

A reference from one resource to another.

lotNumberstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

Example: "example-string"

_lotNumberobject(Element)

Base definition for all elements in a resource.

expirationDatestring(date)(date)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

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"

_expirationDateobject(Element)

Base definition for all elements in a resource.

siteobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

routeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

doseQuantityobject(Quantity)

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.

performerArray of objects(Immunization_Performer)

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"}}]

noteArray of objects(Annotation)

Extra information about the immunization that is not conveyed by the other attributes.

Example: [{"text":"Notes on adminstration of vaccine"}]

reasonCodeArray of objects(CodeableConcept)

Reasons why the vaccine was administered.

Example: [{"coding":[{"system":"http://snomed.info/sct","code":"429060002"}]}]

reasonReferenceArray of objects(Reference)

Condition, Observation or DiagnosticReport that supports why the immunization was administered.

isSubpotentboolean(boolean)^true|false$

Value of "true" or "false"

Example: true

_isSubpotentobject(Element)

Base definition for all elements in a resource.

subpotentReasonArray of objects(CodeableConcept)

Reason why a dose is considered to be subpotent.

educationArray of objects(Immunization_Education)

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"}]

programEligibilityArray of objects(CodeableConcept)

Indicates a patient's eligibility for a funding program.

Example: [{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/immunization-program-eligibility","code":"ineligible"}]}]

fundingSourceobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

reactionArray of objects(Immunization_Reaction)

Categorical data indicating that an adverse event is associated in time to an immunization.

protocolAppliedArray of objects(Immunization_ProtocolApplied)

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

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/fhir/medications/site/{siteId}/fhir/immunization/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "resourceType": "Immunization",
    "id": "example",
    "text": {
      "status": "generated",
      "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>identifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234</p><p><b>status</b>: completed</p><p><b>vaccineCode</b>: Fluvax (Influenza) <span>(Details : {urn:oid:1.2.36.1.2001.1005.17 code '\''FLUVAX'\'' = '\''Fluvax)</span></p><p><b>patient</b>: <a>Patient/example</a></p><p><b>encounter</b>: <a>Encounter/example</a></p><p><b>occurrence</b>: 10/01/2013</p><p><b>primarySource</b>: true</p><p><b>location</b>: <a>Location/1</a></p><p><b>manufacturer</b>: <a>Organization/hl7</a></p><p><b>lotNumber</b>: AAJN11K</p><p><b>expirationDate</b>: 15/02/2015</p><p><b>site</b>: left arm <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ActSite code '\''LA'\'' = '\''left arm'\'', given as '\''left arm'\''})</span></p><p><b>route</b>: Injection, intramuscular <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration code '\''IM'\'' = '\''Injection, intramuscular'\'', given as '\''Injection, intramuscular'\''})</span></p><p><b>doseQuantity</b>: 5 mg<span> (Details: UCUM code mg = '\''mg'\'')</span></p><blockquote><p><b>performer</b></p><p><b>function</b>: Ordering Provider <span>(Details : {http://terminology.hl7.org/CodeSystem/v2-0443 code '\''OP'\'' = '\''Ordering Provider)</span></p><p><b>actor</b>: <a>Practitioner/example</a></p></blockquote><blockquote><p><b>performer</b></p><p><b>function</b>: Administering Provider <span>(Details : {http://terminology.hl7.org/CodeSystem/v2-0443 code '\''AP'\'' = '\''Administering Provider)</span></p><p><b>actor</b>: <a>Practitioner/example</a></p></blockquote><p><b>note</b>: Notes on adminstration of vaccine</p><p><b>reasonCode</b>: Procedure to meet occupational requirement <span>(Details : {SNOMED CT code '\''429060002'\'' = '\''Procedure to meet occupational requirement)</span></p><p><b>isSubpotent</b>: true</p><h3>Educations</h3><table><tr><td>-</td><td><b>DocumentType</b></td><td><b>PublicationDate</b></td><td><b>PresentationDate</b></td></tr><tr><td>*</td><td>253088698300010311120702</td><td>02/07/2012</td><td>10/01/2013</td></tr></table><p><b>programEligibility</b>: Not Eligible <span>(Details : {http://terminology.hl7.org/CodeSystem/immunization-program-eligibility code '\''ineligible'\'' = '\''Not Eligible)</span></p><p><b>fundingSource</b>: Private <span>(Details : {http://terminology.hl7.org/CodeSystem/immunization-funding-source code '\''private'\'' = '\''Private)</span></p></div>"
    },
    "identifier": [
      {
        "system": "urn:ietf:rfc:3986",
        "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
      }
    ],
    "status": "completed",
    "vaccineCode": {
      "coding": [
        {
          "system": "urn:oid:1.2.36.1.2001.1005.17",
          "code": "FLUVAX"
        }
      ],
      "text": "Fluvax (Influenza)"
    },
    "patient": {
      "reference": "Patient/example"
    },
    "encounter": {
      "reference": "Encounter/example"
    },
    "occurrenceDateTime": "2013-01-10",
    "primarySource": true,
    "location": {
      "reference": "Location/1"
    },
    "manufacturer": {
      "reference": "Organization/hl7"
    },
    "lotNumber": "AAJN11K",
    "expirationDate": "2015-02-15",
    "site": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActSite",
          "code": "LA",
          "display": "left arm"
        }
      ]
    },
    "route": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",
          "code": "IM",
          "display": "Injection, intramuscular"
        }
      ]
    },
    "doseQuantity": {
      "value": 5,
      "system": "http://unitsofmeasure.org",
      "code": "mg"
    },
    "performer": [
      {
        "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"
        }
      }
    ],
    "note": [
      {
        "text": "Notes on adminstration of vaccine"
      }
    ],
    "reasonCode": [
      {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "429060002"
          }
        ]
      }
    ],
    "isSubpotent": true,
    "education": [
      {
        "documentType": "253088698300010311120702",
        "publicationDate": "2012-07-02",
        "presentationDate": "2013-01-10"
      }
    ],
    "programEligibility": [
      {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/immunization-program-eligibility",
            "code": "ineligible"
          }
        ]
      }
    ],
    "fundingSource": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/immunization-funding-source",
          "code": "private"
        }
      ]
    }
  }'

Responses

Bodyapplication/json

resourceTypeanyrequired

This is a Immunization resource

Value"Immunization"

Example: "Immunization"

idstring(id)^[A-Za-z0-9\-\.]{1,64}$

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"

metaobject(Meta)

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.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

Example: "https://example.org/resource"

_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

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"

_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(ResourceList)

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.

extensionArray of objects(Extension)

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.

modifierExtensionArray of objects(Extension)

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).

identifierArray of objects(Identifier)

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"}]

statusstring(code)^[^\s]+(\s[^\s]+)*$

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"

_statusobject(Element)

Base definition for all elements in a resource.

statusReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

vaccineCodeobject(CodeableConcept)required

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

vaccineCode.idstring

An extension object type #string.

Example: "example-string"

vaccineCode.extensionArray of objects(#Extension)

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.

vaccineCode.codingArray of objects(#Coding)

A reference to a code defined by a terminology system.

vaccineCode.textstring

An extension object type #string.

Example: "example-string"

vaccineCode._textobject(#Element)

An extension object type #Element.

patientobject(Reference)required

A reference from one resource to another.

patient.idstring

An extension object type #string.

Example: "example-string"

patient.extensionArray of objects(#Extension)

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.

patient.referencestring

An extension object type #string.

Example: "example-string"

patient._referenceobject(#Element)

An extension object type #Element.

patient.typestring

An extension object type #uri.

Example: "https://example.org/resource"

patient._typeobject(#Element)

An extension object type #Element.

patient.identifierobject(#Identifier)

An extension object type #Identifier.

patient.displaystring

An extension object type #string.

Example: "example-string"

patient._displayobject(#Element)

An extension object type #Element.

encounterobject(Reference)

A reference from one resource to another.

occurrenceDateTimestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Date vaccine administered or was to be administered.

Example: "2013-01-10"

_occurrenceDateTimeobject(Element)

Base definition for all elements in a resource.

occurrenceStringstring^[ \r\n\t\S]+$

Date vaccine administered or was to be administered.

Example: "example-string"

_occurrenceStringobject(Element)

Base definition for all elements in a resource.

recordedstring(date-time)(dateTime)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

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"

_recordedobject(Element)

Base definition for all elements in a resource.

primarySourceboolean(boolean)^true|false$

Value of "true" or "false"

Example: true

_primarySourceobject(Element)

Base definition for all elements in a resource.

reportOriginobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

locationobject(Reference)

A reference from one resource to another.

manufacturerobject(Reference)

A reference from one resource to another.

lotNumberstring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

Example: "example-string"

_lotNumberobject(Element)

Base definition for all elements in a resource.

expirationDatestring(date)(date)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

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"

_expirationDateobject(Element)

Base definition for all elements in a resource.

siteobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

routeobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

doseQuantityobject(Quantity)

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.

performerArray of objects(Immunization_Performer)

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"}}]

noteArray of objects(Annotation)

Extra information about the immunization that is not conveyed by the other attributes.

Example: [{"text":"Notes on adminstration of vaccine"}]

reasonCodeArray of objects(CodeableConcept)

Reasons why the vaccine was administered.

Example: [{"coding":[{"system":"http://snomed.info/sct","code":"429060002"}]}]

reasonReferenceArray of objects(Reference)

Condition, Observation or DiagnosticReport that supports why the immunization was administered.

isSubpotentboolean(boolean)^true|false$

Value of "true" or "false"

Example: true

_isSubpotentobject(Element)

Base definition for all elements in a resource.

subpotentReasonArray of objects(CodeableConcept)

Reason why a dose is considered to be subpotent.

educationArray of objects(Immunization_Education)

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"}]

programEligibilityArray of objects(CodeableConcept)

Indicates a patient's eligibility for a funding program.

Example: [{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/immunization-program-eligibility","code":"ineligible"}]}]

fundingSourceobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

reactionArray of objects(Immunization_Reaction)

Categorical data indicating that an adverse event is associated in time to an immunization.

protocolAppliedArray of objects(Immunization_ProtocolApplied)

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

Response

application/json

{
  "resourceType": "Immunization",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>identifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234</p><p><b>status</b>: completed</p><p><b>vaccineCode</b>: Fluvax (Influenza) <span>(Details : {urn:oid:1.2.36.1.2001.1005.17 code 'FLUVAX' = 'Fluvax)</span></p><p><b>patient</b>: <a>Patient/example</a></p><p><b>encounter</b>: <a>Encounter/example</a></p><p><b>occurrence</b>: 10/01/2013</p><p><b>primarySource</b>: true</p><p><b>location</b>: <a>Location/1</a></p><p><b>manufacturer</b>: <a>Organization/hl7</a></p><p><b>lotNumber</b>: AAJN11K</p><p><b>expirationDate</b>: 15/02/2015</p><p><b>site</b>: left arm <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ActSite code 'LA' = 'left arm', given as 'left arm'})</span></p><p><b>route</b>: Injection, intramuscular <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration code 'IM' = 'Injection, intramuscular', given as 'Injection, intramuscular'})</span></p><p><b>doseQuantity</b>: 5 mg<span> (Details: UCUM code mg = 'mg')</span></p><blockquote><p><b>performer</b></p><p><b>function</b>: Ordering Provider <span>(Details : {http://terminology.hl7.org/CodeSystem/v2-0443 code 'OP' = 'Ordering Provider)</span></p><p><b>actor</b>: <a>Practitioner/example</a></p></blockquote><blockquote><p><b>performer</b></p><p><b>function</b>: Administering Provider <span>(Details : {http://terminology.hl7.org/CodeSystem/v2-0443 code 'AP' = 'Administering Provider)</span></p><p><b>actor</b>: <a>Practitioner/example</a></p></blockquote><p><b>note</b>: Notes on adminstration of vaccine</p><p><b>reasonCode</b>: Procedure to meet occupational requirement <span>(Details : {SNOMED CT code '429060002' = 'Procedure to meet occupational requirement)</span></p><p><b>isSubpotent</b>: true</p><h3>Educations</h3><table><tr><td>-</td><td><b>DocumentType</b></td><td><b>PublicationDate</b></td><td><b>PresentationDate</b></td></tr><tr><td>*</td><td>253088698300010311120702</td><td>02/07/2012</td><td>10/01/2013</td></tr></table><p><b>programEligibility</b>: Not Eligible <span>(Details : {http://terminology.hl7.org/CodeSystem/immunization-program-eligibility code 'ineligible' = 'Not Eligible)</span></p><p><b>fundingSource</b>: Private <span>(Details : {http://terminology.hl7.org/CodeSystem/immunization-funding-source code 'private' = 'Private)</span></p></div>"
  },
  "identifier": [
    { … }
  ],
  "status": "completed",
  "vaccineCode": {
    "coding": [ … ],
    "text": "Fluvax (Influenza)"
  },
  "patient": {
    "reference": "Patient/example"
  },
  "encounter": {
    "reference": "Encounter/example"
  },
  "occurrenceDateTime": "2013-01-10",
  "primarySource": true,
  "location": {
    "reference": "Location/1"
  },
  "manufacturer": {
    "reference": "Organization/hl7"
  },
  "lotNumber": "AAJN11K",
  "expirationDate": "2015-02-15",
  "site": {
    "coding": [ … ]
  },
  "route": {
    "coding": [ … ]
  },
  "doseQuantity": {
    "value": 5,
    "system": "http://unitsofmeasure.org",
    "code": "mg"
  },
  "performer": [
    { … },
    { … }
  ],
  "note": [
    { … }
  ],
  "reasonCode": [
    { … }
  ],
  "isSubpotent": true,
  "education": [
    { … }
  ],
  "programEligibility": [
    { … }
  ],
  "fundingSource": {
    "coding": [ … ]
  }
}

Delete FHIR r4 immunization

Request

Security

bearer or bearer

Path

idstringrequired

ID of the Immunization to delete

siteIdstringrequired

Site identifier

curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/fhir/medications/site/{siteId}/fhir/immunization/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Immunization successfully deleted

Bodyapplication/json

statusTextstringrequired

Example: "OK"

statusnumberrequired

Example: 200

Response

application/json

{
  "statusText": "OK",
  "status": 200
}

Get FHIR r4 immunization history by ID

Request

Security

bearer or bearer

Path

siteIdstringrequired

Site identifier

idstringrequired

ID of the Immunization

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/fhir/medications/site/{siteId}/fhir/immunization/{id}/history' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

resourceTypeanyrequired

This is a Bundle resource

Value"Bundle"

Example: "Bundle"

typeanyrequired

Indicates that this is a history bundle.

Value"history"

Example: "history"

entryArray of objectsrequired

A list of entries representing historical versions of the resource.

entry[].fullUrlstringrequired

Example: "https://api.heydonto.com/immunization/6eca4369-7183-446e-bab7-addc609972d3"

entry[].requestobjectrequired

entry[].request.methodstring

Enum"PUT""POST"

Example: "PUT"

entry[].request.urlstring

Example: "https://api.heydonto.com/immunization/6eca4369-7183-446e-bab7-addc609972d3"

entry[].resourceobjectrequired

Example: {"resourceType":"Resource","id":"example"}

entry[].responseobjectrequired

entry[].response.lastModifiedstring(date-time)

Example: "2024-10-29T01:05:22.739517+00:00"

entry[].response.locationstring

Example: "https://api.heydonto.com/immunization/6eca4369-7183-446e-bab7-addc609972d3/_history/MTczMDE2MzkyMjczOTUxNzAwMA"

entry[].response.statusstring

Example: "200 OK"

totalintegerrequired

Example: 2

Response

application/json

{
  "resourceType": "Bundle",
  "type": "history",
  "entry": [
    { … }
  ],
  "total": 2
}

ImmunizationEvaluation
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

ImmunizationRecommendation
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Medication
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

MedicationAdministration
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

MedicationDispense
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

MedicationKnowledge
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

MedicationRequest
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

MedicationStatement
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

MedicinalProduct
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

MedicinalProductAuthorization
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

MedicinalProductContraindication
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

MedicinalProductIndication
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

MedicinalProductIngredient
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

MedicinalProductInteraction
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

MedicinalProductManufactured
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

MedicinalProductPackaged
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

MedicinalProductPharmaceutical
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

MedicinalProductUndesirableEffect
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Substance
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

SubstanceNucleicAcid
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

SubstancePolymer
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

SubstanceProtein
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

SubstanceReferenceInformation
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

SubstanceSourceMaterial
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

SubstanceSpecification
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

HeyDonto FHIR R4 API - Medications (1.0)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Index

Medications

Immunizations

Common Use Cases

Other Resources

Security and Privacy

Developmental Roadmap

BiologicallyDerivedProductCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ImmunizationCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Get FHIR r4 immunizations

Request

Responses

Was this helpful?

Create FHIR r4 immunization

RequestExpand all

Responses

Was this helpful?

Get FHIR r4 immunization by ID

Request

Responses

Was this helpful?

Update FHIR r4 immunization

RequestExpand all

Responses

Was this helpful?

Delete FHIR r4 immunization

Request

Responses

Was this helpful?

Get FHIR r4 immunization history by ID

Request

Responses

Was this helpful?

ImmunizationEvaluationCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ImmunizationRecommendationCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

MedicationCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

MedicationAdministrationCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

MedicationDispenseCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

MedicationKnowledgeCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

MedicationRequestCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

MedicationStatementCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

MedicinalProductCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

MedicinalProductAuthorizationCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

MedicinalProductContraindicationCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

MedicinalProductIndicationCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

MedicinalProductIngredientCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

MedicinalProductInteractionCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

MedicinalProductManufacturedCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

MedicinalProductPackagedCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

MedicinalProductPharmaceuticalCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

MedicinalProductUndesirableEffectCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

SubstanceCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

SubstanceNucleicAcidCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

SubstancePolymerCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

SubstanceProteinCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

SubstanceReferenceInformationCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

SubstanceSourceMaterialCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

SubstanceSpecificationCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

HeyDonto FHIR R4 API - Medications (1.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

BiologicallyDerivedProduct
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Immunization
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Request

Request

ImmunizationEvaluation
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

ImmunizationRecommendation
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Medication
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

MedicationAdministration
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

MedicationDispense
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

MedicationKnowledge
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

MedicationRequest
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

MedicationStatement
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

MedicinalProduct
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

MedicinalProductAuthorization
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

MedicinalProductContraindication
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

MedicinalProductIndication
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

MedicinalProductIngredient
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

MedicinalProductInteraction
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

MedicinalProductManufactured
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

MedicinalProductPackaged
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

MedicinalProductPharmaceutical
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

MedicinalProductUndesirableEffect
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Substance
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

SubstanceNucleicAcid
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

SubstancePolymer
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

SubstanceProtein
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

SubstanceReferenceInformation
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

SubstanceSourceMaterial
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

SubstanceSpecification
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude