immunization recommendations
Create Immunization Recommendation
post
/organizations/{organizationId}/fhir/3/ImmunizationRecommendation
A patient's point-in-time immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification.
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | string | ImmunizationRecommendation | This is a ImmunizationRecommendation resource |
identifier | array(Identifier) | A unique identifier assigned to this particular recommendation record. | |
patient* | Reference | The patient the recommendations are for. | |
recommendation* | array(ImmunizationRecommendation_Recommendation) | Vaccine administration recommendations. |
Response
keyboard_arrow_down
Patch Immunization Recommendation
patch
/organizations/{organizationId}/fhir/3/ImmunizationRecommendation/{resourceId}
A patient's point-in-time immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification.
Request
Headers
content-type* | string | application/json-patch+json | application/json-patch+json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Body
resourceType* | string | ImmunizationRecommendation | This is a ImmunizationRecommendation resource |
identifier | array(Identifier) | A unique identifier assigned to this particular recommendation record. | |
patient* | Reference | The patient the recommendations are for. | |
recommendation* | array(ImmunizationRecommendation_Recommendation) | Vaccine administration recommendations. |
Response
keyboard_arrow_down
Read Immunization Recommendation
get
/organizations/{organizationId}/fhir/3/ImmunizationRecommendation/{resourceId}
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
keyboard_arrow_down
Read History Immunization Recommendation
get
/organizations/{organizationId}/fhir/3/ImmunizationRecommendation/{resourceId}/_history
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_count | string | ||
_since | string |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
keyboard_arrow_down
Read Version Immunization Recommendation
get
/organizations/{organizationId}/fhir/3/ImmunizationRecommendation/{resourceId}/_history/{versionId}
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* | |||
versionId* |
Response
keyboard_arrow_down
Remove Immunization Recommendation
delete
/organizations/{organizationId}/fhir/3/ImmunizationRecommendation/{resourceId}
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
keyboard_arrow_down
Search Get Immunization Recommendation
get
/organizations/{organizationId}/fhir/3/ImmunizationRecommendation
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_id | string | ||
_language | string | ||
date | string | ||
dose-number | string | ||
dose-sequence | string | ||
identifier | string | ||
information | string | ||
patient | string | ||
status | string | ||
support | string | ||
target-disease | string | ||
vaccine-type | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Immunization Recommendation
get
/organizations/{organizationId}/fhir/3/ImmunizationRecommendation/_history
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_count | string | ||
_since | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search Post Immunization Recommendation
post
/organizations/{organizationId}/fhir/3/ImmunizationRecommendation/_search
A patient's point-in-time immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification.
Request
Headers
content-type* | string | application/json|application/x-www-form-urlencoded | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_id | string | ||
_language | string | ||
date | string | ||
dose-number | string | ||
dose-sequence | string | ||
identifier | string | ||
information | string | ||
patient | string | ||
status | string | ||
support | string | ||
target-disease | string | ||
vaccine-type | string |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | string | ImmunizationRecommendation | This is a ImmunizationRecommendation resource |
identifier | array(Identifier) | A unique identifier assigned to this particular recommendation record. | |
patient* | Reference | The patient the recommendations are for. | |
recommendation* | array(ImmunizationRecommendation_Recommendation) | Vaccine administration recommendations. |
Response
keyboard_arrow_down
Update Immunization Recommendation
put
/organizations/{organizationId}/fhir/3/ImmunizationRecommendation/{resourceId}
A patient's point-in-time immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification.
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Body
resourceType* | string | ImmunizationRecommendation | This is a ImmunizationRecommendation resource |
identifier | array(Identifier) | A unique identifier assigned to this particular recommendation record. | |
patient* | Reference | The patient the recommendations are for. | |
recommendation* | array(ImmunizationRecommendation_Recommendation) | Vaccine administration recommendations. |
Response
keyboard_arrow_down