Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: InterweaveFlag

Official URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Interweave-Flag Version: 0.1.0
Active as of 2024-03-08 Computable Name: InterweaveFlag

Interweave Flag resource profile

  Status: Active: Approved (STU)

Definition: Active information or a warning, about a patient or their situation, which may affect how their care or support is delivered.

Introduction

NB: Whilst the term “Patient” is used by FHIR, the profile is equally relevant to a “citizen”, “service user” or “client” in other contexts such as Social Care.

This profile sets minimum expectations for the Flag resource.

Coverage and references

  • Data Providers MUST offer Social Care Flag FHIR resources to represent flags against its own patients.
  • Only active flags should be made available for consumption.
  • When referencing a Flag then the “reference” (URL of FHIR Resource) and “display” (The Flag type.display) MUST be populated.

Mandatory fields

The following fields are mandatory:

  • status only flags which are currently active against a person should be shared. Therefore the value in this field will always be ‘active’.

  • category this provides a level of categorisation, i.e. Risk to others, Risk to self, safeguarding concern and other. This should always be known and is vital for meaningful display purposes. Here We have defined a custom code list for the most common categories of flags used by Social Care. We fully expect that this list will need to be extended for use by healthcare providers. If you need further categories considering, please get in touch.

  • code code is used to record the type of flag assigned to a patient. Here we specify a preferred list which was developed for Social Care. Again we expect that this list will need to expand to cater for healthcare providers. Please get in touch should you required further ‘flag types’ adding.

code.text SHOULD be populated with the local name of the flag, this is not a repeat of the code.display, and this field MUST be populated to further describe the flag when ‘Other’ is selected as the type.

  • subject.patient The patient to which the flag is assigned.

Must Support fields

In addition, the following fields are “Must Support” - i.e. they must be populated if relevant and known:

  • period.start period.start should be populated with the date that the flag was placed against the patient.

Optional fields

Other fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them. Optional fields to note include:

  • identifier:localIdentfier - As with most other resources, there is the option to include a local identifier which may help to identify the flag record at a local level.

  • author option to provide a link to the practitioner or organisation which placed the flag against the patient.

Discouraged or Removed fields

  • encounter - removed

  • code(SNOMEDCT) - This slice created by Care Connect has been removed to avoid confusion with the list of flag types generated by the Social Care Data Standards working group.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CareConnect-Flag-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*CareConnect-Flag-1Key information to flag to healthcare providers
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... Slices for identifier 0..*IdentifierBusiness identifier
Slice: Unordered, Open by value:system
.... identifier:localIdentifier 0..1IdentifierBusiness identifier
..... system S1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-flag-identifier
..... value S1..1stringThe Local flag Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
..... period 0..0
... status S1..1codeOnly use 'active' - only active flags should be shared.
Fixed Value: active
... category S1..1CodeableConceptClinical, administrative, etc.
Binding: Interweave Flag Category (required)
.... coding
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
... code S1..1CodeableConceptCoded or textual message to display to user
Binding: Interweave Flag Type (preferred)
.... coding 0..*CodingCode defined by a terminology system
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
... subject S1..1Reference(CareConnectPatient1)The patient to which the flag is assigned.
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 1..1stringDescription of the referenced resource
... period
.... start S0..1dateTimeThe date that the flag was placed against the patient
... encounter 0..0
... author 0..1Reference(Device | CareConnectPatient1 | CareConnect-Organization-1 | CareConnect-Practitioner-1)The practitioner, organizational team or organization which placed the flag against the patient.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Flag.categoryrequiredInterweave Flag Category (a valid code from InterweaveSocialCareFlagCategory)
Flag.codepreferredInterweave Flag Type
NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*CareConnect-Flag-1Key information to flag to healthcare providers
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierBusiness identifier
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringThe value that is unique
Example General: 123456
.... identifier:localIdentifier Σ0..1IdentifierBusiness identifier
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-flag-identifier
..... value SΣ1..1stringThe Local flag Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
... status ?!SΣ1..1codeOnly use 'active' - only active flags should be shared.
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.


