Te Whatu Ora, Central Region Integration Hub
1.0.10-rc1 - ci-build
Te Whatu Ora, Central Region Integration Hub
1.0.10-rc1 - ci-build
Te Whatu Ora, Central Region Integration Hub, published by Te Whatu Ora, Te Pae Hauora o Ruahine o Tararua, MidCentral. This guide is not an authorized publication; it is the continuous build for version 1.0.10-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/centralRegion-integrationHub-ig/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/crih/StructureDefinition/NZCentralRegionClinicalImpression | Version: 1.0.10-rc1 | |||
| Active as of 2024-09-04 | Computable Name: NZCentralRegionClinicalImpression | |||
ClinicalImpression resource for Te Whatu Ora, Central Region - holds mental health legal statuses
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 | |
  meta |
||||
   extension |
1..* | Extension | Extension | |
 Slices for extension |
Content/Rules for all slices | |||
  hl7v2Message |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
  url |
1..1 | uri | identifies the meaning of the extension | |
 value[x] |
0..1 | base64Binary | Value of extension | |
| Slices for extension |
Content/Rules for all slices | |||
 process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| Slices for extension |
Content/Rules for all slices | |||
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| Slices for extension |
Content/Rules for all slices | |||
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| Slices for extension |
Content/Rules for all slices | |||
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| Slices for extension |
Content/Rules for all slices | |||
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| Slices for extension |
Content/Rules for all slices | |||
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
 Slices for extension |
Content/Rules for all slices | |||
| l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| implicitRules |
0..0 | |||
| language |
0..0 | |||
| contained |
0..0 | |||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| mentalHealth |
S | 1..1 | (Complex) | NZ Central Region Mental Health URL: https://standards.digital.health.nz/ns/central-region/mental-health-status |
 Slices for extension |
Content/Rules for all slices | |||
  extension:legalStatus |
0..1 | Extension | Extension | |
 url |
1..1 | uri | identifies the meaning of the extension | |
 value[x] |
1..1 | Coding | Value of extension | |
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
 display |
0..1 | string | Representation defined by the system | |
| extension:reviewStatus |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
1..1 | Coding | Value of extension | |
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| extension:startDateTime |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:endDateTime |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:location |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
1..1 | Coding | Value of extension | |
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| extension:reminderDate |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | date | Value of extension | |
| extension:addedBy |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
1..1 | string | Value of extension | |
| extension:addedDateTime |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
1..1 | dateTime | Value of extension | |
| extension:lastUpdatedBy |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
1..1 | string | Value of extension | |
| extension:lastUpdatedDateTime |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
1..1 | dateTime | Value of extension | |
| extension:supplementaryLegalStatus |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
1..1 | Coding | Value of extension | |
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| extension:supplementaryLegalStatusDate |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | date | Value of extension | |
| extension:reviewDate |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | date | Value of extension | |
| extension:courtNoticeSentDate |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | date | Value of extension | |
| extension:tribunalDate |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | date | Value of extension | |
| extension:courtLodgedDate |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | date | Value of extension | |
| extension:courtType |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
1..1 | Coding | Value of extension | |
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| identifier |
S | 1..1 | Identifier | Business identifier |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
| type |
0..0 | |||
| system |
S | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-clinical-impression-id |
| value |
S | 1..1 | string | The value that is unique |
| period |
0..0 | |||
| assigner |
0..0 | |||
| status |
S | 1..1 | code | in-progress | completed | entered-in-error |
| statusReason |
0..0 | |||
| code |
0..0 | |||
| description |
0..0 | |||
| subject |
S | 1..1 | Reference(Patient | Group) | Patient or group assessed |
| id |
0..0 | |||
| extension |
0..0 | |||
| reference |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
S | 1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient |
| identifier |
S | 1..1 | Identifier | Logical reference, when literal reference is not known |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
| type |
S | 1..1 | CodeableConcept | Description of identifier |
| id |
0..0 | |||
| extension |
0..0 | |||
| coding |
S | 0..* | Coding | Code defined by a terminology system |
| id |
0..0 | |||
| extension |
0..0 | |||
| system |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version |
0..0 | |||
| code |
S | 1..1 | code | Symbol in syntax defined by the system |
| display |
S | 1..1 | string | Representation defined by the system |
| userSelected |
0..0 | |||
| text |
0..0 | |||
| system |
S | 1..1 | uri | The namespace for the identifier value |
| value |
S | 1..1 | string | The value that is unique |
| period |
0..0 | |||
| assigner |
0..0 | |||
| display |
S | 0..1 | string | Text alternative for the resource |
| encounter |
0..0 | |||
 effective[x] |
