vision prescriptions
Create Vision Prescription
post
/organizations/{organizationId}/fhir/3/VisionPrescription
An authorization for the supply of glasses and/or contact lenses to a patient.
Request
Headers
content-type* | string | application/json | 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 | VisionPrescription | This is a VisionPrescription resource |
identifier | array(Identifier) | Business identifier which may be used by other parties to reference or identify the prescription. | |
status | string | The status of the resource instance. | |
patient | Reference | A link to a resource representing the person to whom the vision products will be supplied. | |
encounter | Reference | A link to a resource that identifies the particular occurrence of contact between patient and health care provider. | |
dateWritten | string | The date (and perhaps time) when the prescription was written. | |
prescriber | Reference | The healthcare professional responsible for authorizing the prescription. | |
reasonCodeableConcept | CodeableConcept | Can be the reason or the indication for writing the prescription. | |
reasonReference | Reference | Can be the reason or the indication for writing the prescription. | |
dispense | array(VisionPrescription_Dispense) | Deals with details of the dispense part of the supply specification. |
Response
keyboard_arrow_down
Patch Vision Prescription
patch
/organizations/{organizationId}/fhir/3/VisionPrescription/{resourceId}
An authorization for the supply of glasses and/or contact lenses to a patient.
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 | VisionPrescription | This is a VisionPrescription resource |
identifier | array(Identifier) | Business identifier which may be used by other parties to reference or identify the prescription. | |
status | string | The status of the resource instance. | |
patient | Reference | A link to a resource representing the person to whom the vision products will be supplied. | |
encounter | Reference | A link to a resource that identifies the particular occurrence of contact between patient and health care provider. | |
dateWritten | string | The date (and perhaps time) when the prescription was written. | |
prescriber | Reference | The healthcare professional responsible for authorizing the prescription. | |
reasonCodeableConcept | CodeableConcept | Can be the reason or the indication for writing the prescription. | |
reasonReference | Reference | Can be the reason or the indication for writing the prescription. | |
dispense | array(VisionPrescription_Dispense) | Deals with details of the dispense part of the supply specification. |
Response
keyboard_arrow_down
Read Vision Prescription
get
/organizations/{organizationId}/fhir/3/VisionPrescription/{resourceId}
Request
Headers
content-type* | string | application/json | 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 Vision Prescription
get
/organizations/{organizationId}/fhir/3/VisionPrescription/{resourceId}/_history
Request
Headers
content-type* | string | application/json | 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 Vision Prescription
get
/organizations/{organizationId}/fhir/3/VisionPrescription/{resourceId}/_history/{versionId}
Request
Headers
content-type* | string | application/json | 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 Vision Prescription
delete
/organizations/{organizationId}/fhir/3/VisionPrescription/{resourceId}
Request
Headers
content-type* | string | application/json | 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 Vision Prescription
get
/organizations/{organizationId}/fhir/3/VisionPrescription
Request
Headers
content-type* | string | application/json | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_id | string | ||
_language | string | ||
datewritten | string | ||
encounter | string | ||
identifier | string | ||
patient | string | ||
prescriber | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Vision Prescription
get
/organizations/{organizationId}/fhir/3/VisionPrescription/_history
Request
Headers
content-type* | string | application/json | 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 Vision Prescription
post
/organizations/{organizationId}/fhir/3/VisionPrescription/_search
An authorization for the supply of glasses and/or contact lenses to a patient.
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 | ||
datewritten | string | ||
encounter | string | ||
identifier | string | ||
patient | string | ||
prescriber | string |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | string | VisionPrescription | This is a VisionPrescription resource |
identifier | array(Identifier) | Business identifier which may be used by other parties to reference or identify the prescription. | |
status | string | The status of the resource instance. | |
patient | Reference | A link to a resource representing the person to whom the vision products will be supplied. | |
encounter | Reference | A link to a resource that identifies the particular occurrence of contact between patient and health care provider. | |
dateWritten | string | The date (and perhaps time) when the prescription was written. | |
prescriber | Reference | The healthcare professional responsible for authorizing the prescription. | |
reasonCodeableConcept | CodeableConcept | Can be the reason or the indication for writing the prescription. | |
reasonReference | Reference | Can be the reason or the indication for writing the prescription. | |
dispense | array(VisionPrescription_Dispense) | Deals with details of the dispense part of the supply specification. |
Response
keyboard_arrow_down
Update Vision Prescription
put
/organizations/{organizationId}/fhir/3/VisionPrescription/{resourceId}
An authorization for the supply of glasses and/or contact lenses to a patient.
Request
Headers
content-type* | string | application/json | 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 | VisionPrescription | This is a VisionPrescription resource |
identifier | array(Identifier) | Business identifier which may be used by other parties to reference or identify the prescription. | |
status | string | The status of the resource instance. | |
patient | Reference | A link to a resource representing the person to whom the vision products will be supplied. | |
encounter | Reference | A link to a resource that identifies the particular occurrence of contact between patient and health care provider. | |
dateWritten | string | The date (and perhaps time) when the prescription was written. | |
prescriber | Reference | The healthcare professional responsible for authorizing the prescription. | |
reasonCodeableConcept | CodeableConcept | Can be the reason or the indication for writing the prescription. | |
reasonReference | Reference | Can be the reason or the indication for writing the prescription. | |
dispense | array(VisionPrescription_Dispense) | Deals with details of the dispense part of the supply specification. |
Response
keyboard_arrow_down