{
"description": "An alert describes a clinical or administrative fact brought to the attention of the users of the clinical systems to be taken into account when shaping diagnostic and therapeutic policy or in dealing with the patient, usually because of a safety risk.\\r\\nDisorders that describe the body’s sensitivity to a substance which results in a specific physiological reaction after being exposed to that substance are referred to as allergies. These are described in a separate information model.\\r\\nWarnings for non-allergic disorders can concern:\\r\\n* A disorder, condition or diagnosis which can be considered as a contraindication for undergoing a certain type of therapy, such as pregnancy or long QT syndrome;\\r\\n* Impaired functioning of an organ system (heart failure, impaired liver or kidney function, weakened immune system);\\r\\n* Risk of spreading certain microorganisms (multi-resistant bacteria, tubercle bacilli, HIV, HBV, Ebola virus);\\r\\n* Other risks",
"_filename": "examples/zib-Alert.json",
"package_name": "nictiz.fhir.nl.r4.zib2020",
"date": null,
"derivation": "constraint",
"publisher": "Nictiz",
"fhirVersion": "4.0.1",
"purpose": "This Flag resource represents the Dutch [zib ('Zorginformatiebouwsteen', i.e. Health and Care Information Model) Alert v4.1 (2020)](https://zibs.nl/wiki/Alert-v4.1(2020EN)).",
"name": "ZibAlert",
"mapping": [ {
"uri": "https://zibs.nl/wiki/Alert-v4.1(2020EN)",
"name": "zib Alert-v4.1(2020EN)",
"identity": "zib-alert-v4.1-2020EN"
} ],
"abstract": true,
"copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
"type": "Flag",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "zib Alert",
"package_version": "0.12.0-beta.3",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "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",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "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()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
}, {
"key": "zib-Alert-1",
"human": "One concept from Condition::Concern and AlertName must be selected. If Flag.code contains a code from AlertNaamCodelijst, Flag.extension:condition SHALL not exist.",
"source": "http://nictiz.nl/fhir/StructureDefinition/zib-Alert",
"severity": "error",
"expression": "code.memberOf('http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.2--20200901000000') implies extension.where(url = 'http://hl7.org/fhir/StructureDefinition/flag-detail').exists().not()"
}, {
"key": "zib-Alert-2",
"human": "One concept from Condition::Concern and AlertName must be selected. If Flag.extension:condition is filled, Flag.code SHALL contain code 'not-applicable' from system 'http://terminology.hl7.org/CodeSystem/data-absent-reason'.",
"source": "http://nictiz.nl/fhir/StructureDefinition/zib-Alert",
"severity": "error",
"expression": "extension('http://hl7.org/fhir/StructureDefinition/flag-detail').exists() implies code.coding.where($this.system = 'http://terminology.hl7.org/CodeSystem/data-absent-reason' and $this.code = 'not-applicable').exists()"
} ],
"path": "Flag",
"min": 0,
"definition": "Prospective warnings of potential issues when providing care to the patient.",
"isModifier": false,
"short": "Alert",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Observation[classCode=ISSUE, moodCode=EVN]",
"identity": "rim"
}, {
"map": "NL-CM:8.3.1",
"comment": "Alert",
"identity": "zib-alert-v4.1-2020EN"
} ],
"alias": [ "Barriers to Care", "Alert", "Warning" ],
"max": "*",
"id": "Flag",
"comment": "One of the zib concepts Condition::Concern and AlertName must be selected. If `.code` contains a code from AlertNaamCodelijst, `.extension:condition` SHALL not exist. On the other hand, if `.extension:condition` is populated, `.code` SHALL contain code _not-applicable_ from system _http://terminology.hl7.org/CodeSystem/data-absent-reason_.",
"base": {
"max": "*",
"min": 0,
"path": "Flag"
},
"isSummary": false
}, {
"path": "Flag.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"max": "1",
"id": "Flag.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Flag.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Flag.implicitRules",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language."
},
"max": "1",
"id": "Flag.language",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Flag.text",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "Flag.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Flag.contained",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Flag.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Flag.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Flag.extension",
"min": 0,
"definition": "Points to the Observation, AllergyIntolerance or other record that provides additional supporting information about this flag.",
"isModifier": false,
"short": "Resource with details for flag",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/flag-detail" ]
} ],
"sliceName": "condition",
"alias": [ "extensions", "user content" ],
"max": "1",
"id": "Flag.extension:condition",
"condition": [ "ele-1", "zib-Alert-1", "zib-Alert-2" ],
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"path": "Flag.extension.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Flag.extension:condition.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Flag.extension.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "0",
"id": "Flag.extension:condition.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Flag.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"isModifier": false,
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/flag-detail",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Flag.extension:condition.url",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.extension.value[x]",
"min": 1,
"definition": "The patient’s health problem or condition that is the subject of the alert. This could involve a patient’s problem, condition or diagnosis that is seen as a contraindication in prescribing medication or which has to be taken into account when shaping diagnostic and therapeutic policy. This can be in the patient’s own interest, or it can involve a problem or disorder that can make the patient a risk to their surroundings, such as an infection hazard. These are references to conditions included on the patient’s problem list.",
"isModifier": false,
"short": "Condition",
"mapping": [ {
"map": "N/A",
"identity": "rim"
}, {
"map": "NL-CM:8.3.3",
"comment": "Condition",
"identity": "zib-alert-v4.1-2020EN"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource", "http://nictiz.nl/fhir/StructureDefinition/zib-Problem" ]
} ],
"alias": [ "Conditie" ],
"max": "1",
"id": "Flag.extension:condition.value[x]",
"condition": [ "zib-Alert-1", "zib-Alert-2" ],
"comment": "One of the zib concepts Condition::Concern and AlertName must be selected. If `.code` contains a code from AlertNaamCodelijst, `.extension:condition` SHALL not exist. On the other hand, if `.extension:condition` is populated, `.code` SHALL contain code _not-applicable_ from system _http://hl7.org/fhir/ValueSet/data-absent-reason_.",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Flag.extension",
"min": 0,
"definition": "Optional Extension Element - found in all resources.",
"isModifier": false,
"short": "Optional Extensions Element",
"mapping": [ {
"map": "N/A",
"identity": "rim"
}, {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" ]
} ],
"sliceName": "comment",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "extensions", "user content" ],
"max": "1",
"id": "Flag.extension:comment",
"condition": [ "ele-1" ],
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"path": "Flag.extension.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Flag.extension:comment.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Flag.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Flag.extension:comment.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Flag.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"isModifier": false,
"short": "identifies the meaning of the extension",
"fixedUri": "http://nictiz.nl/fhir/StructureDefinition/ext-Comment",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Flag.extension:comment.url",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.extension.value[x]",
"min": 0,
"definition": "Explanatory comments to the alert that can not be expressed in any of the other elements.",
"isModifier": false,
"short": "Comment",
"mapping": [ {
"map": "N/A",
"identity": "rim"
}, {
"map": "NL-CM:8.3.7",
"comment": "Comment",
"identity": "zib-alert-v4.1-2020EN"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "Toelichting" ],
"max": "1",
"id": "Flag.extension:comment.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Flag.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Flag.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.identifier",
"requirements": "Allows identification of the flag as it is known by various participating systems and in a way that remains consistent across servers.",
"min": 0,
"definition": "Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"isModifier": false,
"short": "Business identifier",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": ".id",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "Flag.identifier",
"comment": "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"base": {
"max": "*",
"min": 0,
"path": "Flag.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.status",
"min": 1,
"definition": "Supports basic workflow.",
"isModifier": true,
"short": "active | inactive | entered-in-error",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": ".status",
"identity": "rim"
}, {
"map": "NL-CM:8.3.8",
"comment": "EndDateTime (implicit, main mapping is on Flag.period.end)",
"identity": "zib-alert-v4.1-2020EN"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/flag-status|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FlagStatus"
} ],
"description": "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."
},
"max": "1",
"id": "Flag.status",
"comment": "Sending systems that don't record an explicit status can use the following guidance to infer a value from the zib:\r\n\r\n* EndDateTime present and in the past: _inactive_\r\n* EndDateTime absent: _active_\r\n* EndDateTime present and in the future - goes against both FHIR and zib definitions, but in a case where this might occur: _active_",
"base": {
"max": "1",
"min": 1,
"path": "Flag.status"
},
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.category",
"min": 0,
"definition": "Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.",
"isModifier": false,
"short": "Clinical, administrative, etc.",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": ".code",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "value"
} ]
},
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/flag-category",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FlagCategory"
} ],
"description": "A general category for flags for filtering/display purposes."
},
"max": "*",
"id": "Flag.category",
"comment": "The value set will often need to be adjusted based on local business rules and usage context.",
"base": {
"max": "*",
"min": 0,
"path": "Flag.category"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.category",
"min": 0,
"definition": "Indicates the type of alert, meaning a rough description of the cause or origin of the warning.",
"isModifier": false,
"short": "AlertType",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "NL-CM:8.3.6",
"comment": "AlertType",
"identity": "zib-alert-v4.1-2020EN"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"sliceName": "alertType",
"binding": {
"strength": "required",
"valueSet": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.1--20200901000000",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FlagCategory"
} ],
"description": "A general category for flags for filtering/display purposes."
},
"alias": [ "AlertType" ],
"max": "1",
"id": "Flag.category:alertType",
"comment": "The value set will often need to be adjusted based on local business rules and usage context.",
"base": {
"max": "*",
"min": 0,
"path": "Flag.category"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.code",
"min": 1,
"definition": "The coded value or textual component of the flag to display to the user.",
"isModifier": false,
"short": "Coded or textual message to display to user",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": ".value",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/flag-code",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FlagCode"
} ],
"description": "Detail codes identifying specific flagged issues."
},
"max": "1",
"id": "Flag.code",
"condition": [ "zib-Alert-1", "zib-Alert-2" ],
"comment": "If non-coded, use CodeableConcept.text. This element should always be included in the narrative.",
"base": {
"max": "1",
"min": 1,
"path": "Flag.code"
},
"isSummary": true
}, {
"path": "Flag.code.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Flag.code.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Flag.code.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Flag.code.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.code.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 1,
"definition": "A reference to a code defined by a terminology system.",
"isModifier": false,
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "value"
} ]
},
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "Flag.code.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.code.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 0,
"definition": "A warning, other than a condition or problem. For example, a patient can be given an ‘Aggressive patient' alert. The warning can be entered in code (there are codes for frequently used alerts), but seeing the dynamic nature of the warnings cf. SARS and Ebola, these alerts will often be entered as free text.",
"isModifier": false,
"short": "AlertName",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
}, {
"map": "NL-CM:8.3.4",
"comment": "AlertName",
"identity": "zib-alert-v4.1-2020EN"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "alertName",
"binding": {
"strength": "required",
"valueSet": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.2--20200901000000"
},
"alias": [ "AlertNaam" ],
"max": "1",
"id": "Flag.code.coding:alertName",
"condition": [ "zib-Alert-1" ],
"comment": "If this slice is used, slice `:dataAbsentReason` MUST be absent and `Flag.extension:condition` MUST NOT exist. See the guidance on the root.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.code.coding",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"isModifier": false,
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "dataAbsentReason",
"max": "1",
"id": "Flag.code.coding:dataAbsentReason",
"condition": [ "zib-Alert-2" ],
"comment": "This slice MUST be used when `Flag.extension:condition` is populated. Slice `:alertName` MUST be absent in this case. See the guidance on the root.",
"patternCoding": {
"code": "not-applicable",
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason"
},
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.code.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"isModifier": false,
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Flag.code.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.subject",
"min": 1,
"definition": "The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with.",
"isModifier": false,
"short": "Who/What is flag about?",
"mapping": [ {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": ".participation[typeCode=SBJ].role[classCode=PAT | LOCE | ASSIGNED]",
"identity": "rim"
}, {
"map": "FiveWs.subject",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Location", "http://hl7.org/fhir/StructureDefinition/Group", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PlanDefinition", "http://hl7.org/fhir/StructureDefinition/Medication", "http://hl7.org/fhir/StructureDefinition/Procedure" ]
} ],
"max": "1",
"id": "Flag.subject",
"base": {
"max": "1",
"min": 1,
"path": "Flag.subject"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.period",
"min": 0,
"definition": "The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.",
"isModifier": false,
"short": "Time period when flag is active",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Flag.period",
"base": {
"max": "1",
"min": 0,
"path": "Flag.period"
},
"isSummary": true
}, {
"path": "Flag.period.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Flag.period.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Flag.period.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Flag.period.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.period.start",
"min": 0,
"definition": "The date and time at which the described condition was entered as a warning. This can be an exact date and time, or a rough indication of the date (such as only the year, or the month and the year).",
"isModifier": false,
"short": "StartDateTime",
"mapping": [ {
"map": "DR.1",
"identity": "v2"
}, {
"map": "./low",
"identity": "rim"
}, {
"map": "NL-CM:8.3.5",
"comment": "StartDateTime",
"identity": "zib-alert-v4.1-2020EN"
} ],
"type": [ {
"code": "dateTime"
} ],
"alias": [ "BeginDatumTijd" ],
"max": "1",
"id": "Flag.period.start",
"condition": [ "per-1" ],
"comment": "If the low element is missing, the meaning is that the low boundary is not known.",
"base": {
"max": "1",
"min": 0,
"path": "Period.start"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.period.end",
"min": 0,
"definition": "The date and time at which the described condition was retracted as a warning. This can be an exact date and time, or a rough indication of the date (such as only the year, or the month and the year).",
"isModifier": false,
"short": "EndDateTime",
"mapping": [ {
"map": "DR.2",
"identity": "v2"
}, {
"map": "./high",
"identity": "rim"
}, {
"map": "NL-CM:8.3.8",
"comment": "EndDateTime",
"identity": "zib-alert-v4.1-2020EN"
} ],
"type": [ {
"code": "dateTime"
} ],
"meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing",
"alias": [ "EindDatumTijd" ],
"max": "1",
"id": "Flag.period.end",
"condition": [ "per-1" ],
"comment": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.",
"base": {
"max": "1",
"min": 0,
"path": "Period.end"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.encounter",
"min": 0,
"definition": "This alert is only relevant during the encounter.",
"isModifier": false,
"short": "Alert relevant during encounter",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ]
} ],
"max": "1",
"id": "Flag.encounter",
"comment": "If both Flag.encounter and Flag.period are valued, then Flag.period.start shall not be before Encounter.period.start and Flag.period.end shall not be after Encounter.period.end.",
"base": {
"max": "1",
"min": 0,
"path": "Flag.encounter"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Flag.author",
"min": 0,
"definition": "The person, organization or device that created the flag.",
"isModifier": false,
"short": "Flag creator",
"mapping": [ {
"map": "FiveWs.author",
"identity": "w5"
}, {
"map": ".participation[typeCode=AUT].role",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ]
} ],
"max": "1",
"id": "Flag.author",
"base": {
"max": "1",
"min": 0,
"path": "Flag.author"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "9bdafd66-a08d-482b-b689-b42c7dabb5b8",
"kind": "resource",
"url": "http://nictiz.nl/fhir/StructureDefinition/zib-Alert",
"version": null,
"differential": {
"element": [ {
"id": "Flag",
"path": "Flag",
"short": "Alert",
"comment": "One of the zib concepts Condition::Concern and AlertName must be selected. If `.code` contains a code from AlertNaamCodelijst, `.extension:condition` SHALL not exist. On the other hand, if `.extension:condition` is populated, `.code` SHALL contain code _not-applicable_ from system _http://terminology.hl7.org/CodeSystem/data-absent-reason_.",
"mapping": [ {
"map": "NL-CM:8.3.1",
"comment": "Alert",
"identity": "zib-alert-v4.1-2020EN"
} ],
"constraint": [ {
"key": "zib-Alert-1",
"human": "One concept from Condition::Concern and AlertName must be selected. If Flag.code contains a code from AlertNaamCodelijst, Flag.extension:condition SHALL not exist.",
"severity": "error",
"expression": "code.memberOf('http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.2--20200901000000') implies extension.where(url = 'http://hl7.org/fhir/StructureDefinition/flag-detail').exists().not()"
}, {
"key": "zib-Alert-2",
"human": "One concept from Condition::Concern and AlertName must be selected. If Flag.extension:condition is filled, Flag.code SHALL contain code 'not-applicable' from system 'http://terminology.hl7.org/CodeSystem/data-absent-reason'.",
"severity": "error",
"expression": "extension('http://hl7.org/fhir/StructureDefinition/flag-detail').exists() implies code.coding.where($this.system = 'http://terminology.hl7.org/CodeSystem/data-absent-reason' and $this.code = 'not-applicable').exists()"
} ]
}, {
"id": "Flag.extension:condition",
"max": "1",
"path": "Flag.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/flag-detail" ]
} ],
"condition": [ "zib-Alert-1", "zib-Alert-2" ],
"sliceName": "condition"
}, {
"path": "Flag.extension.value[x]",
"definition": "The patient’s health problem or condition that is the subject of the alert. This could involve a patient’s problem, condition or diagnosis that is seen as a contraindication in prescribing medication or which has to be taken into account when shaping diagnostic and therapeutic policy. This can be in the patient’s own interest, or it can involve a problem or disorder that can make the patient a risk to their surroundings, such as an infection hazard. These are references to conditions included on the patient’s problem list.",
"short": "Condition",
"mapping": [ {
"map": "NL-CM:8.3.3",
"comment": "Condition",
"identity": "zib-alert-v4.1-2020EN"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource", "http://nictiz.nl/fhir/StructureDefinition/zib-Problem" ]
} ],
"alias": [ "Conditie" ],
"id": "Flag.extension:condition.value[x]",
"condition": [ "zib-Alert-1", "zib-Alert-2" ],
"comment": "One of the zib concepts Condition::Concern and AlertName must be selected. If `.code` contains a code from AlertNaamCodelijst, `.extension:condition` SHALL not exist. On the other hand, if `.extension:condition` is populated, `.code` SHALL contain code _not-applicable_ from system _http://hl7.org/fhir/ValueSet/data-absent-reason_."
}, {
"id": "Flag.extension:comment",
"max": "1",
"path": "Flag.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" ]
} ],
"sliceName": "comment"
}, {
"id": "Flag.extension:comment.value[x]",
"path": "Flag.extension.value[x]",
"alias": [ "Toelichting" ],
"short": "Comment",
"mapping": [ {
"map": "NL-CM:8.3.7",
"comment": "Comment",
"identity": "zib-alert-v4.1-2020EN"
} ],
"definition": "Explanatory comments to the alert that can not be expressed in any of the other elements."
}, {
"id": "Flag.status",
"path": "Flag.status",
"comment": "Sending systems that don't record an explicit status can use the following guidance to infer a value from the zib:\r\n\r\n* EndDateTime present and in the past: _inactive_\r\n* EndDateTime absent: _active_\r\n* EndDateTime present and in the future - goes against both FHIR and zib definitions, but in a case where this might occur: _active_",
"mapping": [ {
"map": "NL-CM:8.3.8",
"comment": "EndDateTime (implicit, main mapping is on Flag.period.end)",
"identity": "zib-alert-v4.1-2020EN"
} ]
}, {
"id": "Flag.category",
"path": "Flag.category",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "value"
} ]
}
}, {
"path": "Flag.category",
"definition": "Indicates the type of alert, meaning a rough description of the cause or origin of the warning.",
"short": "AlertType",
"mapping": [ {
"map": "NL-CM:8.3.6",
"comment": "AlertType",
"identity": "zib-alert-v4.1-2020EN"
} ],
"sliceName": "alertType",
"binding": {
"strength": "required",
"valueSet": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.1--20200901000000"
},
"alias": [ "AlertType" ],
"max": "1",
"id": "Flag.category:alertType"
}, {
"id": "Flag.code",
"path": "Flag.code",
"condition": [ "zib-Alert-1", "zib-Alert-2" ]
}, {
"id": "Flag.code.coding",
"min": 1,
"path": "Flag.code.coding",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "value"
} ]
}
}, {
"path": "Flag.code.coding",
"definition": "A warning, other than a condition or problem. For example, a patient can be given an ‘Aggressive patient' alert. The warning can be entered in code (there are codes for frequently used alerts), but seeing the dynamic nature of the warnings cf. SARS and Ebola, these alerts will often be entered as free text.",
"short": "AlertName",
"mapping": [ {
"map": "NL-CM:8.3.4",
"comment": "AlertName",
"identity": "zib-alert-v4.1-2020EN"
} ],
"sliceName": "alertName",
"binding": {
"strength": "required",
"valueSet": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.2--20200901000000"
},
"alias": [ "AlertNaam" ],
"max": "1",
"id": "Flag.code.coding:alertName",
"condition": [ "zib-Alert-1" ],
"comment": "If this slice is used, slice `:dataAbsentReason` MUST be absent and `Flag.extension:condition` MUST NOT exist. See the guidance on the root."
}, {
"id": "Flag.code.coding:dataAbsentReason",
"max": "1",
"path": "Flag.code.coding",
"comment": "This slice MUST be used when `Flag.extension:condition` is populated. Slice `:alertName` MUST be absent in this case. See the guidance on the root.",
"condition": [ "zib-Alert-2" ],
"sliceName": "dataAbsentReason",
"patternCoding": {
"code": "not-applicable",
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason"
}
}, {
"id": "Flag.period.start",
"path": "Flag.period.start",
"alias": [ "BeginDatumTijd" ],
"short": "StartDateTime",
"mapping": [ {
"map": "NL-CM:8.3.5",
"comment": "StartDateTime",
"identity": "zib-alert-v4.1-2020EN"
} ],
"definition": "The date and time at which the described condition was entered as a warning. This can be an exact date and time, or a rough indication of the date (such as only the year, or the month and the year)."
}, {
"id": "Flag.period.end",
"path": "Flag.period.end",
"alias": [ "EindDatumTijd" ],
"short": "EndDateTime",
"mapping": [ {
"map": "NL-CM:8.3.8",
"comment": "EndDateTime",
"identity": "zib-alert-v4.1-2020EN"
} ],
"definition": "The date and time at which the described condition was retracted as a warning. This can be an exact date and time, or a rough indication of the date (such as only the year, or the month and the year)."
} ]
},
"contact": [ {
"name": "Nictiz",
"telecom": [ {
"use": "work",
"value": "https://www.nictiz.nl",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Flag"
}