S | 0..1 | dateTime | Time of assessment |
| date |
S | 0..1 | dateTime | When the assessment was documented |
| assessor |
||||
| id |
0..0 | |||
| extension |
0..0 | |||
| reference |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
S | 1..1 | uri | Type the reference refers to (e.g. 'Practitioner') Required Pattern: Practitioner |
| identifier |
S | 1..1 | Identifier | Logical reference, when literal reference is not known |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
| type |
S | 1..1 | CodeableConcept | Description of identifier |
| id |
0..0 | |||
| extension |
0..0 | |||
| coding |
S | 0..* | Coding | Code defined by a terminology system |
| id |
0..0 | |||
| extension |
0..0 | |||
| system |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version |
0..0 | |||
| code |
S | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
S | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| userSelected |
0..0 | |||
| text |
0..0 | |||
| system |
S | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
0..1 | string | The value that is unique | |
| period |
0..0 | |||
| assigner |
0..0 | |||
| display |
S | 0..1 | string | Text alternative for the resource |
| previous |
0..0 | |||
| problem |
0..0 | |||
| protocol |
0..0 | |||
| summary |
0..0 | |||
| prognosisCodeableConcept |
0..0 | |||
| prognosisReference |
0..0 | |||
| supportingInfo |
0..0 | |||
| note |
S | 0..1 | Annotation | Comments made about the ClinicalImpression |
| author[x] |
0..0 | |||
| time |
0..0 | |||
| text |
S | 1..1 | markdown | The annotation - text content (as markdown) |
| 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 | |
 meta |
Σ | 0..1 | Meta | Metadata about the resource |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| hl7v2Message |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/hl7v2-message" | |
| value[x] |
0..1 | base64Binary | Value of extension | |
 process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
| l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| mentalHealth |
S | 1..1 | (Complex) | NZ Central Region Mental Health URL: https://standards.digital.health.nz/ns/central-region/mental-health-status |
| Slices for extension |
Content/Rules for all slices | |||
| extension:legalStatus |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "legalStatus" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - MentalHealthLegalStatus Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:reviewStatus |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "reviewStatus" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - MentalHealthReviewStatus Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:startDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "startDateTime" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:endDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "endDateTime" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:location |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "location" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - Mental Health Review Location Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:reminderDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "reminderDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:addedBy |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "addedBy" | |
| value[x] |
1..1 | string | Value of extension | |
| extension:addedDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "addedDateTime" | |
| value[x] |
1..1 | dateTime | Value of extension | |
| extension:lastUpdatedBy |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "lastUpdatedBy" | |
| value[x] |
1..1 | string | Value of extension | |
| extension:lastUpdatedDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "lastUpdatedDateTime" | |
| value[x] |
1..1 | dateTime | Value of extension | |
| extension:supplementaryLegalStatus |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "supplementaryLegalStatus" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - MentalHealthLegalStatus Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:supplementaryLegalStatusDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "supplementaryLegalStatusDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:reviewDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "reviewDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:courtNoticeSentDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "courtNoticeSentDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:tribunalDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "tribunalDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:courtLodgedDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "courtLodgedDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:courtType |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "courtType" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - Mental Health Court Type Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/mental-health-status" | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 1..1 | Identifier | Business identifier |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-clinical-impression-id |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| status |
?!SΣ | 1..1 | code | in-progress | completed | entered-in-error Binding: ClinicalImpressionStatus (required): The workflow state of a clinical impression. |
 subject |