Fixed Value: active
... category SΣ1..1CodeableConceptClinical, administrative, etc.
Binding: Interweave Flag Category (required)
... code SΣ1..1CodeableConceptCoded or textual message to display to user
Binding: Interweave Flag Type (preferred)
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:All Slices Content/Rules for all slices
...... system Σ1..1uriIdentity of the terminology system
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
..... coding:snomedCT Σ0..1CodingSNOMED CT representation identifying specific flagged issues
...... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
... subject SΣ1..1Reference(CareConnectPatient1)The patient to which the flag is assigned.
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... period Σ0..1PeriodTime period when flag is active
.... start SΣC0..1dateTimeThe date that the flag was placed against the patient
... author Σ0..1Reference(Device | CareConnectPatient1 | CareConnect-Organization-1 | CareConnect-Practitioner-1)The practitioner, organizational team or organization which placed the flag against the patient.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Flag.meta.securityextensibleAll Security Labels
Flag.meta.tagexampleCommon Tags
Flag.meta.tag:SourceexampleCommon Tags
Flag.meta.tag:ProvenanceexampleCommon Tags
Flag.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Flag.identifier.userequiredIdentifierUse
Flag.identifier:localIdentifier.userequiredIdentifierUse
Flag.statusrequiredFixed Value: active
Flag.categoryrequiredInterweave Flag Category (a valid code from InterweaveSocialCareFlagCategory)
Flag.codepreferredInterweave Flag Type

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorFlagIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorFlagIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFlagIf 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-4errorFlagIf 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*CareConnect-Flag-1Key information to flag to healthcare providers
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierBusiness identifier
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:localIdentifier Σ0..1IdentifierBusiness identifier
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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 SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-flag-identifier
..... value SΣ1..1stringThe Local flag Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... status ?!SΣ1..1codeOnly use 'active' - only active flags should be shared.
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.


