Implementation Guide
23.1.0 - R4 APIs
Publish Box goes here
Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-clinicalimpressn-profile | Version: 23.1.0 | |||
Active as of 2022-03-01 | Computable Name: AthenaClinicalImpression |
athena clinicalimpression profile
This ClinicalImpression profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.
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
This profile is used to define the content that will be returned by the API Server in response to requests to access ClinicalImpression resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.
The ClinicalImpression resource is 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. It is derived from the ASSESS table in athenaPractice and in athenaFlow. Specific detail can be found in the Mappings tab in the profile detail page.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ClinicalImpression
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ClinicalImpression | 0..* | ClinicalImpression | A clinical assessment performed when planning treatments and management strategies for a patient | |
id | 1..1 | id | Logical id of this artifact | |
meta | 0..1 | Meta | Metadata about the resource | |
versionId | 0..1 | id | Version specific identifier | |
lastUpdated | 0..1 | instant | When the resource version last changed | |
Slices for profile | 1..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | |
profile:Athena ClinicalImpression Profile | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-clinicalimpressn-profile | |
Slices for security | 0..4 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding | |
security:SENSITIVECHART | 0..1 | Coding | Security Labels applied to this resource | |
security:CONFABBR | 0..1 | Coding | Security Labels applied to this resource | |
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
security:LOCATION | 0..1 | Coding | Security Labels applied to this resource | |
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
security:CONFTYPEID | 0..1 | Coding | Security Labels applied to this resource | |
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
tag | 1..2 | Coding | Tags applied to this resource | |
identifier | 0..* | Identifier | Business identifier | |
status | 1..1 | code | in-progress | completed | entered-in-error | |
subject | 1..1 | Reference(Patient) | Patient or group assessed | |
encounter | 0..1 | Reference(Encounter) | Encounter created as part of | |
effective[x] | 0..1 | dateTime | Time of assessment | |
date | 0..1 | dateTime | When the assessment was documented | |
assessor | 0..1 | Reference(Practitioner) | The clinician performing the assessment | |
problem | 0..* | Reference(Condition) | Relevant impressions of patient state | |
summary | 0..1 | string | Summary of the assessment | |
note | 0..* | Annotation | Comments made about the ClinicalImpression | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ClinicalImpression | 0..* | ClinicalImpression | A clinical assessment performed when planning treatments and management strategies for a patient | |
id | Σ | 1..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
versionId | Σ | 0..1 | id | Version specific identifier |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
Slices for profile | Σ | 1..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri |
profile:Athena ClinicalImpression Profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-clinicalimpressn-profile |
Slices for security | Σ | 0..4 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:SENSITIVECHART | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:CONFABBR | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
security:LOCATION | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
security:CONFTYPEID | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
tag | Σ | 1..2 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Business identifier |
status | ?!Σ | 1..1 | code | in-progress | completed | entered-in-error Binding: ClinicalImpressionStatus (required): The workflow state of a clinical impression. |
subject | Σ | 1..1 | Reference(Patient) | Patient or group assessed |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
effective[x] | Σ | 0..1 | dateTime | Time of assessment |
date | Σ | 0..1 | dateTime | When the assessment was documented |
assessor | Σ | 0..1 | Reference(Practitioner) | The clinician performing the assessment |
problem | Σ | 0..* | Reference(Condition) | Relevant impressions of patient state |
summary | 0..1 | string | Summary of the assessment | |
note | 0..* | Annotation | Comments made about the ClinicalImpression | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ClinicalImpression.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
ClinicalImpression.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
ClinicalImpression.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
ClinicalImpression.meta.security:LOCATION | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
ClinicalImpression.meta.security:CONFTYPEID | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
ClinicalImpression.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | |
ClinicalImpression.status | required | ClinicalImpressionStatushttp://hl7.org/fhir/ValueSet/clinicalimpression-status|4.0.1 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ClinicalImpression | 0..* | ClinicalImpression | A clinical assessment performed when planning treatments and management strategies for a patient | |||||
id | Σ | 1..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
Slices for profile | Σ | 1..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | ||||
profile:Athena ClinicalImpression Profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-clinicalimpressn-profile | ||||
Slices for security | Σ | 0..4 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:SENSITIVECHART | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:CONFABBR | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
security:LOCATION | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
security:CONFTYPEID | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag | Σ | 1..2 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Business identifier | ||||
status | ?!Σ | 1..1 | code | in-progress | completed | entered-in-error Binding: ClinicalImpressionStatus (required): The workflow state of a clinical impression. | ||||
statusReason | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes identifying the reason for the current state of a clinical impression. | |||||
code | Σ | 0..1 | CodeableConcept | Kind of assessment performed Binding: (unbound) (example): Identifies categories of clinical impressions. This is a place-holder only. It may be removed. | ||||
description | Σ | 0..1 | string | Why/how the assessment was performed | ||||
subject | Σ | 1..1 | Reference(Patient) | Patient or group assessed | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
effective[x] | Σ | 0..1 | dateTime | Time of assessment | ||||
date | Σ | 0..1 | dateTime | When the assessment was documented | ||||
assessor | Σ | 0..1 | Reference(Practitioner) | The clinician performing the assessment | ||||
previous | 0..1 | Reference(ClinicalImpression) | Reference to last assessment | |||||
problem | Σ | 0..* | Reference(Condition) | Relevant impressions of patient state | ||||
investigation | 0..* | BackboneElement | One or more sets of investigations (signs, symptoms, etc.) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | CodeableConcept | A name/code for the set Binding: InvestigationType (example): A name/code for a set of investigations. | |||||
item | 0..* | Reference(Observation | QuestionnaireResponse | FamilyMemberHistory | DiagnosticReport | RiskAssessment | ImagingStudy | Media) | Record of a specific investigation | |||||
protocol | 0..* | uri | Clinical Protocol followed | |||||
summary | 0..1 | string | Summary of the assessment | |||||
finding | 0..* | BackboneElement | Possible or likely findings and diagnoses | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
itemCodeableConcept | 0..1 | CodeableConcept | What was found Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis. | |||||
itemReference | 0..1 | Reference(Condition | Observation | Media) | What was found | |||||
basis | 0..1 | string | Which investigations support finding | |||||
prognosisCodeableConcept | 0..* | CodeableConcept | Estimate of likely outcome Binding: ClinicalImpressionPrognosis (example): Prognosis or outlook findings. | |||||
prognosisReference | 0..* | Reference(RiskAssessment) | RiskAssessment expressing likely outcome | |||||
supportingInfo | 0..* | Reference(Resource) | Information supporting the clinical impression | |||||
note | 0..* | Annotation | Comments made about the ClinicalImpression | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
ClinicalImpression.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
ClinicalImpression.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
ClinicalImpression.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
ClinicalImpression.meta.security:LOCATION | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
ClinicalImpression.meta.security:CONFTYPEID | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
ClinicalImpression.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
ClinicalImpression.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ClinicalImpression.status | required | ClinicalImpressionStatushttp://hl7.org/fhir/ValueSet/clinicalimpression-status|4.0.1 from the FHIR Standard | ||||
ClinicalImpression.statusReason | example | |||||
ClinicalImpression.code | example | |||||
ClinicalImpression.investigation.code | example | InvestigationTypehttp://hl7.org/fhir/ValueSet/investigation-sets from the FHIR Standard | ||||
ClinicalImpression.finding.itemCodeableConcept | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
ClinicalImpression.prognosisCodeableConcept | example | ClinicalImpressionPrognosishttp://hl7.org/fhir/ValueSet/clinicalimpression-prognosis from the FHIR Standard |
This structure is derived from ClinicalImpression
Summary
Mandatory: 3 elements(9 nested mandatory elements)
Fixed: 1 element
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ClinicalImpression
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ClinicalImpression | 0..* | ClinicalImpression | A clinical assessment performed when planning treatments and management strategies for a patient | |
id | 1..1 | id | Logical id of this artifact | |
meta | 0..1 | Meta | Metadata about the resource | |
versionId | 0..1 | id | Version specific identifier | |
lastUpdated | 0..1 | instant | When the resource version last changed | |
Slices for profile | 1..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | |
profile:Athena ClinicalImpression Profile | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-clinicalimpressn-profile | |
Slices for security | 0..4 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding | |
security:SENSITIVECHART | 0..1 | Coding | Security Labels applied to this resource | |
security:CONFABBR | 0..1 | Coding | Security Labels applied to this resource | |
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
security:LOCATION | 0..1 | Coding | Security Labels applied to this resource | |
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
security:CONFTYPEID | 0..1 | Coding | Security Labels applied to this resource | |
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
tag | 1..2 | Coding | Tags applied to this resource | |
identifier | 0..* | Identifier | Business identifier | |
status | 1..1 | code | in-progress | completed | entered-in-error | |
subject | 1..1 | Reference(Patient) | Patient or group assessed | |
encounter | 0..1 | Reference(Encounter) | Encounter created as part of | |
effective[x] | 0..1 | dateTime | Time of assessment | |
date | 0..1 | dateTime | When the assessment was documented | |
assessor | 0..1 | Reference(Practitioner) | The clinician performing the assessment | |
problem | 0..* | Reference(Condition) | Relevant impressions of patient state | |
summary | 0..1 | string | Summary of the assessment | |
note | 0..* | Annotation | Comments made about the ClinicalImpression | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ClinicalImpression | 0..* | ClinicalImpression | A clinical assessment performed when planning treatments and management strategies for a patient | |
id | Σ | 1..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
versionId | Σ | 0..1 | id | Version specific identifier |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
Slices for profile | Σ | 1..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri |
profile:Athena ClinicalImpression Profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-clinicalimpressn-profile |
Slices for security | Σ | 0..4 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:SENSITIVECHART | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:CONFABBR | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
security:LOCATION | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
security:CONFTYPEID | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
system | Σ | 1..1 | uri | Identity of the terminology system |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
tag | Σ | 1..2 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Business identifier |
status | ?!Σ | 1..1 | code | in-progress | completed | entered-in-error Binding: ClinicalImpressionStatus (required): The workflow state of a clinical impression. |
subject | Σ | 1..1 | Reference(Patient) | Patient or group assessed |
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of |
effective[x] | Σ | 0..1 | dateTime | Time of assessment |
date | Σ | 0..1 | dateTime | When the assessment was documented |
assessor | Σ | 0..1 | Reference(Practitioner) | The clinician performing the assessment |
problem | Σ | 0..* | Reference(Condition) | Relevant impressions of patient state |
summary | 0..1 | string | Summary of the assessment | |
note | 0..* | Annotation | Comments made about the ClinicalImpression | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ClinicalImpression.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
ClinicalImpression.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
ClinicalImpression.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
ClinicalImpression.meta.security:LOCATION | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
ClinicalImpression.meta.security:CONFTYPEID | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | |
ClinicalImpression.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | |
ClinicalImpression.status | required | ClinicalImpressionStatushttp://hl7.org/fhir/ValueSet/clinicalimpression-status|4.0.1 from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ClinicalImpression | 0..* | ClinicalImpression | A clinical assessment performed when planning treatments and management strategies for a patient | |||||
id | Σ | 1..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
Slices for profile | Σ | 1..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | ||||
profile:Athena ClinicalImpression Profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-clinicalimpressn-profile | ||||
Slices for security | Σ | 0..4 | Coding | Security Labels applied to this resource Slice: Unordered, Open by value:coding Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:SENSITIVECHART | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:CONFABBR | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
security:LOCATION | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
security:CONFTYPEID | Σ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag | Σ | 1..2 | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Business identifier | ||||
status | ?!Σ | 1..1 | code | in-progress | completed | entered-in-error Binding: ClinicalImpressionStatus (required): The workflow state of a clinical impression. | ||||
statusReason | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes identifying the reason for the current state of a clinical impression. | |||||
code | Σ | 0..1 | CodeableConcept | Kind of assessment performed Binding: (unbound) (example): Identifies categories of clinical impressions. This is a place-holder only. It may be removed. | ||||
description | Σ | 0..1 | string | Why/how the assessment was performed | ||||
subject | Σ | 1..1 | Reference(Patient) | Patient or group assessed | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
effective[x] | Σ | 0..1 | dateTime | Time of assessment | ||||
date | Σ | 0..1 | dateTime | When the assessment was documented | ||||
assessor | Σ | 0..1 | Reference(Practitioner) | The clinician performing the assessment | ||||
previous | 0..1 | Reference(ClinicalImpression) | Reference to last assessment | |||||
problem | Σ | 0..* | Reference(Condition) | Relevant impressions of patient state | ||||
investigation | 0..* | BackboneElement | One or more sets of investigations (signs, symptoms, etc.) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | CodeableConcept | A name/code for the set Binding: InvestigationType (example): A name/code for a set of investigations. | |||||
item | 0..* | Reference(Observation | QuestionnaireResponse | FamilyMemberHistory | DiagnosticReport | RiskAssessment | ImagingStudy | Media) | Record of a specific investigation | |||||
protocol | 0..* | uri | Clinical Protocol followed | |||||
summary | 0..1 | string | Summary of the assessment | |||||
finding | 0..* | BackboneElement | Possible or likely findings and diagnoses | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
itemCodeableConcept | 0..1 | CodeableConcept | What was found Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis. | |||||
itemReference | 0..1 | Reference(Condition | Observation | Media) | What was found | |||||
basis | 0..1 | string | Which investigations support finding | |||||
prognosisCodeableConcept | 0..* | CodeableConcept | Estimate of likely outcome Binding: ClinicalImpressionPrognosis (example): Prognosis or outlook findings. | |||||
prognosisReference | 0..* | Reference(RiskAssessment) | RiskAssessment expressing likely outcome | |||||
supportingInfo | 0..* | Reference(Resource) | Information supporting the clinical impression | |||||
note | 0..* | Annotation | Comments made about the ClinicalImpression | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
ClinicalImpression.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
ClinicalImpression.meta.security:SENSITIVECHART | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
ClinicalImpression.meta.security:CONFABBR | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
ClinicalImpression.meta.security:LOCATION | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
ClinicalImpression.meta.security:CONFTYPEID | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
ClinicalImpression.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
ClinicalImpression.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ClinicalImpression.status | required | ClinicalImpressionStatushttp://hl7.org/fhir/ValueSet/clinicalimpression-status|4.0.1 from the FHIR Standard | ||||
ClinicalImpression.statusReason | example | |||||
ClinicalImpression.code | example | |||||
ClinicalImpression.investigation.code | example | InvestigationTypehttp://hl7.org/fhir/ValueSet/investigation-sets from the FHIR Standard | ||||
ClinicalImpression.finding.itemCodeableConcept | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
ClinicalImpression.prognosisCodeableConcept | example | ClinicalImpressionPrognosishttp://hl7.org/fhir/ValueSet/clinicalimpression-prognosis from the FHIR Standard |
This structure is derived from ClinicalImpression
Summary
Mandatory: 3 elements(9 nested mandatory elements)
Fixed: 1 element
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
Interactions supported by this resource are listed below.
Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for ClinicalImpression resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.
GET [base]/fhir/ClinicalImpression?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}
Where:
Name | Description |
---|---|
[base] | Specifies the base URL of the FHIR Server, e.g., https://apsandbox.fhirapi.athenahealth.com/demoAPIServer |
[_count] | Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results ClinicalImpression resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Athenahealth Partner program. Note: The API Server support the HL7 FHIR Paging capability. |
[_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
[_summary] | Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets. |
_id (token) | The ID of the resource |
_security (token) | Search by a security label |
_tag (token) | Search by a resource tag |
_lastUpdated (date) | |
_lastUpdated-fromnow (quantity) | Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time, e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
identifier (token) | Business identifier |
assessor (reference) | The clinician performing the assessment |
encounter (reference) | Encounter created as part of |
encounter-or-historical (reference) | |
date (date) | When the assessment was documented |
date-fromnow (quantity) | Like occurrence except expressed as a positive or negative offset from the current time in units of time, e.g. occurrence-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
problem (reference) | Relevant impressions of patient state |
status (token) | in-progress | completed | entered-in-error |
subject (reference) | Patient or group assessed |
patient (reference) | Patient or group assessed |
The following HTTP response codes are returned by this API call:
200 OK | The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found. |
401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |