risk assessments

Create Risk Assessment

post

/organizations/{organizationId}/fhir/4/RiskAssessment

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

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*		This is a RiskAssessment 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 identifier assigned to the risk assessment.
basedOn	Reference	A reference to the request that is fulfilled by this risk assessment.
parent	Reference	A reference to a resource that this risk assessment is part of, such as a Procedure.
status	code	The status of the RiskAssessment, using the same statuses as an Observation.
method	CodeableConcept	The algorithm, process or mechanism used to evaluate the risk.
code	CodeableConcept	The type of the risk assessment performed.
subject*	Reference	The patient or group the risk assessment applies to.
encounter	Reference	The encounter where the assessment was performed.
occurrenceDateTime	string	The date (and possibly time) the risk assessment was performed.
occurrencePeriod	Period	The date (and possibly time) the risk assessment was performed.
condition	Reference	For assessments or prognosis specific to a particular condition, indicates the condition being assessed.
performer	Reference	The provider or software application that performed the assessment.
reasonCode	array(CodeableConcept)	The reason the risk assessment was performed.
reasonReference	array(Reference)	Resources supporting the reason the risk assessment was performed.
basis	array(Reference)	Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.).
prediction	array(RiskAssessment_Prediction)	Describes the expected outcome for the subject.
mitigation	string	A description of the steps that might be taken to reduce the identified risk(s).
note	array(Annotation)	Additional comments about the risk assessment.

Response

201 400 401 404

Patch Risk Assessment

patch

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

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

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*		This is a RiskAssessment 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 identifier assigned to the risk assessment.
basedOn	Reference	A reference to the request that is fulfilled by this risk assessment.
parent	Reference	A reference to a resource that this risk assessment is part of, such as a Procedure.
status	code	The status of the RiskAssessment, using the same statuses as an Observation.
method	CodeableConcept	The algorithm, process or mechanism used to evaluate the risk.
code	CodeableConcept	The type of the risk assessment performed.
subject*	Reference	The patient or group the risk assessment applies to.
encounter	Reference	The encounter where the assessment was performed.
occurrenceDateTime	string	The date (and possibly time) the risk assessment was performed.
occurrencePeriod	Period	The date (and possibly time) the risk assessment was performed.
condition	Reference	For assessments or prognosis specific to a particular condition, indicates the condition being assessed.
performer	Reference	The provider or software application that performed the assessment.
reasonCode	array(CodeableConcept)	The reason the risk assessment was performed.
reasonReference	array(Reference)	Resources supporting the reason the risk assessment was performed.
basis	array(Reference)	Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.).
prediction	array(RiskAssessment_Prediction)	Describes the expected outcome for the subject.
mitigation	string	A description of the steps that might be taken to reduce the identified risk(s).
note	array(Annotation)	Additional comments about the risk assessment.

Response

200 201 400 401 404 409

Read Risk Assessment

get

/organizations/{organizationId}/fhir/4/RiskAssessment/{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

200 401 404

Read History Risk Assessment

get

/organizations/{organizationId}/fhir/4/RiskAssessment/{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

200 401 404

Read Version Risk Assessment

get

/organizations/{organizationId}/fhir/4/RiskAssessment/{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

200 400 401 404

Remove Risk Assessment

delete

/organizations/{organizationId}/fhir/4/RiskAssessment/{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

200 204 400 401 404 409

Search Get Risk Assessment

get

/organizations/{organizationId}/fhir/4/RiskAssessment

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

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Risk Assessment

get

/organizations/{organizationId}/fhir/4/RiskAssessment/_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

200 401 404

Search Post Risk Assessment

post

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

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

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

Params


organizationId*	string\|string		id\|slug

Body


resourceType*		This is a RiskAssessment 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 identifier assigned to the risk assessment.
basedOn	Reference	A reference to the request that is fulfilled by this risk assessment.
parent	Reference	A reference to a resource that this risk assessment is part of, such as a Procedure.
status	code	The status of the RiskAssessment, using the same statuses as an Observation.
method	CodeableConcept	The algorithm, process or mechanism used to evaluate the risk.
code	CodeableConcept	The type of the risk assessment performed.
subject*	Reference	The patient or group the risk assessment applies to.
encounter	Reference	The encounter where the assessment was performed.
occurrenceDateTime	string	The date (and possibly time) the risk assessment was performed.
occurrencePeriod	Period	The date (and possibly time) the risk assessment was performed.
condition	Reference	For assessments or prognosis specific to a particular condition, indicates the condition being assessed.
performer	Reference	The provider or software application that performed the assessment.
reasonCode	array(CodeableConcept)	The reason the risk assessment was performed.
reasonReference	array(Reference)	Resources supporting the reason the risk assessment was performed.
basis	array(Reference)	Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.).
prediction	array(RiskAssessment_Prediction)	Describes the expected outcome for the subject.
mitigation	string	A description of the steps that might be taken to reduce the identified risk(s).
note	array(Annotation)	Additional comments about the risk assessment.

Response

200 401 404

Update Risk Assessment

put

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

An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.

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*		This is a RiskAssessment 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 identifier assigned to the risk assessment.
basedOn	Reference	A reference to the request that is fulfilled by this risk assessment.
parent	Reference	A reference to a resource that this risk assessment is part of, such as a Procedure.
status	code	The status of the RiskAssessment, using the same statuses as an Observation.
method	CodeableConcept	The algorithm, process or mechanism used to evaluate the risk.
code	CodeableConcept	The type of the risk assessment performed.
subject*	Reference	The patient or group the risk assessment applies to.
encounter	Reference	The encounter where the assessment was performed.
occurrenceDateTime	string	The date (and possibly time) the risk assessment was performed.
occurrencePeriod	Period	The date (and possibly time) the risk assessment was performed.
condition	Reference	For assessments or prognosis specific to a particular condition, indicates the condition being assessed.
performer	Reference	The provider or software application that performed the assessment.
reasonCode	array(CodeableConcept)	The reason the risk assessment was performed.
reasonReference	array(Reference)	Resources supporting the reason the risk assessment was performed.
basis	array(Reference)	Indicates the source data considered as part of the assessment (for example, FamilyHistory, Observations, Procedures, Conditions, etc.).
prediction	array(RiskAssessment_Prediction)	Describes the expected outcome for the subject.
mitigation	string	A description of the steps that might be taken to reduce the identified risk(s).
note	array(Annotation)	Additional comments about the risk assessment.

Response

200 201 400 401 404 409