HL7 PT FHIR Implementation Guide: Community Health
1.0.1 - STU1
HL7 PT FHIR Implementation Guide: Community Health
1.0.1 - STU1
HL7 PT FHIR Implementation Guide: Community Health, published by HL7 Portugal. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AnaCeciliaCoimbra/community-health-ig/ and changes regularly. See the Directory of published versions
| Official URL: https://hl7.pt/fhir/community-health/StructureDefinition/flag-critical-disease | Version: 1.0.1 | |||
| Active as of 2024-12-12 | Computable Name: FlagCriticalDisease | |||
Este perfil representa a utilização do recurso Flag para referenciar uma doença critica.
Usage:
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 | |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
   flagDetail |
1..1 | Reference(Condition) | Extension - Flag Detail URL: https://hl7.pt/fhir/community-health/StructureDefinition/flag-detail | |
  status |
1..1 | code | active | inactive | entered-in-error Required Pattern: active | |
| category |
1..1 | CodeableConcept | Clinical, administrative, etc. | |
 coding |
1..1 | Coding | Code defined by a terminology system | |
  code |
0..1 | code | Symbol in syntax defined by the system Required Pattern: clinical | |
| code |
||||
| text |
1..1 | string | Plain text representation of the concept | |
 subject |
1..1 | Reference(Patient) | Who/What is flag about? | |
| period |
||||
| start |
1..1 | dateTime | Starting time with inclusive boundary | |
| author |
1..1 | Reference(Practitioner) | Flag creator | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Flag |
0..* | Flag | Key information to flag to healthcare providers dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| flagDetail |
1..1 | Reference(Condition) | Extension - Flag Detail URL: https://hl7.pt/fhir/community-health/StructureDefinition/flag-detail ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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 was entered in error. ele-1: All FHIR elements must have a @value or children Required Pattern: active |
 category |
Σ | 1..1 | CodeableConcept | Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes. ele-1: All FHIR elements must have a @value or children |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Required Pattern: clinical |
| code |
Σ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (example): Detail codes identifying specific flagged issues. ele-1: All FHIR elements must have a @value or children |
| text |
Σ | 1..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| subject |
Σ | 1..1 | Reference(Patient) | Who/What is flag about? ele-1: All FHIR elements must have a @value or children |
| author |
Σ | 1..1 | Reference(Practitioner) | Flag creator ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Flag.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/flag-status|4.0.1from the FHIR Standard | |
| Flag.category | example | FlagCategoryhttp://hl7.org/fhir/ValueSet/flag-categoryfrom the FHIR Standard | |
| Flag.code | example | FlagCodehttp://hl7.org/fhir/ValueSet/flag-codefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
| 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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| flagDetail |
1..1 | Reference(Condition) | Extension - Flag Detail URL: https://hl7.pt/fhir/community-health/StructureDefinition/flag-detail | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business identifier | ||||
| 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 was entered in error. Required Pattern: active | ||||
| category |
Σ | 1..1 | CodeableConcept | Clinical, administrative, etc. 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 |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: 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 | Coded or textual message to display to user 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 |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 1..1 | string | Plain text representation of the concept | ||||
| subject |
Σ | 1..1 | Reference(Patient) | Who/What is flag about? | ||||
| period |
Σ | 0..1 | Period | Time period when flag is active | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
ΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Alert relevant during encounter | ||||
| author |
Σ | 1..1 | Reference(Practitioner) | Flag creator | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Flag.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Flag.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/flag-status|4.0.1from the FHIR Standard | ||||
| Flag.category | example | FlagCategoryhttp://hl7.org/fhir/ValueSet/flag-categoryfrom the FHIR Standard | ||||
| Flag.code | example | FlagCodehttp://hl7.org/fhir/ValueSet/flag-codefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Differential View
This structure is derived from Flag
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Flag |
0..* | Flag | Key information to flag to healthcare providers | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| flagDetail |
1..1 | Reference(Condition) | Extension - Flag Detail URL: https://hl7.pt/fhir/community-health/StructureDefinition/flag-detail | |
| status |
1..1 | code | active | inactive | entered-in-error Required Pattern: active | |
| category |
1..1 | CodeableConcept | Clinical, administrative, etc. | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system Required Pattern: clinical | |
| code |
||||
| text |
1..1 | string | Plain text representation of the concept | |
| subject |
1..1 | Reference(Patient) | Who/What is flag about? | |
| period |
||||
| start |
1..1 | dateTime | Starting time with inclusive boundary | |
| author |
1..1 | Reference(Practitioner) | 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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| flagDetail |
1..1 | Reference(Condition) | Extension - Flag Detail URL: https://hl7.pt/fhir/community-health/StructureDefinition/flag-detail ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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 was entered in error. ele-1: All FHIR elements must have a @value or children Required Pattern: active |
| category |
Σ | 1..1 | CodeableConcept | Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes. ele-1: All FHIR elements must have a @value or children |
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Required Pattern: clinical |
| code |
Σ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (example): Detail codes identifying specific flagged issues. ele-1: All FHIR elements must have a @value or children |
| text |
Σ | 1..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| subject |
Σ | 1..1 | Reference(Patient) | Who/What is flag about? ele-1: All FHIR elements must have a @value or children |
| author |
Σ | 1..1 | Reference(Practitioner) | Flag creator ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Flag.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/flag-status|4.0.1from the FHIR Standard | |
| Flag.category | example | FlagCategoryhttp://hl7.org/fhir/ValueSet/flag-categoryfrom the FHIR Standard | |
| Flag.code | example | FlagCodehttp://hl7.org/fhir/ValueSet/flag-codefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| flagDetail |
1..1 | Reference(Condition) | Extension - Flag Detail URL: https://hl7.pt/fhir/community-health/StructureDefinition/flag-detail | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business identifier | ||||
| 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 was entered in error. Required Pattern: active | ||||
| category |
Σ | 1..1 | CodeableConcept | Clinical, administrative, etc. 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 |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system Required Pattern: 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 | Coded or textual message to display to user 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 |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 1..1 | string | Plain text representation of the concept | ||||
| subject |
Σ | 1..1 | Reference(Patient) | Who/What is flag about? | ||||
| period |
Σ | 0..1 | Period | Time period when flag is active | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
ΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Alert relevant during encounter | ||||
| author |
Σ | 1..1 | Reference(Practitioner) | Flag creator | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Flag.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Flag.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/flag-status|4.0.1from the FHIR Standard | ||||
| Flag.category | example | FlagCategoryhttp://hl7.org/fhir/ValueSet/flag-categoryfrom the FHIR Standard | ||||
| Flag.code | example | FlagCodehttp://hl7.org/fhir/ValueSet/flag-codefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Other representations of profile: CSV, Excel, Schematron