flags
Create Flag
post
/organizations/{organizationId}/fhir/3/Flag
Prospective warnings of potential issues when providing care to the patient.
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 | Flag | This is a Flag resource |
| identifier | array(Identifier) | Identifier assigned to the flag for external use (outside the FHIR environment). | |
| status | string | active|inactive|entered-in-error | Supports basic workflow. |
| category | CodeableConcept | Allows an flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context. | |
| code* | CodeableConcept | The coded value or textual component of the flag to display to the user. | |
| subject* | Reference | The patient, location, group , organization , or practitioner, etc. this is about record this flag is associated with. | |
| period | Period | The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified. | |
| encounter | Reference | This alert is only relevant during the encounter. | |
| author | Reference | The person, organization or device that created the flag. |
Response
keyboard_arrow_down
Patch Flag
patch
/organizations/{organizationId}/fhir/3/Flag/{resourceId}
Prospective warnings of potential issues when providing care to the 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 | Flag | This is a Flag resource |
| identifier | array(Identifier) | Identifier assigned to the flag for external use (outside the FHIR environment). | |
| status | string | active|inactive|entered-in-error | Supports basic workflow. |
| category | CodeableConcept | Allows an flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context. | |
| code* | CodeableConcept | The coded value or textual component of the flag to display to the user. | |
| subject* | Reference | The patient, location, group , organization , or practitioner, etc. this is about record this flag is associated with. | |
| period | Period | The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified. | |
| encounter | Reference | This alert is only relevant during the encounter. | |
| author | Reference | The person, organization or device that created the flag. |
Response
keyboard_arrow_down
Read Flag
get
/organizations/{organizationId}/fhir/3/Flag/{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 Flag
get
/organizations/{organizationId}/fhir/3/Flag/{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 Flag
get
/organizations/{organizationId}/fhir/3/Flag/{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 Flag
delete
/organizations/{organizationId}/fhir/3/Flag/{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 Flag
get
/organizations/{organizationId}/fhir/3/Flag
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 | ||
| author | string | ||
| date | string | ||
| encounter | string | ||
| identifier | string | ||
| patient | string | ||
| subject | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Flag
get
/organizations/{organizationId}/fhir/3/Flag/_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 Flag
post
/organizations/{organizationId}/fhir/3/Flag/_search
Prospective warnings of potential issues when providing care to the 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 | ||
| author | string | ||
| date | string | ||
| encounter | string | ||
| identifier | string | ||
| patient | string | ||
| subject | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | Flag | This is a Flag resource |
| identifier | array(Identifier) | Identifier assigned to the flag for external use (outside the FHIR environment). | |
| status | string | active|inactive|entered-in-error | Supports basic workflow. |
| category | CodeableConcept | Allows an flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context. | |
| code* | CodeableConcept | The coded value or textual component of the flag to display to the user. | |
| subject* | Reference | The patient, location, group , organization , or practitioner, etc. this is about record this flag is associated with. | |
| period | Period | The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified. | |
| encounter | Reference | This alert is only relevant during the encounter. | |
| author | Reference | The person, organization or device that created the flag. |
Response
keyboard_arrow_down
Update Flag
put
/organizations/{organizationId}/fhir/3/Flag/{resourceId}
Prospective warnings of potential issues when providing care to the patient.
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 | Flag | This is a Flag resource |
| identifier | array(Identifier) | Identifier assigned to the flag for external use (outside the FHIR environment). | |
| status | string | active|inactive|entered-in-error | Supports basic workflow. |
| category | CodeableConcept | Allows an flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context. | |
| code* | CodeableConcept | The coded value or textual component of the flag to display to the user. | |
| subject* | Reference | The patient, location, group , organization , or practitioner, etc. this is about record this flag is associated with. | |
| period | Period | The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified. | |
| encounter | Reference | This alert is only relevant during the encounter. | |
| author | Reference | The person, organization or device that created the flag. |
Response
keyboard_arrow_down