INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
StructureDefinition: CareConnect-List-1
The List resource is a flat, possibly ordered collection of records. List resources are used in many places, including allergies, medications, alerts, family history, medical history, etc. List resources can be used to support patient-specific clinical lists as well as lists that manage workflows such as tracking patients, managing teaching cases, etc.
The official URL for this profile is:
https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-List-1
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from List
Summary
Mandatory: 0 element (2 nested mandatory elements)
Structures
This structure refers to these other structures:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1
Extensions
This structure refers to these extensions:
This structure is derived from List
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  List | I | 0..* | List | Information summarized from a list of other resources |
  id | Σ | 0..1 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 Extension-CareConnect-ClinicalSetting-1 | I | 0..1 | CodeableConcept | To record the clinical setting of a problem list URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ClinicalSetting-1 |
| Extension-CareConnect-ListWarningCode-1 | I | 0..* | code | To capture warnings that the list may be incomplete URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ListWarningCode-1 |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | 0..* | Identifier | Business identifier | |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
  assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
| status | ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required) |
| mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required) |
| title | Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients |
| code | Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: Care Connect List Code (preferred) |
| subject | Σ | 0..1 | Reference(Group | Device | CareConnect-Patient-1 | CareConnect-Location-1) | If all resources have the same subject |
| encounter | 0..1 | Reference(CareConnect-Encounter-1) | Context in which list created | |
| date | Σ | 0..1 | dateTime | When the list was prepared |
| source | Σ | 0..1 | Reference(Device | CareConnect-Patient-1 | CareConnect-Practitioner-1) | Who and/or what defined the list contents (aka Author) |
| orderedBy | 0..1 | CodeableConcept | What order the list has Binding: List Order Codes (preferred) | |
| note | 0..* | Annotation | Comments about the list | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
 author[x] | Σ | 0..1 | Individual responsible for the annotation | |
| authorReference | Reference(RelatedPerson | CareConnect-Patient-1 | CareConnect-Practitioner-1) | |||
| authorString | string | |||
| time | Σ | 0..1 | dateTime | When the annotation was made |
| text | 1..1 | string | The annotation - text content | |
| entry | I | 0..* | BackboneElement | Entries in the list |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| flag | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: Patient Medicine Change Types (example) | |
| deleted | ?!I | 0..1 | boolean | If this item is actually marked as deleted |
| date | 0..1 | dateTime | When item added to list | |
| item | 1..1 | Reference(Resource) | Actual entry | |
| emptyReason | I | 0..1 | CodeableConcept | Why list is empty Binding: Care Connect List Empty Reason Code (preferred) |
| Documentation for this format | ||||
This structure is derived from List
Summary
Mandatory: 0 element (2 nested mandatory elements)
Structures
This structure refers to these other structures:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from List
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List | I | 0..* | List | Information summarized from a list of other resources |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-CareConnect-ClinicalSetting-1 | I | 0..1 | CodeableConcept | To record the clinical setting of a problem list URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ClinicalSetting-1 |
| Extension-CareConnect-ListWarningCode-1 | I | 0..* | code | To capture warnings that the list may be incomplete URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ListWarningCode-1 |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | Identifier | Business identifier | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
| status | ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required) |
| mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required) |
| title | Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients |
| code | Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: Care Connect List Code (preferred) |
| subject | Σ | 0..1 | Reference(Group | Device | CareConnect-Patient-1 | CareConnect-Location-1) | If all resources have the same subject |
| encounter | 0..1 | Reference(CareConnect-Encounter-1) | Context in which list created | |
| date | Σ | 0..1 | dateTime | When the list was prepared |
| source | Σ | 0..1 | Reference(Device | CareConnect-Patient-1 | CareConnect-Practitioner-1) | Who and/or what defined the list contents (aka Author) |
| orderedBy | 0..1 | CodeableConcept | What order the list has Binding: List Order Codes (preferred) | |
| note | 0..* | Annotation | Comments about the list | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| author[x] | Σ | 0..1 | Individual responsible for the annotation | |
| authorReference | Reference(RelatedPerson | CareConnect-Patient-1 | CareConnect-Practitioner-1) | |||
| authorString | string | |||
| time | Σ | 0..1 | dateTime | When the annotation was made |
| text | 1..1 | string | The annotation - text content | |
| entry | I | 0..* | BackboneElement | Entries in the list |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| flag | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: Patient Medicine Change Types (example) | |
| deleted | ?!I | 0..1 | boolean | If this item is actually marked as deleted |
| date | 0..1 | dateTime | When item added to list | |
| item | 1..1 | Reference(Resource) | Actual entry | |
| emptyReason | I | 0..1 | CodeableConcept | Why list is empty Binding: Care Connect List Empty Reason Code (preferred) |
| Documentation for this format | ||||
Other representations of profile: Schematron
Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| List.language | extensible | Common Languages Max Binding: All Languages |
| List.identifier.use | required | IdentifierUse |
| List.identifier.type | extensible | Identifier Type Codes |
| List.status | required | ListStatus |
| List.mode | required | ListMode |
| List.code | preferred | Care Connect List Code |
| List.orderedBy | preferred | List Order Codes |
| List.entry.flag | example | Patient Medicine Change Types |
| List.emptyReason | preferred | Care Connect List Empty Reason Code |
Constraints
Constraints
| Id | Path | Details | Requirements |
| dom-2 | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | List | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | List | 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-3 | List | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| lst-2 | List | The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty() | |
| lst-1 | List | A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| ele-1 | List.extension:clinicalSetting | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | List.extension:clinicalSetting | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | List.extension:warningCode | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | List.extension:warningCode | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | List.entry | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |