flags

Create Flag

post

/organizations/{organizationId}/fhir/4/Flag

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

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a Flag resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
status		active\|inactive\|entered-in-error	Supports basic workflow.
category	array(CodeableConcept)		Allows a 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

201 400 401 404

Patch Flag

patch

/organizations/{organizationId}/fhir/4/Flag/{resourceId}

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

Nictiz profile: Flag

Request

Headers

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*			This is a Flag resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
status		active\|inactive\|entered-in-error	Supports basic workflow.
category	array(CodeableConcept)		Allows a 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

200 201 400 401 404 409

Read Flag

get

/organizations/{organizationId}/fhir/4/Flag/{resourceId}

Nictiz profile: Flag

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Flag

get

/organizations/{organizationId}/fhir/4/Flag/{resourceId}/_history

Nictiz profile: Flag

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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

200 401 404

Read Version Flag

get

/organizations/{organizationId}/fhir/4/Flag/{resourceId}/_history/{versionId}

Nictiz profile: Flag

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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

200 400 401 404

Remove Flag

delete

/organizations/{organizationId}/fhir/4/Flag/{resourceId}

Nictiz profile: Flag

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Flag

get

/organizations/{organizationId}/fhir/4/Flag

Nictiz profile: Flag

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Flag

get

/organizations/{organizationId}/fhir/4/Flag/_history

Nictiz profile: Flag

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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

200 401 404

Search Post Flag

post

/organizations/{organizationId}/fhir/4/Flag/_search

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

Nictiz profile: Flag

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a Flag resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
status		active\|inactive\|entered-in-error	Supports basic workflow.
category	array(CodeableConcept)		Allows a 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

200 401 404

Update Flag

put

/organizations/{organizationId}/fhir/4/Flag/{resourceId}

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

Nictiz profile: Flag

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	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*			This is a Flag resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
status		active\|inactive\|entered-in-error	Supports basic workflow.
category	array(CodeableConcept)		Allows a 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

200 201 400 401 404 409