Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
Resource Profile: CareConnectFlag1
| Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Flag-1 | Version: 0.1.0 | |||
| Draft as of 2019-06-14 | Computable Name: CareConnect-Flag-1 | |||
Copyright/Legal: Copyright © 2019 HL7 UK Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html |
||||
Prospective warnings of potential issues when providing care to the patient.
CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/
Usage:
- Derived from this Resource Profile: InterweaveFlag
- Examples for this Resource Profile: Flag/InterweaveFlagExample-Full and Flag/InterweaveFlagExample-MustSupport
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Flag
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Flag | 0..* | Flag | Key information to flag to healthcare providers | |
  identifier | ||||
  system | 1..1 | uri | The namespace for the identifier value | |
| value | 1..1 | string | The value that is unique | |
  assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
| code | ||||
  Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
   coding:snomedCT | 0..1 | Coding | SNOMED CT representation identifying specific flagged issues | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| version | 0..0 | |||
| code | 1..1 | code | Symbol in syntax defined by the system | |
 display | 1..1 | string | Representation defined by the system | |
| subject | 1..1 | Reference(Group | PlanDefinition | CareConnect-Procedure-1 | CareConnectPatient1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-Location-1 | CareConnect-Medication-1) | Who/What is flag about? | |
| encounter | 0..1 | Reference(CareConnect-Encounter-1) | Alert relevant during encounter | |
| author | 0..1 | Reference(Device | CareConnectPatient1 | CareConnect-Organization-1 | CareConnect-Practitioner-1) | Flag creator | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Flag | 0..* | Flag | Key information to flag to healthcare providers | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | active | inactive | entered-in-error Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or entered in error. |
 code | Σ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: Flag Code (example): Detail codes identifying specific flagged issues. |
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedCT | Σ | 0..1 | Coding | SNOMED CT representation identifying specific flagged issues |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| subject | Σ | 1..1 | Reference(Group | PlanDefinition | CareConnect-Procedure-1 | CareConnectPatient1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-Location-1 | CareConnect-Medication-1) | Who/What is flag about? |
| encounter | Σ | 0..1 | Reference(CareConnect-Encounter-1) | Alert relevant during encounter |
| author | Σ | 0..1 | Reference(Device | CareConnectPatient1 | CareConnect-Organization-1 | CareConnect-Practitioner-1) | Flag creator |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Flag.status | required | FlagStatus |
| Flag.code | example | Flag Code |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-1 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-2 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Flag | 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() | |
| dom-4 | error | Flag | 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Flag | 0..* | Flag | Key information to flag to healthcare providers | |||||
| 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): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business identifier | ||||
| 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): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..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. | ||||
| 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 | active | inactive | entered-in-error Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or entered in error. | ||||
| category | Σ | 0..1 | CodeableConcept | Clinical, administrative, etc. Binding: Flag Category (example): A general category for flags for filtering/display purposes. | ||||
| code | Σ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: Flag Code (example): Detail codes identifying specific flagged issues. | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
| coding:snomedCT | Σ | 0..1 | Coding | SNOMED CT representation identifying specific flagged issues | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 1..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| subject | Σ | 1..1 | Reference(Group | PlanDefinition | CareConnect-Procedure-1 | CareConnectPatient1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-Location-1 | CareConnect-Medication-1) | Who/What is flag about? | ||||
| period | Σ | 0..1 | Period | Time period when flag is active | ||||
| encounter | Σ | 0..1 | Reference(CareConnect-Encounter-1) | Alert relevant during encounter | ||||
| author | Σ | 0..1 | Reference(Device | CareConnectPatient1 | CareConnect-Organization-1 | CareConnect-Practitioner-1) | Flag creator | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Flag.language | extensible | Common Languages
| ||||
| Flag.identifier.use | required | IdentifierUse | ||||
| Flag.identifier.type | extensible | Identifier Type Codes | ||||
| Flag.status | required | FlagStatus | ||||
| Flag.category | example | Flag Category | ||||
| Flag.code | example | Flag Code |
This structure is derived from Flag
Summary
Mandatory: 0 element (5 nested mandatory elements)
Fixed Value: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
- CareConnect-Organization-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1)
- CareConnect-Procedure-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Procedure-1)
- CareConnectPatient1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1)
- CareConnect-Practitioner-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1)
- CareConnect-Location-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1)
- CareConnect-Medication-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Medication-1)
- CareConnect-Encounter-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1)
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
- The element Flag.code.coding is sliced based on the value of value:system
Differential View
This structure is derived from Flag
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Flag | 0..* | Flag | Key information to flag to healthcare providers | |
| identifier | ||||
| system | 1..1 | uri | The namespace for the identifier value | |
| value | 1..1 | string | The value that is unique | |
| assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
| code | ||||
| Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:snomedCT | 0..1 | Coding | SNOMED CT representation identifying specific flagged issues | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| version | 0..0 | |||
| code | 1..1 | code | Symbol in syntax defined by the system | |
| display | 1..1 | string | Representation defined by the system | |
| subject | 1..1 | Reference(Group | PlanDefinition | CareConnect-Procedure-1 | CareConnectPatient1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-Location-1 | CareConnect-Medication-1) | Who/What is flag about? | |
| encounter | 0..1 | Reference(CareConnect-Encounter-1) | Alert relevant during encounter | |
| author | 0..1 | Reference(Device | CareConnectPatient1 | CareConnect-Organization-1 | CareConnect-Practitioner-1) | Flag creator | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Flag | 0..* | Flag | Key information to flag to healthcare providers | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | active | inactive | entered-in-error Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or entered in error. |
| code | Σ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: Flag Code (example): Detail codes identifying specific flagged issues. |
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedCT | Σ | 0..1 | Coding | SNOMED CT representation identifying specific flagged issues |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| subject | Σ | 1..1 | Reference(Group | PlanDefinition | CareConnect-Procedure-1 | CareConnectPatient1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-Location-1 | CareConnect-Medication-1) | Who/What is flag about? |
| encounter | Σ | 0..1 | Reference(CareConnect-Encounter-1) | Alert relevant during encounter |
| author | Σ | 0..1 | Reference(Device | CareConnectPatient1 | CareConnect-Organization-1 | CareConnect-Practitioner-1) | Flag creator |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Flag.status | required | FlagStatus |
| Flag.code | example | Flag Code |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-1 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-2 | error | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Flag | 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() | |
| dom-4 | error | Flag | 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Flag | 0..* | Flag | Key information to flag to healthcare providers | |||||
| 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): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business identifier | ||||
| 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): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..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. | ||||
| 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 | active | inactive | entered-in-error Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or entered in error. | ||||
| category | Σ | 0..1 | CodeableConcept | Clinical, administrative, etc. Binding: Flag Category (example): A general category for flags for filtering/display purposes. | ||||
| code | Σ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: Flag Code (example): Detail codes identifying specific flagged issues. | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
| coding:snomedCT | Σ | 0..1 | Coding | SNOMED CT representation identifying specific flagged issues | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| snomedCTDescriptionID | 0..* | (Complex) | The SNOMED CT Description ID for the display URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 1..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| subject | Σ | 1..1 | Reference(Group | PlanDefinition | CareConnect-Procedure-1 | CareConnectPatient1 | CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-Location-1 | CareConnect-Medication-1) | Who/What is flag about? | ||||
| period | Σ | 0..1 | Period | Time period when flag is active | ||||
| encounter | Σ | 0..1 | Reference(CareConnect-Encounter-1) | Alert relevant during encounter | ||||
| author | Σ | 0..1 | Reference(Device | CareConnectPatient1 | CareConnect-Organization-1 | CareConnect-Practitioner-1) | Flag creator | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Flag.language | extensible | Common Languages
| ||||
| Flag.identifier.use | required | IdentifierUse | ||||
| Flag.identifier.type | extensible | Identifier Type Codes | ||||
| Flag.status | required | FlagStatus | ||||
| Flag.category | example | Flag Category | ||||
| Flag.code | example | Flag Code |
This structure is derived from Flag
Summary
Mandatory: 0 element (5 nested mandatory elements)
Fixed Value: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
- CareConnect-Organization-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1)
- CareConnect-Procedure-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Procedure-1)
- CareConnectPatient1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1)
- CareConnect-Practitioner-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1)
- CareConnect-Location-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1)
- CareConnect-Medication-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Medication-1)
- CareConnect-Encounter-1 (https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1)
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
- The element Flag.code.coding is sliced based on the value of value:system
Other representations of profile: CSV, Excel, Schematron