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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringRiskAssessmentThis is a RiskAssessment resource
identifierIdentifierBusiness identifier assigned to the risk assessment.
basedOnReferenceA reference to the request that is fulfilled by this risk assessment.
parentReferenceA reference to a resource that this risk assessment is part of, such as a Procedure.
statusstringThe status of the RiskAssessment, using the same statuses as an Observation.
methodCodeableConceptThe algorithm, process or mechanism used to evaluate the risk.
codeCodeableConceptThe type of the risk assessment performed.
subjectReferenceThe patient or group the risk assessment applies to.
contextReferenceThe encounter where the assessment was performed.
occurrenceDateTimestringThe date (and possibly time) the risk assessment was performed.
occurrencePeriodPeriodThe date (and possibly time) the risk assessment was performed.
conditionReferenceFor assessments or prognosis specific to a particular condition, indicates the condition being assessed.
performerReferenceThe provider or software application that performed the assessment.
reasonCodeableConceptCodeableConceptThe reason the risk assessment was performed.
reasonReferenceReferenceThe reason the risk assessment was performed.
basisarray(Reference)Indicates the source data considered as part of the assessment (FamilyHistory, Observations, Procedures, Conditions, etc.).
predictionarray(RiskAssessment_Prediction)Describes the expected outcome for the subject.
mitigationstringA description of the steps that might be taken to reduce the identified risk(s).
commentstringAdditional comments about the risk assessment.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringRiskAssessmentThis is a RiskAssessment resource
identifierIdentifierBusiness identifier assigned to the risk assessment.
basedOnReferenceA reference to the request that is fulfilled by this risk assessment.
parentReferenceA reference to a resource that this risk assessment is part of, such as a Procedure.
statusstringThe status of the RiskAssessment, using the same statuses as an Observation.
methodCodeableConceptThe algorithm, process or mechanism used to evaluate the risk.
codeCodeableConceptThe type of the risk assessment performed.
subjectReferenceThe patient or group the risk assessment applies to.
contextReferenceThe encounter where the assessment was performed.
occurrenceDateTimestringThe date (and possibly time) the risk assessment was performed.
occurrencePeriodPeriodThe date (and possibly time) the risk assessment was performed.
conditionReferenceFor assessments or prognosis specific to a particular condition, indicates the condition being assessed.
performerReferenceThe provider or software application that performed the assessment.
reasonCodeableConceptCodeableConceptThe reason the risk assessment was performed.
reasonReferenceReferenceThe reason the risk assessment was performed.
basisarray(Reference)Indicates the source data considered as part of the assessment (FamilyHistory, Observations, Procedures, Conditions, etc.).
predictionarray(RiskAssessment_Prediction)Describes the expected outcome for the subject.
mitigationstringA description of the steps that might be taken to reduce the identified risk(s).
commentstringAdditional comments about the risk assessment.

Response

Read Risk Assessment

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

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

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

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

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

Request

Headers

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

Query params

_idstring
_languagestring
conditionstring
datestring
encounterstring
identifierstring
methodstring
patientstring
performerstring
probabilitystring
riskstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Risk Assessment

get
/organizations/{organizationId}/fhir/3/RiskAssessment/_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 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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
conditionstring
datestring
encounterstring
identifierstring
methodstring
patientstring
performerstring
probabilitystring
riskstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringRiskAssessmentThis is a RiskAssessment resource
identifierIdentifierBusiness identifier assigned to the risk assessment.
basedOnReferenceA reference to the request that is fulfilled by this risk assessment.
parentReferenceA reference to a resource that this risk assessment is part of, such as a Procedure.
statusstringThe status of the RiskAssessment, using the same statuses as an Observation.
methodCodeableConceptThe algorithm, process or mechanism used to evaluate the risk.
codeCodeableConceptThe type of the risk assessment performed.
subjectReferenceThe patient or group the risk assessment applies to.
contextReferenceThe encounter where the assessment was performed.
occurrenceDateTimestringThe date (and possibly time) the risk assessment was performed.
occurrencePeriodPeriodThe date (and possibly time) the risk assessment was performed.
conditionReferenceFor assessments or prognosis specific to a particular condition, indicates the condition being assessed.
performerReferenceThe provider or software application that performed the assessment.
reasonCodeableConceptCodeableConceptThe reason the risk assessment was performed.
reasonReferenceReferenceThe reason the risk assessment was performed.
basisarray(Reference)Indicates the source data considered as part of the assessment (FamilyHistory, Observations, Procedures, Conditions, etc.).
predictionarray(RiskAssessment_Prediction)Describes the expected outcome for the subject.
mitigationstringA description of the steps that might be taken to reduce the identified risk(s).
commentstringAdditional comments about the risk assessment.

Response

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringRiskAssessmentThis is a RiskAssessment resource
identifierIdentifierBusiness identifier assigned to the risk assessment.
basedOnReferenceA reference to the request that is fulfilled by this risk assessment.
parentReferenceA reference to a resource that this risk assessment is part of, such as a Procedure.
statusstringThe status of the RiskAssessment, using the same statuses as an Observation.
methodCodeableConceptThe algorithm, process or mechanism used to evaluate the risk.
codeCodeableConceptThe type of the risk assessment performed.
subjectReferenceThe patient or group the risk assessment applies to.
contextReferenceThe encounter where the assessment was performed.
occurrenceDateTimestringThe date (and possibly time) the risk assessment was performed.
occurrencePeriodPeriodThe date (and possibly time) the risk assessment was performed.
conditionReferenceFor assessments or prognosis specific to a particular condition, indicates the condition being assessed.
performerReferenceThe provider or software application that performed the assessment.
reasonCodeableConceptCodeableConceptThe reason the risk assessment was performed.
reasonReferenceReferenceThe reason the risk assessment was performed.
basisarray(Reference)Indicates the source data considered as part of the assessment (FamilyHistory, Observations, Procedures, Conditions, etc.).
predictionarray(RiskAssessment_Prediction)Describes the expected outcome for the subject.
mitigationstringA description of the steps that might be taken to reduce the identified risk(s).
commentstringAdditional comments about the risk assessment.

Response