clinical impressions

Create Clinical Impression

post
/organizations/{organizationId}/fhir/4/ClinicalImpression

A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.

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 ClinicalImpression 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 identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
statuscodeIdentifies the workflow status of the assessment.
statusReasonCodeableConceptCaptures the reason for the current state of the ClinicalImpression.
codeCodeableConceptCategorizes the type of clinical assessment performed.
descriptionstringA summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.
subject*ReferenceThe patient or group of individuals assessed as part of this record.
encounterReferenceThe Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated.
effectiveDateTimestringThe point in time or period over which the subject was assessed.
effectivePeriodPeriodThe point in time or period over which the subject was assessed.
datedateTimeIndicates when the documentation of the assessment was complete.
assessorReferenceThe clinician performing the assessment.
previousReferenceA reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.
problemarray(Reference)A list of the relevant problems/conditions for a patient.
investigationarray(ClinicalImpression_Investigation)One or more sets of investigations (signs, symptoms, etc.). The actual grouping of investigations varies greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.
protocolarray(uri)Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.
summarystringA text summary of the investigations and the diagnosis.
findingarray(ClinicalImpression_Finding)Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.
prognosisCodeableConceptarray(CodeableConcept)Estimate of likely outcome.
prognosisReferencearray(Reference)RiskAssessment expressing likely outcome.
supportingInfoarray(Reference)Information supporting the clinical impression.
notearray(Annotation)Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear.

Response

Patch Clinical Impression

patch
/organizations/{organizationId}/fhir/4/ClinicalImpression/{resourceId}

A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.

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 ClinicalImpression 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 identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
statuscodeIdentifies the workflow status of the assessment.
statusReasonCodeableConceptCaptures the reason for the current state of the ClinicalImpression.
codeCodeableConceptCategorizes the type of clinical assessment performed.
descriptionstringA summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.
subject*ReferenceThe patient or group of individuals assessed as part of this record.
encounterReferenceThe Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated.
effectiveDateTimestringThe point in time or period over which the subject was assessed.
effectivePeriodPeriodThe point in time or period over which the subject was assessed.
datedateTimeIndicates when the documentation of the assessment was complete.
assessorReferenceThe clinician performing the assessment.
previousReferenceA reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.
problemarray(Reference)A list of the relevant problems/conditions for a patient.
investigationarray(ClinicalImpression_Investigation)One or more sets of investigations (signs, symptoms, etc.). The actual grouping of investigations varies greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.
protocolarray(uri)Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.
summarystringA text summary of the investigations and the diagnosis.
findingarray(ClinicalImpression_Finding)Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.
prognosisCodeableConceptarray(CodeableConcept)Estimate of likely outcome.
prognosisReferencearray(Reference)RiskAssessment expressing likely outcome.
supportingInfoarray(Reference)Information supporting the clinical impression.
notearray(Annotation)Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear.

Response

Read Clinical Impression

get
/organizations/{organizationId}/fhir/4/ClinicalImpression/{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 Clinical Impression

get
/organizations/{organizationId}/fhir/4/ClinicalImpression/{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 Clinical Impression

get
/organizations/{organizationId}/fhir/4/ClinicalImpression/{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 Clinical Impression

delete
/organizations/{organizationId}/fhir/4/ClinicalImpression/{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 Clinical Impression

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

Request

Headers

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

Query params

_idstring
_languagestring
assessorstring
datestring
encounterstring
finding-codestring
finding-refstring
identifierstring
investigationstring
patientstring
previousstring
problemstring
statusstring
subjectstring
supporting-infostring

Params

organizationId*string|stringid|slug

Response

Search History Clinical Impression

get
/organizations/{organizationId}/fhir/4/ClinicalImpression/_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 Clinical Impression

post
/organizations/{organizationId}/fhir/4/ClinicalImpression/_search

A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
assessorstring
datestring
encounterstring
finding-codestring
finding-refstring
identifierstring
investigationstring
patientstring
previousstring
problemstring
statusstring
subjectstring
supporting-infostring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a ClinicalImpression 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 identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
statuscodeIdentifies the workflow status of the assessment.
statusReasonCodeableConceptCaptures the reason for the current state of the ClinicalImpression.
codeCodeableConceptCategorizes the type of clinical assessment performed.
descriptionstringA summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.
subject*ReferenceThe patient or group of individuals assessed as part of this record.
encounterReferenceThe Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated.
effectiveDateTimestringThe point in time or period over which the subject was assessed.
effectivePeriodPeriodThe point in time or period over which the subject was assessed.
datedateTimeIndicates when the documentation of the assessment was complete.
assessorReferenceThe clinician performing the assessment.
previousReferenceA reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.
problemarray(Reference)A list of the relevant problems/conditions for a patient.
investigationarray(ClinicalImpression_Investigation)One or more sets of investigations (signs, symptoms, etc.). The actual grouping of investigations varies greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.
protocolarray(uri)Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.
summarystringA text summary of the investigations and the diagnosis.
findingarray(ClinicalImpression_Finding)Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.
prognosisCodeableConceptarray(CodeableConcept)Estimate of likely outcome.
prognosisReferencearray(Reference)RiskAssessment expressing likely outcome.
supportingInfoarray(Reference)Information supporting the clinical impression.
notearray(Annotation)Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear.

Response

Update Clinical Impression

put
/organizations/{organizationId}/fhir/4/ClinicalImpression/{resourceId}

A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.

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 ClinicalImpression 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 identifiers assigned to this clinical impression by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
statuscodeIdentifies the workflow status of the assessment.
statusReasonCodeableConceptCaptures the reason for the current state of the ClinicalImpression.
codeCodeableConceptCategorizes the type of clinical assessment performed.
descriptionstringA summary of the context and/or cause of the assessment - why / where it was performed, and what patient events/status prompted it.
subject*ReferenceThe patient or group of individuals assessed as part of this record.
encounterReferenceThe Encounter during which this ClinicalImpression was created or to which the creation of this record is tightly associated.
effectiveDateTimestringThe point in time or period over which the subject was assessed.
effectivePeriodPeriodThe point in time or period over which the subject was assessed.
datedateTimeIndicates when the documentation of the assessment was complete.
assessorReferenceThe clinician performing the assessment.
previousReferenceA reference to the last assessment that was conducted on this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.
problemarray(Reference)A list of the relevant problems/conditions for a patient.
investigationarray(ClinicalImpression_Investigation)One or more sets of investigations (signs, symptoms, etc.). The actual grouping of investigations varies greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.
protocolarray(uri)Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.
summarystringA text summary of the investigations and the diagnosis.
findingarray(ClinicalImpression_Finding)Specific findings or diagnoses that were considered likely or relevant to ongoing treatment.
prognosisCodeableConceptarray(CodeableConcept)Estimate of likely outcome.
prognosisReferencearray(Reference)RiskAssessment expressing likely outcome.
supportingInfoarray(Reference)Information supporting the clinical impression.
notearray(Annotation)Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear.

Response