Immunization
Semantical type
The FHIR resource type is also used as semantical type of the resource. Include the FHIR resource name Immunization into your applications access filter if you need to use this resource.
Resource owner
If the resource contains a patient which is a Patient or Practitioner that user is the owner of the resource. Otherwise the creator of the resource is the owner.
Default value for “patient”
If a resource with no patient field is send to MIDATA, the backend will set the patient to the current user.
Read
Read a single Immunization by id.
Request:
[GET] /fhir/Immunization/<id>
Read specific version
Read a specific version of a single Immunization by id.
Request:
[GET] /fhir/Immunization/<id>/_history/<version>
Retrieve history
Retrieve all versions of a single resource.
Request:
[GET] /fhir/Immunization/<id>/_history
Search
Search for resources of type Immunization
Request:
[GET] /fhir/Immunization?searchParams
List of supported search parameters:
Supported query parameters:
| Name | Type | Description |
|---|---|---|
| _id | token | The ID of the resource |
| _lastUpdated | date | Only return resources which were last updated as specified by the given range |
| _page | string | |
| date | date | Vaccination (non)-Administration Date |
| identifier | token | Business identifier |
| location | reference | The service delivery location or facility in which the vaccine was / was to be administered |
| lot-number | string | Vaccine Lot Number |
| manufacturer | reference | Vaccine Manufacturer |
| patient | reference | The patient for the vaccination record |
| performer | reference | The practitioner or organization who played a role in the vaccination |
| reaction | reference | Additional information on reaction |
| reaction-date | date | When reaction started |
| reason-code | token | Reason why the vaccine was administered |
| reason-reference | reference | Why immunization occurred |
| series | string | The series being followed by the provider |
| status | token | Immunization event status |
| status-reason | token | Reason why the vaccine was not administered |
| target-disease | token | The target disease the dose is being administered against |
| vaccine-code | token | Vaccine Product Administered |
Create
Create a new resource of type Immunization.
Request:
[POST] /fhir/Immunization
Update
Updates a resource of type Immunization.
Request:
[PUT] /fhir/Immunization/<id>