Projo FHIR Documentation
0.1.0 - ci-build Switzerland flag

Projo FHIR Documentation - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Projo Flag ( Experimental )

Official URL: https://projo.evoleen.com/fhir/StructureDefinition/projo-flag Version: 0.1.0
Draft as of 2024-01-01 Computable Name: ProjoFlag

Copyright/Legal: Copyright (c) Projo. Licensed under CC0-1.0 (public domain dedication). FHIR(R) is the registered trademark of HL7 and is used with permission. This IG references WhatsApp(R), a trademark of Meta Platforms, Inc., for descriptive purposes only.

Review flag raised by the route-to-review bounded action when the clinical router cannot enroll the patient in a follow-up plan. Carries the bounded-action code on Flag.code, a clinical category, a deterministic routing-resource identifier for idempotency, and the Patient subject. The flag signals to a human reviewer that a routing decision needs manual attention.

Documentation-only artifact. Projo's runtime extensions, code systems, identifier systems and search parameter are TypeScript constants and bootstrap-time resources, NOT deployed StructureDefinitions. This StructureDefinition exists to document the contract; the source of truth is src/functions/src/lib/fhir/types.ts and docs/FHIR_EXTENSIONS.md.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* Flag Route-to-review flag (clinical routing)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier routing-resource identifier (<qrId>:review)
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://projo.evoleen.com/fhir/identifier/routing-resource
... category Σ 1..1 CodeableConcept clinical (flag-category code system)
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
.... coding Σ 1..1 Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/flag-category
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: clinical
... code Σ 1..1 CodeableConcept route-to-review (bounded-action code system)
Binding: FlagCode (example): Detail codes identifying specific flagged issues.
.... coding Σ 1..1 Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://projo.evoleen.com/fhir/CodeSystem/bounded-action
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: route-to-review
... subject Σ 1..1 Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) Patient reference

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Flag.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Flag.status Base required FlagStatus 📍4.0.1 FHIR Std.
Flag.category Base example Flag Category 📍4.0.1 FHIR Std.
Flag.code Base example Flag Code 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 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 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-5 error Flag If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Flag 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 Flag

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* Flag Route-to-review flag (clinical routing)
... identifier 1..* Identifier routing-resource identifier (<qrId>:review)
.... system 1..1 uri The namespace for the identifier value
Fixed Value: https://projo.evoleen.com/fhir/identifier/routing-resource
... status 1..1 code active (always)
Fixed Value: active
... category 1..1 CodeableConcept clinical (flag-category code system)
.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/flag-category
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: clinical
.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://projo.evoleen.com/fhir/CodeSystem/bounded-action
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: route-to-review
... subject 1..1 Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) Patient reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* Flag Route-to-review flag (clinical routing)
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier routing-resource identifier (<qrId>:review)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (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
Fixed Value: https://projo.evoleen.com/fhir/identifier/routing-resource
.... value Σ 0..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(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code active (always)
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 was entered in error.
Fixed Value: active
... category Σ 1..1 CodeableConcept clinical (flag-category code system)
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
.... id 0..1 string Unique id for inter-element referencing
.... 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 Unique id for inter-element referencing
..... 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://terminology.hl7.org/CodeSystem/flag-category
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: clinical
..... display Σ 0..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
... code Σ 1..1 CodeableConcept route-to-review (bounded-action code system)
Binding: FlagCode (example): Detail codes identifying specific flagged issues.
.... id 0..1 string Unique id for inter-element referencing
.... 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 Unique id for inter-element referencing
..... 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: https://projo.evoleen.com/fhir/CodeSystem/bounded-action
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: route-to-review
..... display Σ 0..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(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) Patient reference
... period Σ 0..1 Period Time period when flag is active
... encounter Σ 0..1 Reference(Encounter) Alert relevant during encounter
... author Σ 0..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole) Flag creator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Flag.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Flag.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Flag.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Flag.status Base required FlagStatus 📍4.0.1 FHIR Std.
Flag.category Base example Flag Category 📍4.0.1 FHIR Std.
Flag.code Base example Flag Code 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 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 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-5 error Flag If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Flag 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 Flag

Summary

Mandatory: 9 elements
Fixed: 6 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* Flag Route-to-review flag (clinical routing)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier routing-resource identifier (<qrId>:review)
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://projo.evoleen.com/fhir/identifier/routing-resource
... category Σ 1..1 CodeableConcept clinical (flag-category code system)
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
.... coding Σ 1..1 Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/flag-category
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: clinical
... code Σ 1..1 CodeableConcept route-to-review (bounded-action code system)
Binding: FlagCode (example): Detail codes identifying specific flagged issues.
.... coding Σ 1..1 Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://projo.evoleen.com/fhir/CodeSystem/bounded-action
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: route-to-review
... subject Σ 1..1 Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) Patient reference

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Flag.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Flag.status Base required FlagStatus 📍4.0.1 FHIR Std.
Flag.category Base example Flag Category 📍4.0.1 FHIR Std.
Flag.code Base example Flag Code 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 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 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-5 error Flag If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Flag 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()

Differential View

This structure is derived from Flag

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* Flag Route-to-review flag (clinical routing)
... identifier 1..* Identifier routing-resource identifier (<qrId>:review)
.... system 1..1 uri The namespace for the identifier value
Fixed Value: https://projo.evoleen.com/fhir/identifier/routing-resource
... status 1..1 code active (always)
Fixed Value: active
... category 1..1 CodeableConcept clinical (flag-category code system)
.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/flag-category
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: clinical
.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://projo.evoleen.com/fhir/CodeSystem/bounded-action
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: route-to-review
... subject 1..1 Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) Patient reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* Flag Route-to-review flag (clinical routing)
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier routing-resource identifier (<qrId>:review)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (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
Fixed Value: https://projo.evoleen.com/fhir/identifier/routing-resource
.... value Σ 0..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(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code active (always)
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 was entered in error.
Fixed Value: active
... category Σ 1..1 CodeableConcept clinical (flag-category code system)
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
.... id 0..1 string Unique id for inter-element referencing
.... 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 Unique id for inter-element referencing
..... 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://terminology.hl7.org/CodeSystem/flag-category
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: clinical
..... display Σ 0..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
... code Σ 1..1 CodeableConcept route-to-review (bounded-action code system)
Binding: FlagCode (example): Detail codes identifying specific flagged issues.
.... id 0..1 string Unique id for inter-element referencing
.... 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 Unique id for inter-element referencing
..... 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: https://projo.evoleen.com/fhir/CodeSystem/bounded-action
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: route-to-review
..... display Σ 0..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(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) Patient reference
... period Σ 0..1 Period Time period when flag is active
... encounter Σ 0..1 Reference(Encounter) Alert relevant during encounter
... author Σ 0..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole) Flag creator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Flag.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Flag.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Flag.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Flag.status Base required FlagStatus 📍4.0.1 FHIR Std.
Flag.category Base example Flag Category 📍4.0.1 FHIR Std.
Flag.code Base example Flag Code 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 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 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-5 error Flag If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Flag 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 Flag

Summary

Mandatory: 9 elements
Fixed: 6 elements

 

Other representations of profile: CSV, Excel, Schematron