Fixed Value: active
... category SΣ1..1CodeableConceptClinical, administrative, etc.
Binding: Interweave Flag Category (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptCoded or textual message to display to user
Binding: Interweave Flag Type (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:All Slices Content/Rules for all slices
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:snomedCT Σ0..1CodingSNOMED CT representation identifying specific flagged issues
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
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..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(CareConnectPatient1)The patient to which the flag is assigned.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... period Σ0..1PeriodTime period when flag is active
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC0..1dateTimeThe date that the flag was placed against the patient
.... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... author Σ0..1Reference(Device | CareConnectPatient1 | CareConnect-Organization-1 | CareConnect-Practitioner-1)The practitioner, organizational team or organization which placed the flag against the patient.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Flag.meta.securityextensibleAll Security Labels
Flag.meta.tagexampleCommon Tags
Flag.meta.tag:SourceexampleCommon Tags
Flag.meta.tag:ProvenanceexampleCommon Tags
Flag.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Flag.identifier.userequiredIdentifierUse
Flag.identifier.typeextensibleIdentifier Type Codes
Flag.identifier:localIdentifier.userequiredIdentifierUse
Flag.identifier:localIdentifier.typeextensibleIdentifier Type Codes
Flag.statusrequiredFixed Value: active
Flag.categoryrequiredInterweave Flag Category (a valid code from InterweaveSocialCareFlagCategory)
Flag.codepreferredInterweave Flag Type

This structure is derived from CareConnect-Flag-1

Summary

Mandatory: 3 elements (12 nested mandatory elements)
Must-Support: 17 elements
Fixed Value: 4 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Flag.meta.tag is sliced based on the value of value:system
  • The element Flag.identifier is sliced based on the value of value:system

Differential View

This structure is derived from CareConnect-Flag-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*CareConnect-Flag-1Key information to flag to healthcare providers
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... Slices for identifier 0..*IdentifierBusiness identifier
Slice: Unordered, Open by value:system
.... identifier:localIdentifier 0..1IdentifierBusiness identifier
..... system S1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-flag-identifier
..... value S1..1stringThe Local flag Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
..... period 0..0
... status S1..1codeOnly use 'active' - only active flags should be shared.
Fixed Value: active
... category S1..1CodeableConceptClinical, administrative, etc.
Binding: Interweave Flag Category (required)
.... coding
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
... code S1..1CodeableConceptCoded or textual message to display to user
Binding: Interweave Flag Type (preferred)
.... coding 0..*CodingCode defined by a terminology system
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
... subject S1..1Reference(CareConnectPatient1)The patient to which the flag is assigned.
.... reference 1..1stringReference to a resource (could be Contained)
.... identifier 0..1IdentifierIf relevant could include an id
.... display 1..1stringDescription of the referenced resource
... period
.... start S0..1dateTimeThe date that the flag was placed against the patient
... encounter 0..0
... author 0..1Reference(Device | CareConnectPatient1 | CareConnect-Organization-1 | CareConnect-Practitioner-1)The practitioner, organizational team or organization which placed the flag against the patient.

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Flag.categoryrequiredInterweave Flag Category (a valid code from InterweaveSocialCareFlagCategory)
Flag.codepreferredInterweave Flag Type

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*CareConnect-Flag-1Key information to flag to healthcare providers
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierBusiness identifier
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringThe value that is unique
Example General: 123456
.... identifier:localIdentifier Σ0..1IdentifierBusiness identifier
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-flag-identifier
..... value SΣ1..1stringThe Local flag Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
... status ?!SΣ1..1codeOnly use 'active' - only active flags should be shared.
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.


Fixed Value: active
... category SΣ1..1CodeableConceptClinical, administrative, etc.
Binding: Interweave Flag Category (required)
... code SΣ1..1CodeableConceptCoded or textual message to display to user
Binding: Interweave Flag Type (preferred)
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:All Slices Content/Rules for all slices
...... system Σ1..1uriIdentity of the terminology system
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
..... coding:snomedCT Σ0..1CodingSNOMED CT representation identifying specific flagged issues
...... snomedCTDescriptionID 0..*(Complex)The SNOMED CT Description ID for the display
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
... subject SΣ1..1Reference(CareConnectPatient1)The patient to which the flag is assigned.
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... period Σ0..1PeriodTime period when flag is active
.... start SΣC0..1dateTimeThe date that the flag was placed against the patient
... author Σ0..1Reference(Device | CareConnectPatient1 | CareConnect-Organization-1 | CareConnect-Practitioner-1)The practitioner, organizational team or organization which placed the flag against the patient.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Flag.meta.securityextensibleAll Security Labels
Flag.meta.tagexampleCommon Tags
Flag.meta.tag:SourceexampleCommon Tags
Flag.meta.tag:ProvenanceexampleCommon Tags
Flag.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Flag.identifier.userequiredIdentifierUse
Flag.identifier:localIdentifier.userequiredIdentifierUse
Flag.statusrequiredFixed Value: active
Flag.categoryrequiredInterweave Flag Category (a valid code from InterweaveSocialCareFlagCategory)
Flag.codepreferredInterweave Flag Type

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorFlagIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorFlagIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFlagIf 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-4errorFlagIf 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..*CareConnect-Flag-1Key information to flag to healthcare providers
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierBusiness identifier
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:localIdentifier Σ0..1IdentifierBusiness identifier
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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 SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-flag-identifier
..... value SΣ1..1stringThe Local flag Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... status ?!SΣ1..1codeOnly use 'active' - only active flags should be shared.
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.


Fixed Value: active
... category SΣ1..1CodeableConceptClinical, administrative, etc.
Binding: Interweave Flag Category (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... code SΣ1..1CodeableConceptCoded or textual message to display to user
Binding: Interweave Flag Type (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:All Slices Content/Rules for all slices
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:snomedCT Σ0..1CodingSNOMED CT representation identifying specific flagged issues
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
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..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ1..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject SΣ1..1Reference(CareConnectPatient1)The patient to which the flag is assigned.
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringReference to a resource (could be Contained)
.... identifier Σ0..1IdentifierIf relevant could include an id
.... display Σ1..1stringDescription of the referenced resource
... period Σ0..1PeriodTime period when flag is active
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC0..1dateTimeThe date that the flag was placed against the patient
.... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... author Σ0..1Reference(Device | CareConnectPatient1 | CareConnect-Organization-1 | CareConnect-Practitioner-1)The practitioner, organizational team or organization which placed the flag against the patient.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Flag.meta.securityextensibleAll Security Labels
Flag.meta.tagexampleCommon Tags
Flag.meta.tag:SourceexampleCommon Tags
Flag.meta.tag:ProvenanceexampleCommon Tags
Flag.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Flag.identifier.userequiredIdentifierUse
Flag.identifier.typeextensibleIdentifier Type Codes
Flag.identifier:localIdentifier.userequiredIdentifierUse
Flag.identifier:localIdentifier.typeextensibleIdentifier Type Codes
Flag.statusrequiredFixed Value: active
Flag.categoryrequiredInterweave Flag Category (a valid code from InterweaveSocialCareFlagCategory)
Flag.codepreferredInterweave Flag Type

This structure is derived from CareConnect-Flag-1

Summary

Mandatory: 3 elements (12 nested mandatory elements)
Must-Support: 17 elements
Fixed Value: 4 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Flag.meta.tag is sliced based on the value of value:system
  • The element Flag.identifier is sliced based on the value of value:system

 

Other representations of profile: CSV, Excel, Schematron