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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringImmunizationRecommendationThis is a ImmunizationRecommendation resource
identifierarray(Identifier)A unique identifier assigned to this particular recommendation record.
patient*ReferenceThe patient the recommendations are for.
recommendation*array(ImmunizationRecommendation_Recommendation)Vaccine administration recommendations.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringImmunizationRecommendationThis is a ImmunizationRecommendation resource
identifierarray(Identifier)A unique identifier assigned to this particular recommendation record.
patient*ReferenceThe patient the recommendations are for.
recommendation*array(ImmunizationRecommendation_Recommendation)Vaccine administration recommendations.

Response

Read Immunization Recommendation

get
/organizations/{organizationId}/fhir/3/ImmunizationRecommendation/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Immunization Recommendation

get
/organizations/{organizationId}/fhir/3/ImmunizationRecommendation/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Immunization Recommendation

get
/organizations/{organizationId}/fhir/3/ImmunizationRecommendation/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Immunization Recommendation

delete
/organizations/{organizationId}/fhir/3/ImmunizationRecommendation/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Immunization Recommendation

get
/organizations/{organizationId}/fhir/3/ImmunizationRecommendation

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
datestring
dose-numberstring
dose-sequencestring
identifierstring
informationstring
patientstring
statusstring
supportstring
target-diseasestring
vaccine-typestring

Params

organizationId*string|stringid|slug

Response

Search History Immunization Recommendation

get
/organizations/{organizationId}/fhir/3/ImmunizationRecommendation/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
datestring
dose-numberstring
dose-sequencestring
identifierstring
informationstring
patientstring
statusstring
supportstring
target-diseasestring
vaccine-typestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringImmunizationRecommendationThis is a ImmunizationRecommendation resource
identifierarray(Identifier)A unique identifier assigned to this particular recommendation record.
patient*ReferenceThe patient the recommendations are for.
recommendation*array(ImmunizationRecommendation_Recommendation)Vaccine administration recommendations.

Response

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringImmunizationRecommendationThis is a ImmunizationRecommendation resource
identifierarray(Identifier)A unique identifier assigned to this particular recommendation record.
patient*ReferenceThe patient the recommendations are for.
recommendation*array(ImmunizationRecommendation_Recommendation)Vaccine administration recommendations.

Response