risk assessments

Create Risk Assessment

post

/organizations/{organizationId}/fhir/3/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
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	RiskAssessment	This is a RiskAssessment resource
identifier	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	string		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.
context	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.
reasonCodeableConcept	CodeableConcept		The reason the risk assessment was performed.
reasonReference	Reference		The reason the risk assessment was performed.
basis	array(Reference)		Indicates the source data considered as part of the assessment (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).
comment	string		Additional comments about the risk assessment.

Response

201 400 401 404

Patch Risk Assessment

patch

/organizations/{organizationId}/fhir/3/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*	string	RiskAssessment	This is a RiskAssessment resource
identifier	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	string		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.
context	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.
reasonCodeableConcept	CodeableConcept		The reason the risk assessment was performed.
reasonReference	Reference		The reason the risk assessment was performed.
basis	array(Reference)		Indicates the source data considered as part of the assessment (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).
comment	string		Additional comments about the risk assessment.

Response

200 201 400 401 404 409

Read Risk Assessment

get

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

200 401 404

Read History Risk Assessment

get

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

200 401 404

Read Version Risk Assessment

get

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

200 400 401 404

Remove Risk Assessment

delete

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

200 204 400 401 404 409

Search Get Risk Assessment

get

/organizations/{organizationId}/fhir/3/RiskAssessment

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
condition	string
date	string
encounter	string
identifier	string
method	string
patient	string
performer	string
probability	string
risk	string
subject	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Risk Assessment

get

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

200 401 404

Search Post Risk Assessment

post

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


_id	string
_language	string
condition	string
date	string
encounter	string
identifier	string
method	string
patient	string
performer	string
probability	string
risk	string
subject	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	RiskAssessment	This is a RiskAssessment resource
identifier	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	string		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.
context	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.
reasonCodeableConcept	CodeableConcept		The reason the risk assessment was performed.
reasonReference	Reference		The reason the risk assessment was performed.
basis	array(Reference)		Indicates the source data considered as part of the assessment (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).
comment	string		Additional comments about the risk assessment.

Response

200 401 404

Update Risk Assessment

put

/organizations/{organizationId}/fhir/3/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
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


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

Body


resourceType*	string	RiskAssessment	This is a RiskAssessment resource
identifier	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	string		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.
context	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.
reasonCodeableConcept	CodeableConcept		The reason the risk assessment was performed.
reasonReference	Reference		The reason the risk assessment was performed.
basis	array(Reference)		Indicates the source data considered as part of the assessment (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).
comment	string		Additional comments about the risk assessment.

Response

200 201 400 401 404 409