ISO/HL7 10781 - Electronic Health Record System Functional Model, Release 2.1
0.14.0 - CI Build
ISO/HL7 10781 - Electronic Health Record System Functional Model, Release 2.1
0.14.0 - CI Build
ISO/HL7 10781 - Electronic Health Record System Functional Model, Release 2.1 - Local Development build (v0.14.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2024-06-01 |
XML representation of the FMHeader resource profile.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="FMHeader"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck0.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_resource.png" alt="." style="background-color: white; background-color: inherit" title="Resource" class="hierarchy"/> <a href="StructureDefinition-FMHeader-definitions.html#Requirements">Requirements</a><a name="Requirements"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints ( FMHC002, FMHC004, FMHC005, FMHC006, FMHC007, FMHC010 )">C</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R5/requirements.html">Requirements</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">A set of requirements - features of systems that are necessary</span><br/><span style="font-weight:bold">FMHC002: </span>The header should have a name.<br/><span style="font-weight:bold">FMHC004: </span>Header must have a statement about its purpose.<br/><span style="font-weight:bold">FMHC005: </span>Header purpose statement must end in a period.<br/><span style="font-weight:bold">FMHC006: </span>Header must have a description.<br/><span style="font-weight:bold">FMHC007: </span>Header description statement must end in a period.<br/><span style="font-weight:bold">FMHC010: </span>A Header must not have criteria statements.</td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
</text>
<url value="http://hl7.org/ehrs/StructureDefinition/FMHeader"/>
<version value="0.14.0"/>
<name value="FMHeader"/>
<title value="FMHeader"/>
<status value="draft"/>
<date value="2024-06-01T08:34:10+00:00"/>
<publisher value="EHR WG"/>
<contact>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/ehr"/>
</telecom>
</contact>
<description
value="This StructureDefinition represents the base EHR-S FM Header type"/>
<fhirVersion value="5.0.0"/>
<mapping>
<identity value="workflow"/>
<uri value="http://hl7.org/fhir/workflow"/>
<name value="Workflow Pattern"/>
</mapping>
<mapping>
<identity value="w5"/>
<uri value="http://hl7.org/fhir/fivews"/>
<name value="FiveWs Pattern Mapping"/>
</mapping>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="resource"/>
<abstract value="false"/>
<type value="Requirements"/>
<baseDefinition
value="http://hl7.org/fhir/StructureDefinition/Requirements"/>
<derivation value="constraint"/>
<snapshot>
<element id="Requirements">
<path value="Requirements"/>
<short
value="A set of requirements - features of systems that are necessary"/>
<definition
value="A set of requirements - a list of features or behaviors of designed systems that are necessary to achieve organizational or regulatory goals."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Requirements"/>
<min value="0"/>
<max value="*"/>
</base>
<constraint>
<key value="cnl-0"/>
<severity value="warning"/>
<human
value="Name should be usable as an identifier for the module by machine processing applications such as code generation"/>
<expression
value="name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')"/>
<source value="http://hl7.org/fhir/StructureDefinition/Requirements"/>
</constraint>
<constraint>
<key value="FMHC002"/>
<severity value="warning"/>
<human value="The header should have a name."/>
<expression value="title"/>
</constraint>
<constraint>
<key value="FMHC004"/>
<severity value="error"/>
<human value="Header must have a statement about its purpose."/>
<expression value="purpose"/>
</constraint>
<constraint>
<key value="FMHC005"/>
<severity value="warning"/>
<human value="Header purpose statement must end in a period."/>
<expression value="purpose.endsWith('.')"/>
</constraint>
<constraint>
<key value="FMHC006"/>
<severity value="error"/>
<human value="Header must have a description."/>
<expression value="description"/>
</constraint>
<constraint>
<key value="FMHC007"/>
<severity value="warning"/>
<human value="Header description statement must end in a period."/>
<expression value="description.endsWith('.')"/>
</constraint>
<constraint>
<key value="FMHC010"/>
<severity value="error"/>
<human value="A Header must not have criteria statements."/>
<expression value="statement.count() = 0"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="w5"/>
<map value="conformance.behavior,conformance.content"/>
</mapping>
<mapping>
<identity value="workflow"/>
<map value="Definition"/>
</mapping>
</element>
<element id="Requirements.id">
<path value="Requirements.id"/>
<short value="Logical id of this artifact"/>
<definition
value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/>
<comment
value="Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="id"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Requirements.meta">
<path value="Requirements.meta"/>
<short value="Metadata about the resource"/>
<definition
value="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."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.meta"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Meta"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Requirements.implicitRules">
<path value="Requirements.implicitRules"/>
<short value="A set of rules under which this content was created"/>
<definition
value="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."/>
<comment
value="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 its narrative along with other profiles, value sets, etc."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.implicitRules"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="true"/>
<isModifierReason
value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation"/>
<isSummary value="true"/>
</element>
<element id="Requirements.language">
<path value="Requirements.language"/>
<short value="Language of the resource content"/>
<definition
value="The base language in which the resource is written."/>
<comment
value="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)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Resource.language"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Language"/>
</extension>
<strength value="required"/>
<description value="IETF language tag for a human language"/>
<valueSet value="http://hl7.org/fhir/ValueSet/all-languages|5.0.0"/>
<additional>
<purpose value="starter"/>
<valueSet value="http://hl7.org/fhir/ValueSet/languages"/>
</additional>
</binding>
</element>
<element id="Requirements.text">
<path value="Requirements.text"/>
<short value="Text summary of the resource, for human interpretation"/>
<definition
value="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."/>
<comment
value="Contained resources do not have a 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."/>
<alias value="narrative"/>
<alias value="html"/>
<alias value="xhtml"/>
<alias value="display"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="DomainResource.text"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Narrative"/>
</type>
<condition value="dom-6"/>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="Act.text?"/>
</mapping>
</element>
<element id="Requirements.contained">
<path value="Requirements.contained"/>
<short value="Contained, inline Resources"/>
<definition
value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning."/>
<comment
value="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."/>
<alias value="inline resources"/>
<alias value="anonymous resources"/>
<alias value="contained resources"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="DomainResource.contained"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Resource"/>
</type>
<condition value="dom-2"/>
<condition value="dom-4"/>
<condition value="dom-3"/>
<condition value="dom-5"/>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Requirements.extension">
<path value="Requirements.extension"/>
<short value="Additional content defined by implementations"/>
<definition
value="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 managable, 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."/>
<comment
value="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."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="DomainResource.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Requirements.modifierExtension">
<path value="Requirements.modifierExtension"/>
<short value="Extensions that cannot be ignored"/>
<definition
value="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 managable, 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.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."/>
<comment
value="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."/>
<requirements
value="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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension)."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="DomainResource.modifierExtension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="true"/>
<isModifierReason
value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Requirements.url">
<path value="Requirements.url"/>
<short
value="Canonical identifier for this Requirements, represented as a URI (globally unique)"/>
<definition
value="An absolute URI that is used to identify this Requirements when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Requirements is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Requirements is stored on different servers."/>
<comment
value="Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.
The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](http://hl7.org/fhir/R5/resource.html#versions).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](http://hl7.org/fhir/R5/resource.html#meta) element to indicate where the current master source of the resource can be found."/>
<requirements
value="Allows the Requirements to be referenced by a single globally unique identifier."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Requirements.url"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="uri"/>
</type>
<constraint>
<key value="cnl-1"/>
<severity value="warning"/>
<human
value="URL should not contain | or # - these characters make processing canonical references problematic"/>
<expression value="exists() implies matches('^[^|# ]+$')"/>
<source value="http://hl7.org/fhir/StructureDefinition/Requirements"/>
</constraint>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Definition.url"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.identifier"/>
</mapping>
</element>
<element id="Requirements.identifier">
<path value="Requirements.identifier"/>
<short
value="Additional identifier for the Requirements (business identifier)"/>
<definition
value="A formal identifier that is used to identify this Requirements when it is represented in other formats, or referenced in a specification, model, design or an instance."/>
<requirements
value="Allows externally provided and/or usable business identifiers to be easily associated with the module."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Requirements.identifier"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Identifier"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Definition.identifier"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.identifier"/>
</mapping>
</element>
<element id="Requirements.version">
<path value="Requirements.version"/>
<short value="Business version of the Requirements"/>
<definition
value="The identifier that is used to identify this version of the Requirements when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Requirements author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence."/>
<comment
value="There may be different Requirements instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the Requirements with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](http://hl7.org/fhir/R5/resource.html#bv-format)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Requirements.version"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Definition.version"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.version"/>
</mapping>
</element>
<element id="Requirements.versionAlgorithm[x]">
<path value="Requirements.versionAlgorithm[x]"/>
<short value="How to compare versions"/>
<definition
value="Indicates the mechanism used to compare versions to determine which is more current."/>
<comment
value="If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Requirements.versionAlgorithm[x]"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<type>
<code value="Coding"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<strength value="extensible"/>
<valueSet value="http://hl7.org/fhir/ValueSet/version-algorithm"/>
</binding>
<mapping>
<identity value="workflow"/>
<map value="Definition.versionAlgorithm"/>
</mapping>
</element>
<element id="Requirements.name">
<path value="Requirements.name"/>
<short value="Name for this Requirements (computer friendly)"/>
<definition
value="A natural language name identifying the Requirements. This name should be usable as an identifier for the module by machine processing applications such as code generation."/>
<comment
value="The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly."/>
<requirements value="Support human navigation and code generation."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Requirements.name"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<condition value="cnl-0"/>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Definition.name"/>
</mapping>
</element>
<element id="Requirements.title">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<path value="Requirements.title"/>
<short value="Name for this Requirements (human friendly)"/>
<definition
value="A short, descriptive, user-friendly title for the Requirements."/>
<comment
value="This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Requirements.title"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Definition.title"/>
</mapping>
</element>
<element id="Requirements.status">
<path value="Requirements.status"/>
<short value="draft | active | retired | unknown"/>
<definition
value="The status of this Requirements. Enables tracking the life-cycle of the content."/>
<comment
value="Allows filtering of Requirements that are appropriate for use versus not.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization)."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Requirements.status"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="true"/>
<isModifierReason
value="This is labeled as "Is Modifier" because designs and applications should not use a retired Requirements without due consideration"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="PublicationStatus"/>
</extension>
<strength value="required"/>
<description value="The lifecycle status of an artifact."/>
<valueSet
value="http://hl7.org/fhir/ValueSet/publication-status|5.0.0"/>
</binding>
<mapping>
<identity value="workflow"/>
<map value="Definition.status"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.status"/>
</mapping>
</element>
<element id="Requirements.experimental">
<path value="Requirements.experimental"/>
<short value="For testing purposes, not real usage"/>
<definition
value="A Boolean value to indicate that this Requirements is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage."/>
<comment
value="Allows filtering of Requirements that are appropriate for use versus not."/>
<requirements
value="Enables experimental content to be developed following the same lifecycle that would be used for a production-level Requirements."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Requirements.experimental"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="boolean"/>
</type>
<meaningWhenMissing
value="If absent, this resource is treated as though it is not experimental."/>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Definition.experimental"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.class"/>
</mapping>
</element>
<element id="Requirements.date">
<path value="Requirements.date"/>
<short value="Date last changed"/>
<definition
value="The date (and optionally time) when the Requirements was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the Requirements changes."/>
<comment
value="Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the Requirements. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization)."/>
<alias value="Revision Date"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Requirements.date"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="dateTime"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Definition.date"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.recorded"/>
</mapping>
</element>
<element id="Requirements.publisher">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<path value="Requirements.publisher"/>
<short
value="Name of the publisher/steward (organization or individual)"/>
<definition
value="The name of the organization or individual responsible for the release and ongoing maintenance of the Requirements."/>
<comment
value="Usually an organization but may be an individual. The publisher (or steward) of the Requirements is the organization or individual primarily responsible for the maintenance and upkeep of the Requirements. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the Requirements. This item SHOULD be populated unless the information is available from context."/>
<requirements
value="Helps establish the "authority/credibility" of the Requirements. May also allow for contact."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Requirements.publisher"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Definition.publisher"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.witness"/>
</mapping>
</element>
<element id="Requirements.contact">
<path value="Requirements.contact"/>
<short value="Contact details for the publisher"/>
<definition
value="Contact details to assist a user in finding and communicating with the publisher."/>
<comment
value="May be a web site, an email address, a telephone number, etc.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization)."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Requirements.contact"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="ContactDetail"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Definition.contact"/>
</mapping>
</element>
<element id="Requirements.description">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<path value="Requirements.description"/>
<short value="Natural language description of the requirements"/>
<definition
value="A free text natural language description of the requirements."/>
<comment
value="This description can be used for a general description of the requirements, and which covers why it was defined."/>
<alias value="Scope"/>
<alias value="Purpose"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Requirements.description"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="markdown"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="workflow"/>
<map value="Definition.description"/>
</mapping>
</element>
<element id="Requirements.useContext">
<path value="Requirements.useContext"/>
<short value="The context that the content is intended to support"/>
<definition
value="The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Requirements instances."/>
<comment
value="When multiple useContexts are specified, there is no expectation that all or any of the contexts apply."/>
<requirements value="Assist in searching for appropriate content."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Requirements.useContext"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="UsageContext"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Definition.useContext"/>
</mapping>
</element>
<element id="Requirements.jurisdiction">
<path value="Requirements.jurisdiction"/>
<short value="Intended jurisdiction for Requirements (if applicable)"/>
<definition
value="A legal or geographic region in which the Requirements is intended to be used."/>
<comment
value="It may be possible for the Requirements to be used in jurisdictions other than those for which it was originally designed or intended
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Requirements.jurisdiction"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="CodeableConcept"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Jurisdiction"/>
</extension>
<strength value="extensible"/>
<description
value="Countries and regions within which this artifact is targeted for use."/>
<valueSet value="http://hl7.org/fhir/ValueSet/jurisdiction"/>
</binding>
<mapping>
<identity value="workflow"/>
<map value="Definition.jurisdiction"/>
</mapping>
</element>
<element id="Requirements.purpose">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<path value="Requirements.purpose"/>
<short value="Why this Requirements is defined"/>
<definition
value="Explanation of why this Requirements is needed and why it has been designed as it has."/>
<comment
value="This element does not describe the usage of the Requirements. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this Requirements."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Requirements.purpose"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="markdown"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="workflow"/>
<map value="Definition.purpose"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.why[x]"/>
</mapping>
</element>
<element id="Requirements.copyright">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<path value="Requirements.copyright"/>
<short value="Use and/or publishing restrictions"/>
<definition
value="A copyright statement relating to the Requirements and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the Requirements."/>
<comment value="..."/>
<requirements
value="Consumers must be able to determine any legal restrictions on the use of the Requirements."/>
<alias value="License"/>
<alias value="Restrictions"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Requirements.copyright"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="markdown"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="workflow"/>
<map value="Definition.copyright"/>
</mapping>
</element>
<element id="Requirements.copyrightLabel">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<path value="Requirements.copyrightLabel"/>
<short value="Copyright holder and year(s)"/>
<definition
value="A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved')."/>
<comment
value="The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element."/>
<requirements
value="Defines the content expected to be rendered in all representations of the artifact."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Requirements.copyrightLabel"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="workflow"/>
<map value="Definition.copyrightLabel"/>
</mapping>
</element>
<element id="Requirements.derivedFrom">
<path value="Requirements.derivedFrom"/>
<short value="Other set of Requirements this builds on"/>
<definition
value="Another set of Requirements that this set of Requirements builds on and updates."/>
<comment
value="Existing statements (by key) may be narrowed or clarified, and additional statements added."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Requirements.derivedFrom"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="canonical"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Requirements"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Definition.derivedFromCanonical"/>
</mapping>
</element>
<element id="Requirements.reference">
<path value="Requirements.reference"/>
<short
value="External artifact (rule/document etc. that) created this set of requirements"/>
<definition
value="A reference to another artifact that created this set of requirements. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Requirements.reference"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="url"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Requirements.actor">
<path value="Requirements.actor"/>
<short value="Actor for these requirements"/>
<definition value="An actor these requirements are in regard to."/>
<comment
value="If more than one actor is specified, then it's up to the statements to describe in narrative if they don't apply to all actors."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Requirements.actor"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="canonical"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/ActorDefinition"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="w5"/>
<map value="FiveWs.who"/>
</mapping>
</element>
<element id="Requirements.statement">
<path value="Requirements.statement"/>
<short value="Actual statement as markdown"/>
<definition
value="The actual statement of requirement, in markdown format."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Requirements.statement"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="BackboneElement"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Requirements.statement.id">
<path value="Requirements.statement.id"/>
<representation value="xmlAttr"/>
<short value="Unique id for inter-element referencing"/>
<definition
value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Element.id"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string"/>
</extension>
<code value="http://hl7.org/fhirpath/System.String"/>
</type>
<condition value="ele-1"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Requirements.statement.extension">
<path value="Requirements.statement.extension"/>
<short value="Additional content defined by implementations"/>
<definition
value="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 managable, 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."/>
<comment
value="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."/>
<alias value="extensions"/>
<alias value="user content"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Element.extension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Requirements.statement.modifierExtension">
<path value="Requirements.statement.modifierExtension"/>
<short value="Extensions that cannot be ignored even if unrecognized"/>
<definition
value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 managable, 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. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."/>
<comment
value="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."/>
<requirements
value="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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension)."/>
<alias value="extensions"/>
<alias value="user content"/>
<alias value="modifiers"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="BackboneElement.modifierExtension"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Extension"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<constraint>
<key value="ext-1"/>
<severity value="error"/>
<human value="Must have either extensions or value[x], not both"/>
<expression value="extension.exists() != value.exists()"/>
<source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
</constraint>
<isModifier value="true"/>
<isModifierReason
value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Requirements.statement.key">
<path value="Requirements.statement.key"/>
<short value="Key that identifies this statement"/>
<definition
value="Key that identifies this statement (unique within this resource)."/>
<comment value="Refer directly to the statement by {url}#{key}"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Requirements.statement.key"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="id"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Requirements.statement.label">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<path value="Requirements.statement.label"/>
<short value="Short Human label for this statement"/>
<definition value="A short human usable label for this statement."/>
<comment
value="The key is intended for computers, while this is intended for humans. In its absence, the key should be convenient for a human to say (e.g. not a UUID)"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Requirements.statement.label"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Requirements.statement.conformance">
<path value="Requirements.statement.conformance"/>
<short value="SHALL | SHOULD | MAY | SHOULD-NOT"/>
<definition value="A short human usable label for this statement."/>
<comment
value="The conformance code is extracted from the requirement to make indexing and display easier. The requirement needs to express the conformance verbs directly in the markdown content. It's not unusual to mix verbs in a single sentence (e.g. System SHALL do X and SHOULD do Y)"/>
<requirements
value="This element is allowed to repeat because a single requirements statement might contain multiple conformance words and thus need to be indexed under multiple conformance categories."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Requirements.statement.conformance"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="code"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="??"/>
</extension>
<strength value="required"/>
<valueSet
value="http://hl7.org/fhir/ValueSet/conformance-expectation|5.0.0"/>
</binding>
</element>
<element id="Requirements.statement.conditionality">
<path value="Requirements.statement.conditionality"/>
<short value="Set to true if requirements statement is conditional"/>
<definition
value="This boolean flag is set to true of the text of the requirement is conditional on something e.g. it includes lanauage like 'if x then y'. This conditionality flag is introduced for purposes of filtering and colour highlighting etc."/>
<comment
value="There is no intent that the conditional statement by evaluatable"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Requirements.statement.conditionality"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="boolean"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Requirements.statement.requirement">
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true"/>
</extension>
<path value="Requirements.statement.requirement"/>
<short value="The actual requirement"/>
<definition value="The actual requirement for human consumption."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Requirements.statement.requirement"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="markdown"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Requirements.statement.derivedFrom">
<path value="Requirements.statement.derivedFrom"/>
<short value="Another statement this clarifies/restricts ([url#]key)"/>
<definition
value="Another statement on one of the requirements that this requirement clarifies or restricts."/>
<comment
value="This can be just a key, if there is only one matching statement in the requirements statements referenced in Requirements.derivedFrom. If there is more than one, it should be in the format ```url#key```"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Requirements.statement.derivedFrom"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Requirements.statement.parent">
<path value="Requirements.statement.parent"/>
<short
value="A larger requirement that this requirement helps to refine and enable"/>
<definition
value="A larger requirement that this requirement helps to refine and enable."/>
<comment
value="Follows the same convention as statement.derivedFrom, where a reference is the canonical of the Requirements followed by '#' and the 'key' of the specific requirement."/>
<requirements
value="Allows requirements to be organized compositionally. E.g. Epic/Story/Task."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Requirements.statement.parent"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Requirements.statement.satisfiedBy">
<path value="Requirements.statement.satisfiedBy"/>
<short value="Design artifact that satisfies this requirement"/>
<definition
value="A reference to another artifact that satisfies this requirement. This could be a Profile, extension, or an element in one of those, or a CapabilityStatement, OperationDefinition, SearchParameter, CodeSystem(/code), ValueSet, Libary etc."/>
<comment
value="This is for use when the requirement is met be a pre-existing artifact e.g. a rule that's met by the base FHIR spec, or a national implementation guide."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Requirements.statement.satisfiedBy"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="url"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Requirements.statement.reference">
<path value="Requirements.statement.reference"/>
<short
value="External artifact (rule/document etc. that) created this requirement"/>
<definition
value="A reference to another artifact that created this requirement. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Requirements.statement.reference"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="url"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
</element>
<element id="Requirements.statement.source">
<path value="Requirements.statement.source"/>
<short value="Who asked for this statement"/>
<definition
value="Who asked for this statement to be a requirement. By default, it's assumed that the publisher knows who it is if it matters."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Requirements.statement.source"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/CareTeam"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Device"/>
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Group"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/HealthcareService"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Organization"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Patient"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Practitioner"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/PractitionerRole"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<mustSupport value="false"/>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="w5"/>
<map value="FiveWs.source"/>
</mapping>
</element>
</snapshot>
<differential>
<element id="Requirements">
<path value="Requirements"/>
<constraint>
<key value="FMHC002"/>
<severity value="warning"/>
<human value="The header should have a name."/>
<expression value="title"/>
</constraint>
<constraint>
<key value="FMHC004"/>
<severity value="error"/>
<human value="Header must have a statement about its purpose."/>
<expression value="purpose"/>
</constraint>
<constraint>
<key value="FMHC005"/>
<severity value="warning"/>
<human value="Header purpose statement must end in a period."/>
<expression value="purpose.endsWith('.')"/>
</constraint>
<constraint>
<key value="FMHC006"/>
<severity value="error"/>
<human value="Header must have a description."/>
<expression value="description"/>
</constraint>
<constraint>
<key value="FMHC007"/>
<severity value="warning"/>
<human value="Header description statement must end in a period."/>
<expression value="description.endsWith('.')"/>
</constraint>
<constraint>
<key value="FMHC010"/>
<severity value="error"/>
<human value="A Header must not have criteria statements."/>
<expression value="statement.count() = 0"/>
</constraint>
</element>
</differential>
</StructureDefinition>