SΣ | 1..1 | Reference(Patient | Group) | Patient or group assessed |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| display |
SΣ | 0..1 | string | Text alternative for the resource |
| effective[x] |
SΣ | 0..1 | dateTime | Time of assessment |
| date |
SΣ | 0..1 | dateTime | When the assessment was documented |
| assessor |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The clinician performing the assessment |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Type the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| display |
SΣ | 0..1 | string | Text alternative for the resource |
| note |
S | 0..1 | Annotation | Comments made about the ClinicalImpression |
| text |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ClinicalImpression.extension:mentalHealth.extension:legalStatus.value[x] | required | NZCentralRegionMentalHealthLegalStatusValueSet (a valid code from NZ Central Region - MentalHealthLegalStatus Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-legal-statusfrom this IG | |
| ClinicalImpression.extension:mentalHealth.extension:reviewStatus.value[x] | required | NZCentralRegionMentalHealthReviewStatusValueSet (a valid code from NZ Central Region - MentalHealthReviewStatus Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-review-statusfrom this IG | |
| ClinicalImpression.extension:mentalHealth.extension:location.value[x] | required | NZCentralRegionMentalHealthReviewLocationValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-review-locationfrom this IG | |
| ClinicalImpression.extension:mentalHealth.extension:supplementaryLegalStatus.value[x] | required | NZCentralRegionMentalHealthLegalStatusValueSet (a valid code from NZ Central Region - MentalHealthLegalStatus Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-legal-statusfrom this IG | |
| ClinicalImpression.extension:mentalHealth.extension:courtType.value[x] | required | NZCentralRegionMentalHealthCourtTypeValueSet (a valid code from NZ Central Region - Mental Health Court Type Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-court-typefrom this IG | |
| ClinicalImpression.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ClinicalImpression.status | required | ClinicalImpressionStatushttp://hl7.org/fhir/ValueSet/clinicalimpression-status|4.0.1from the FHIR Standard | |
| ClinicalImpression.subject.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ClinicalImpression.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ClinicalImpression.subject.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ClinicalImpression.assessor.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ClinicalImpression.assessor.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ClinicalImpression.assessor.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ClinicalImpression | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ClinicalImpression | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ClinicalImpression | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ClinicalImpression | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ClinicalImpression | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ClinicalImpression |
0..* | ClinicalImpression | A clinical assessment performed when planning treatments and management strategies for a patient | |
| id |
Σ | 0..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 | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| hl7v2Message |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/hl7v2-message" | |
| value[x] |
0..1 | base64Binary | Value of extension | |
| process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
| l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| 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 |
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag |
Σ | 0..* | 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". |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| mentalHealth |
S | 1..1 | (Complex) | NZ Central Region Mental Health URL: https://standards.digital.health.nz/ns/central-region/mental-health-status |
| Slices for extension |
0..* | Extension | Container holding the individual elements of the Patient's mental health status. Slice: Unordered, Open by value:url | |
| extension:legalStatus |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "legalStatus" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - MentalHealthLegalStatus Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:reviewStatus |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "reviewStatus" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - MentalHealthReviewStatus Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:startDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "startDateTime" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:endDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "endDateTime" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:location |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "location" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - Mental Health Review Location Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:reminderDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "reminderDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:addedBy |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "addedBy" | |
| value[x] |
1..1 | string | Value of extension | |
| extension:addedDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "addedDateTime" | |
| value[x] |
1..1 | dateTime | Value of extension | |
| extension:lastUpdatedBy |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "lastUpdatedBy" | |
| value[x] |
1..1 | string | Value of extension | |
| extension:lastUpdatedDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "lastUpdatedDateTime" | |
| value[x] |
1..1 | dateTime | Value of extension | |
| extension:supplementaryLegalStatus |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "supplementaryLegalStatus" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - MentalHealthLegalStatus Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:supplementaryLegalStatusDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "supplementaryLegalStatusDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:reviewDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "reviewDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:courtNoticeSentDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "courtNoticeSentDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:tribunalDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "tribunalDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:courtLodgedDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "courtLodgedDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:courtType |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "courtType" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - Mental Health Court Type Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/mental-health-status" | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 1..1 | Identifier | Business identifier |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-clinical-impression-id |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| status |
?!SΣ | 1..1 | code | in-progress | completed | entered-in-error Binding: ClinicalImpressionStatus (required): The workflow state of a clinical impression. |
| subject |
SΣ | 1..1 | Reference(Patient | Group) | Patient or group assessed |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| display |
SΣ | 0..1 | string | Text alternative for the resource |
| effective[x] |
SΣ | 0..1 | dateTime | Time of assessment |
| date |
SΣ | 0..1 | dateTime | When the assessment was documented |
| assessor |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The clinician performing the assessment |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Type the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| display |
SΣ | 0..1 | string | Text alternative for the resource |
| 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 | |
| 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 | |
| note |
S | 0..1 | Annotation | Comments made about the ClinicalImpression |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| text |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ClinicalImpression.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| ClinicalImpression.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | |
| ClinicalImpression.extension:mentalHealth.extension:legalStatus.value[x] | required | NZCentralRegionMentalHealthLegalStatusValueSet (a valid code from NZ Central Region - MentalHealthLegalStatus Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-legal-statusfrom this IG | |
| ClinicalImpression.extension:mentalHealth.extension:reviewStatus.value[x] | required | NZCentralRegionMentalHealthReviewStatusValueSet (a valid code from NZ Central Region - MentalHealthReviewStatus Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-review-statusfrom this IG | |
| ClinicalImpression.extension:mentalHealth.extension:location.value[x] | required | NZCentralRegionMentalHealthReviewLocationValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-review-locationfrom this IG | |
| ClinicalImpression.extension:mentalHealth.extension:supplementaryLegalStatus.value[x] | required | NZCentralRegionMentalHealthLegalStatusValueSet (a valid code from NZ Central Region - MentalHealthLegalStatus Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-legal-statusfrom this IG | |
| ClinicalImpression.extension:mentalHealth.extension:courtType.value[x] | required | NZCentralRegionMentalHealthCourtTypeValueSet (a valid code from NZ Central Region - Mental Health Court Type Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-court-typefrom this IG | |
| ClinicalImpression.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ClinicalImpression.status | required | ClinicalImpressionStatushttp://hl7.org/fhir/ValueSet/clinicalimpression-status|4.0.1from the FHIR Standard | |
| ClinicalImpression.subject.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ClinicalImpression.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ClinicalImpression.subject.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ClinicalImpression.assessor.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ClinicalImpression.assessor.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ClinicalImpression.assessor.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ClinicalImpression.investigation.code | example | InvestigationTypehttp://hl7.org/fhir/ValueSet/investigation-setsfrom the FHIR Standard | |
| ClinicalImpression.finding.itemCodeableConcept | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ClinicalImpression | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ClinicalImpression | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ClinicalImpression | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ClinicalImpression | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ClinicalImpression | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from ClinicalImpression
Summary
Mandatory: 12 elements(13 nested mandatory elements)
Must-Support: 42 elements
Prohibited: 47 elements
Extensions
This structure refers to these extensions:
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 | |
| meta |
||||
| extension |
1..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| hl7v2Message |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | base64Binary | Value of extension | |
| Slices for extension |
Content/Rules for all slices | |||
| process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| Slices for extension |
Content/Rules for all slices | |||
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| Slices for extension |
Content/Rules for all slices | |||
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| Slices for extension |
Content/Rules for all slices | |||
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| Slices for extension |
Content/Rules for all slices | |||
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| Slices for extension |
Content/Rules for all slices | |||
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
| Slices for extension |
Content/Rules for all slices | |||
| l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| implicitRules |
0..0 | |||
| language |
0..0 | |||
| contained |
0..0 | |||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| mentalHealth |
S | 1..1 | (Complex) | NZ Central Region Mental Health URL: https://standards.digital.health.nz/ns/central-region/mental-health-status |
| Slices for extension |
Content/Rules for all slices | |||
| extension:legalStatus |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
1..1 | Coding | Value of extension | |
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| extension:reviewStatus |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
1..1 | Coding | Value of extension | |
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| extension:startDateTime |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:endDateTime |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:location |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
1..1 | Coding | Value of extension | |
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| extension:reminderDate |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | date | Value of extension | |
| extension:addedBy |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
1..1 | string | Value of extension | |
| extension:addedDateTime |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
1..1 | dateTime | Value of extension | |
| extension:lastUpdatedBy |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
1..1 | string | Value of extension | |
| extension:lastUpdatedDateTime |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
1..1 | dateTime | Value of extension | |
| extension:supplementaryLegalStatus |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
1..1 | Coding | Value of extension | |
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| extension:supplementaryLegalStatusDate |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | date | Value of extension | |
| extension:reviewDate |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | date | Value of extension | |
| extension:courtNoticeSentDate |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | date | Value of extension | |
| extension:tribunalDate |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | date | Value of extension | |
| extension:courtLodgedDate |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | date | Value of extension | |
| extension:courtType |
0..1 | Extension | Extension | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
1..1 | Coding | Value of extension | |
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| url |
1..1 | uri | identifies the meaning of the extension | |
| identifier |
S | 1..1 | Identifier | Business identifier |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
| type |
0..0 | |||
| system |
S | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-clinical-impression-id |
| value |
S | 1..1 | string | The value that is unique |
| period |
0..0 | |||
| assigner |
0..0 | |||
| status |
S | 1..1 | code | in-progress | completed | entered-in-error |
| statusReason |
0..0 | |||
| code |
0..0 | |||
| description |
0..0 | |||
| subject |
S | 1..1 | Reference(Patient | Group) | Patient or group assessed |
| id |
0..0 | |||
| extension |
0..0 | |||
| reference |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
S | 1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient |
| identifier |
S | 1..1 | Identifier | Logical reference, when literal reference is not known |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
| type |
S | 1..1 | CodeableConcept | Description of identifier |
| id |
0..0 | |||
| extension |
0..0 | |||
| coding |
S | 0..* | Coding | Code defined by a terminology system |
| id |
0..0 | |||
| extension |
0..0 | |||
| system |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version |
0..0 | |||
| code |
S | 1..1 | code | Symbol in syntax defined by the system |
| display |
S | 1..1 | string | Representation defined by the system |
| userSelected |
0..0 | |||
| text |
0..0 | |||
| system |
S | 1..1 | uri | The namespace for the identifier value |
| value |
S | 1..1 | string | The value that is unique |
| period |
0..0 | |||
| assigner |
0..0 | |||
| display |
S | 0..1 | string | Text alternative for the resource |
| encounter |
0..0 | |||
| effective[x] |
S | 0..1 | dateTime | Time of assessment |
| date |
S | 0..1 | dateTime | When the assessment was documented |
| assessor |
||||
| id |
0..0 | |||
| extension |
0..0 | |||
| reference |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
S | 1..1 | uri | Type the reference refers to (e.g. 'Practitioner') Required Pattern: Practitioner |
| identifier |
S | 1..1 | Identifier | Logical reference, when literal reference is not known |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
| type |
S | 1..1 | CodeableConcept | Description of identifier |
| id |
0..0 | |||
| extension |
0..0 | |||
| coding |
S | 0..* | Coding | Code defined by a terminology system |
| id |
0..0 | |||
| extension |
0..0 | |||
| system |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version |
0..0 | |||
| code |
S | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
S | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| userSelected |
0..0 | |||
| text |
0..0 | |||
| system |
S | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
0..1 | string | The value that is unique | |
| period |
0..0 | |||
| assigner |
0..0 | |||
| display |
S | 0..1 | string | Text alternative for the resource |
| previous |
0..0 | |||
| problem |
0..0 | |||
| protocol |
0..0 | |||
| summary |
0..0 | |||
| prognosisCodeableConcept |
0..0 | |||
| prognosisReference |
0..0 | |||
| supportingInfo |
0..0 | |||
| note |
S | 0..1 | Annotation | Comments made about the ClinicalImpression |
| author[x] |
0..0 | |||
| time |
0..0 | |||
| text |
S | 1..1 | markdown | The annotation - text content (as markdown) |
| 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 | |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| hl7v2Message |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/hl7v2-message" | |
| value[x] |
0..1 | base64Binary | Value of extension | |
| process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
| l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| mentalHealth |
S | 1..1 | (Complex) | NZ Central Region Mental Health URL: https://standards.digital.health.nz/ns/central-region/mental-health-status |
| Slices for extension |
Content/Rules for all slices | |||
| extension:legalStatus |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "legalStatus" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - MentalHealthLegalStatus Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:reviewStatus |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "reviewStatus" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - MentalHealthReviewStatus Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:startDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "startDateTime" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:endDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "endDateTime" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:location |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "location" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - Mental Health Review Location Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:reminderDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "reminderDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:addedBy |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "addedBy" | |
| value[x] |
1..1 | string | Value of extension | |
| extension:addedDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "addedDateTime" | |
| value[x] |
1..1 | dateTime | Value of extension | |
| extension:lastUpdatedBy |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "lastUpdatedBy" | |
| value[x] |
1..1 | string | Value of extension | |
| extension:lastUpdatedDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "lastUpdatedDateTime" | |
| value[x] |
1..1 | dateTime | Value of extension | |
| extension:supplementaryLegalStatus |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "supplementaryLegalStatus" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - MentalHealthLegalStatus Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:supplementaryLegalStatusDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "supplementaryLegalStatusDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:reviewDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "reviewDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:courtNoticeSentDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "courtNoticeSentDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:tribunalDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "tribunalDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:courtLodgedDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "courtLodgedDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:courtType |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "courtType" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - Mental Health Court Type Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/mental-health-status" | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 1..1 | Identifier | Business identifier |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-clinical-impression-id |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| status |
?!SΣ | 1..1 | code | in-progress | completed | entered-in-error Binding: ClinicalImpressionStatus (required): The workflow state of a clinical impression. |
| subject |
SΣ | 1..1 | Reference(Patient | Group) | Patient or group assessed |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| display |
SΣ | 0..1 | string | Text alternative for the resource |
| effective[x] |
SΣ | 0..1 | dateTime | Time of assessment |
| date |
SΣ | 0..1 | dateTime | When the assessment was documented |
| assessor |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The clinician performing the assessment |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Type the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| display |
SΣ | 0..1 | string | Text alternative for the resource |
| note |
S | 0..1 | Annotation | Comments made about the ClinicalImpression |
| text |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ClinicalImpression.extension:mentalHealth.extension:legalStatus.value[x] | required | NZCentralRegionMentalHealthLegalStatusValueSet (a valid code from NZ Central Region - MentalHealthLegalStatus Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-legal-statusfrom this IG | |
| ClinicalImpression.extension:mentalHealth.extension:reviewStatus.value[x] | required | NZCentralRegionMentalHealthReviewStatusValueSet (a valid code from NZ Central Region - MentalHealthReviewStatus Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-review-statusfrom this IG | |
| ClinicalImpression.extension:mentalHealth.extension:location.value[x] | required | NZCentralRegionMentalHealthReviewLocationValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-review-locationfrom this IG | |
| ClinicalImpression.extension:mentalHealth.extension:supplementaryLegalStatus.value[x] | required | NZCentralRegionMentalHealthLegalStatusValueSet (a valid code from NZ Central Region - MentalHealthLegalStatus Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-legal-statusfrom this IG | |
| ClinicalImpression.extension:mentalHealth.extension:courtType.value[x] | required | NZCentralRegionMentalHealthCourtTypeValueSet (a valid code from NZ Central Region - Mental Health Court Type Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-court-typefrom this IG | |
| ClinicalImpression.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ClinicalImpression.status | required | ClinicalImpressionStatushttp://hl7.org/fhir/ValueSet/clinicalimpression-status|4.0.1from the FHIR Standard | |
| ClinicalImpression.subject.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ClinicalImpression.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ClinicalImpression.subject.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ClinicalImpression.assessor.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ClinicalImpression.assessor.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ClinicalImpression.assessor.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ClinicalImpression | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ClinicalImpression | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ClinicalImpression | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ClinicalImpression | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ClinicalImpression | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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 |
Σ | 0..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 | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| hl7v2Message |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/hl7v2-message" | |
| value[x] |
0..1 | base64Binary | Value of extension | |
| process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
| l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| 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 |
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag |
Σ | 0..* | 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". |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| mentalHealth |
S | 1..1 | (Complex) | NZ Central Region Mental Health URL: https://standards.digital.health.nz/ns/central-region/mental-health-status |
| Slices for extension |
0..* | Extension | Container holding the individual elements of the Patient's mental health status. Slice: Unordered, Open by value:url | |
| extension:legalStatus |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "legalStatus" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - MentalHealthLegalStatus Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:reviewStatus |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "reviewStatus" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - MentalHealthReviewStatus Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:startDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "startDateTime" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:endDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "endDateTime" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:location |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "location" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - Mental Health Review Location Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:reminderDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "reminderDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:addedBy |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "addedBy" | |
| value[x] |
1..1 | string | Value of extension | |
| extension:addedDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "addedDateTime" | |
| value[x] |
1..1 | dateTime | Value of extension | |
| extension:lastUpdatedBy |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "lastUpdatedBy" | |
| value[x] |
1..1 | string | Value of extension | |
| extension:lastUpdatedDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "lastUpdatedDateTime" | |
| value[x] |
1..1 | dateTime | Value of extension | |
| extension:supplementaryLegalStatus |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "supplementaryLegalStatus" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - MentalHealthLegalStatus Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:supplementaryLegalStatusDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "supplementaryLegalStatusDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:reviewDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "reviewDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:courtNoticeSentDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "courtNoticeSentDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:tribunalDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "tribunalDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:courtLodgedDate |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "courtLodgedDate" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:courtType |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "courtType" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - Mental Health Court Type Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/mental-health-status" | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 1..1 | Identifier | Business identifier |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-clinical-impression-id |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| status |
?!SΣ | 1..1 | code | in-progress | completed | entered-in-error Binding: ClinicalImpressionStatus (required): The workflow state of a clinical impression. |
| subject |
SΣ | 1..1 | Reference(Patient | Group) | Patient or group assessed |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Patient |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| display |
SΣ | 0..1 | string | Text alternative for the resource |
| effective[x] |
SΣ | 0..1 | dateTime | Time of assessment |
| date |
SΣ | 0..1 | dateTime | When the assessment was documented |
| assessor |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The clinician performing the assessment |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Type the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| display |
SΣ | 0..1 | string | Text alternative for the resource |
| 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 | |
| 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 | |
| note |
S | 0..1 | Annotation | Comments made about the ClinicalImpression |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| text |
SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ClinicalImpression.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| ClinicalImpression.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | |
| ClinicalImpression.extension:mentalHealth.extension:legalStatus.value[x] | required | NZCentralRegionMentalHealthLegalStatusValueSet (a valid code from NZ Central Region - MentalHealthLegalStatus Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-legal-statusfrom this IG | |
| ClinicalImpression.extension:mentalHealth.extension:reviewStatus.value[x] | required | NZCentralRegionMentalHealthReviewStatusValueSet (a valid code from NZ Central Region - MentalHealthReviewStatus Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-review-statusfrom this IG | |
| ClinicalImpression.extension:mentalHealth.extension:location.value[x] | required | NZCentralRegionMentalHealthReviewLocationValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-review-locationfrom this IG | |
| ClinicalImpression.extension:mentalHealth.extension:supplementaryLegalStatus.value[x] | required | NZCentralRegionMentalHealthLegalStatusValueSet (a valid code from NZ Central Region - MentalHealthLegalStatus Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-legal-statusfrom this IG | |
| ClinicalImpression.extension:mentalHealth.extension:courtType.value[x] | required | NZCentralRegionMentalHealthCourtTypeValueSet (a valid code from NZ Central Region - Mental Health Court Type Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-mental-health-court-typefrom this IG | |
| ClinicalImpression.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ClinicalImpression.status | required | ClinicalImpressionStatushttp://hl7.org/fhir/ValueSet/clinicalimpression-status|4.0.1from the FHIR Standard | |
| ClinicalImpression.subject.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ClinicalImpression.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ClinicalImpression.subject.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ClinicalImpression.assessor.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ClinicalImpression.assessor.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ClinicalImpression.assessor.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ClinicalImpression.investigation.code | example | InvestigationTypehttp://hl7.org/fhir/ValueSet/investigation-setsfrom the FHIR Standard | |
| ClinicalImpression.finding.itemCodeableConcept | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ClinicalImpression | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ClinicalImpression | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ClinicalImpression | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ClinicalImpression | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ClinicalImpression | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from ClinicalImpression
Summary
Mandatory: 12 elements(13 nested mandatory elements)
Must-Support: 42 elements
Prohibited: 47 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron