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

Params

organizationId*string|stringid|slug

Body

resourceType*This is a RiskAssessment resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Business 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.
statuscodeThe 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.
subject*ReferenceThe patient or group the risk assessment applies to.
encounterReferenceThe 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.
reasonCodearray(CodeableConcept)The reason the risk assessment was performed.
reasonReferencearray(Reference)Resources supporting the reason the risk assessment was performed.
basisarray(Reference)Indicates the source data considered as part of the assessment (for example, 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).
notearray(Annotation)Additional comments about the risk assessment.

Response

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a RiskAssessment resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Business 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.
statuscodeThe 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.
subject*ReferenceThe patient or group the risk assessment applies to.
encounterReferenceThe 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.
reasonCodearray(CodeableConcept)The reason the risk assessment was performed.
reasonReferencearray(Reference)Resources supporting the reason the risk assessment was performed.
basisarray(Reference)Indicates the source data considered as part of the assessment (for example, 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).
notearray(Annotation)Additional comments about the risk assessment.

Response

Read Risk Assessment

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Risk Assessment

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/RiskAssessment/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Risk Assessment

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Risk Assessment

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

Request

Headers

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

Query params

_idstring
_languagestring
datestring
identifierstring
individualstring
patientstring
statusstring
studystring

Params

organizationId*string|stringid|slug

Response

Search History Risk Assessment

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
datestring
identifierstring
individualstring
patientstring
statusstring
studystring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a RiskAssessment resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Business 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.
statuscodeThe 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.
subject*ReferenceThe patient or group the risk assessment applies to.
encounterReferenceThe 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.
reasonCodearray(CodeableConcept)The reason the risk assessment was performed.
reasonReferencearray(Reference)Resources supporting the reason the risk assessment was performed.
basisarray(Reference)Indicates the source data considered as part of the assessment (for example, 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).
notearray(Annotation)Additional comments about the risk assessment.

Response

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a RiskAssessment resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Business 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.
statuscodeThe 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.
subject*ReferenceThe patient or group the risk assessment applies to.
encounterReferenceThe 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.
reasonCodearray(CodeableConcept)The reason the risk assessment was performed.
reasonReferencearray(Reference)Resources supporting the reason the risk assessment was performed.
basisarray(Reference)Indicates the source data considered as part of the assessment (for example, 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).
notearray(Annotation)Additional comments about the risk assessment.

Response