flags

Create Flag

post
/organizations/{organizationId}/fhir/3/Flag

Prospective warnings of potential issues when providing care to the patient.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringFlagThis is a Flag resource
identifierarray(Identifier)Identifier assigned to the flag for external use (outside the FHIR environment).
statusstringactive|inactive|entered-in-errorSupports basic workflow.
categoryCodeableConceptAllows 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*CodeableConceptThe coded value or textual component of the flag to display to the user.
subject*ReferenceThe patient, location, group , organization , or practitioner, etc. this is about record this flag is associated with.
periodPeriodThe 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.
encounterReferenceThis alert is only relevant during the encounter.
authorReferenceThe person, organization or device that created the flag.

Response

Patch Flag

patch
/organizations/{organizationId}/fhir/3/Flag/{resourceId}

Prospective warnings of potential issues when providing care to the patient.

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*stringFlagThis is a Flag resource
identifierarray(Identifier)Identifier assigned to the flag for external use (outside the FHIR environment).
statusstringactive|inactive|entered-in-errorSupports basic workflow.
categoryCodeableConceptAllows 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*CodeableConceptThe coded value or textual component of the flag to display to the user.
subject*ReferenceThe patient, location, group , organization , or practitioner, etc. this is about record this flag is associated with.
periodPeriodThe 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.
encounterReferenceThis alert is only relevant during the encounter.
authorReferenceThe person, organization or device that created the flag.

Response

Read Flag

get
/organizations/{organizationId}/fhir/3/Flag/{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 Flag

get
/organizations/{organizationId}/fhir/3/Flag/{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 Flag

get
/organizations/{organizationId}/fhir/3/Flag/{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 Flag

delete
/organizations/{organizationId}/fhir/3/Flag/{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 Flag

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

Request

Headers

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

Query params

_idstring
_languagestring
authorstring
datestring
encounterstring
identifierstring
patientstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Flag

get
/organizations/{organizationId}/fhir/3/Flag/_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 Flag

post
/organizations/{organizationId}/fhir/3/Flag/_search

Prospective warnings of potential issues when providing care to the patient.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authorstring
datestring
encounterstring
identifierstring
patientstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringFlagThis is a Flag resource
identifierarray(Identifier)Identifier assigned to the flag for external use (outside the FHIR environment).
statusstringactive|inactive|entered-in-errorSupports basic workflow.
categoryCodeableConceptAllows 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*CodeableConceptThe coded value or textual component of the flag to display to the user.
subject*ReferenceThe patient, location, group , organization , or practitioner, etc. this is about record this flag is associated with.
periodPeriodThe 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.
encounterReferenceThis alert is only relevant during the encounter.
authorReferenceThe person, organization or device that created the flag.

Response

Update Flag

put
/organizations/{organizationId}/fhir/3/Flag/{resourceId}

Prospective warnings of potential issues when providing care to the patient.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringFlagThis is a Flag resource
identifierarray(Identifier)Identifier assigned to the flag for external use (outside the FHIR environment).
statusstringactive|inactive|entered-in-errorSupports basic workflow.
categoryCodeableConceptAllows 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*CodeableConceptThe coded value or textual component of the flag to display to the user.
subject*ReferenceThe patient, location, group , organization , or practitioner, etc. this is about record this flag is associated with.
periodPeriodThe 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.
encounterReferenceThis alert is only relevant during the encounter.
authorReferenceThe person, organization or device that created the flag.

Response