INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
StructureDefinition: CareConnect-Medication-Flag-1
This Flag Resource carries prospective warnings of potential issues related to the patient’s medications.
The official URL for this profile is:
https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Medication-Flag-1
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Flag
Summary
Mandatory: 9 elements (2 nested mandatory elements)
Fixed Value: 3 elements
Prohibited: 4 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 Flag
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Flag | I | 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) 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-MedicationFlagAssociation-1 | I | 1..* | Reference() | Associated medication URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MedicationFlagAssociation-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 | active | inactive | entered-in-error Binding: FlagStatus (required) |
| category | Σ | 1..1 | CodeableConcept | Clinical, administrative, etc. Binding: Flag Category (required) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/flag-category |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: drug |
| display | Σ | 1..1 | string | Representation defined by the system Fixed Value: Drug |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| code | Σ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: Care Connect Medication Flag (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 1..* | Coding | Code defined by a terminology system |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| subject | Σ | 1..1 | Reference(Group | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Location-1 | CareConnect-Practitioner-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 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1) | Flag creator |
| Documentation for this format | ||||
This structure is derived from Flag
Summary
Mandatory: 9 elements (2 nested mandatory elements)
Fixed Value: 3 elements
Prohibited: 4 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 Flag
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Flag | I | 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) 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-MedicationFlagAssociation-1 | I | 1..* | Reference() | Associated medication URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MedicationFlagAssociation-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 | active | inactive | entered-in-error Binding: FlagStatus (required) |
| category | Σ | 1..1 | CodeableConcept | Clinical, administrative, etc. Binding: Flag Category (required) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/flag-category |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: drug |
| display | Σ | 1..1 | string | Representation defined by the system Fixed Value: Drug |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| code | Σ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: Care Connect Medication Flag (extensible) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 1..* | Coding | Code defined by a terminology system |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | Identity of the terminology system |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| subject | Σ | 1..1 | Reference(Group | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Location-1 | CareConnect-Practitioner-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 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1) | Flag creator |
| Documentation for this format | ||||
Other representations of profile: Schematron
Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| Flag.language | extensible | Common Languages Max Binding: All Languages |
| Flag.identifier.use | required | IdentifierUse |
| Flag.identifier.type | extensible | Identifier Type Codes |
| Flag.status | required | FlagStatus |
| Flag.category | required | Flag Category |
| Flag.code | extensible | Care Connect Medication Flag |
Constraints
Constraints
| Id | Path | Details | Requirements |
| dom-2 | Flag | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Flag | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | 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() | |
| dom-3 | 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() | |
| ele-1 | Flag.extension:medication | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Flag.extension:medication | Must have either extensions or value[x], not both : extension.exists() != value.exists() |