FHIR New Zealand Patient Summary IG
0.3.0 - ci-build
FHIR New Zealand Patient Summary IG, published by Health NZ | Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-nzps/ and changes regularly. See the Directory of published versions
Official URL: https://standards.digital.health.nz/fhir/StructureDefinition/nzps-flag | Version: 0.3.0 | |||
Active as of 2024-11-22 | Computable Name: NZPSFlag |
Information used to warn or call to a state of preparedness. Information flagged (or intended) to raise awareness of a potential danger to/from the subject of the patient summary or to/from another individual or awareness of a potential obstacle to care
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 | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Flag | 0..* | Flag | Key information to flag to healthcare providers | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | active | inactive | entered-in-error Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error. |
code | Σ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (example): Detail codes identifying specific flagged issues. |
subject | Σ | 1..1 | Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) | Who/What is flag about? |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Flag.status | required | FlagStatushttp://hl7.org/fhir/ValueSet/flag-status|4.0.1 from the FHIR Standard | |
Flag.code | example | FlagCodehttp://hl7.org/fhir/ValueSet/flag-code from 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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. | ||||
category | Σ | 0..* | CodeableConcept | Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes. | ||||
code | Σ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (example): Detail codes identifying specific flagged issues. | ||||
subject | Σ | 1..1 | Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) | Who/What is flag about? | ||||
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 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Flag.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Flag.status | required | FlagStatushttp://hl7.org/fhir/ValueSet/flag-status|4.0.1 from the FHIR Standard | ||||
Flag.category | example | FlagCategoryhttp://hl7.org/fhir/ValueSet/flag-category from the FHIR Standard | ||||
Flag.code | example | FlagCodehttp://hl7.org/fhir/ValueSet/flag-code from 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 | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Flag | 0..* | Flag | Key information to flag to healthcare providers | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | active | inactive | entered-in-error Binding: FlagStatus (required): Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error. |
code | Σ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (example): Detail codes identifying specific flagged issues. |
subject | Σ | 1..1 | Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) | Who/What is flag about? |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Flag.status | required | FlagStatushttp://hl7.org/fhir/ValueSet/flag-status|4.0.1 from the FHIR Standard | |
Flag.code | example | FlagCodehttp://hl7.org/fhir/ValueSet/flag-code from 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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. | ||||
category | Σ | 0..* | CodeableConcept | Clinical, administrative, etc. Binding: FlagCategory (example): A general category for flags for filtering/display purposes. | ||||
code | Σ | 1..1 | CodeableConcept | Coded or textual message to display to user Binding: FlagCode (example): Detail codes identifying specific flagged issues. | ||||
subject | Σ | 1..1 | Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) | Who/What is flag about? | ||||
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 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Flag.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Flag.status | required | FlagStatushttp://hl7.org/fhir/ValueSet/flag-status|4.0.1 from the FHIR Standard | ||||
Flag.category | example | FlagCategoryhttp://hl7.org/fhir/ValueSet/flag-category from the FHIR Standard | ||||
Flag.code | example | FlagCodehttp://hl7.org/fhir/ValueSet/flag-code from 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