WHO Antenatal Care Guideline Implementation Guide
0.3.0 - CI Build
WHO Antenatal Care Guideline Implementation Guide
0.3.0 - CI Build
WHO Antenatal Care Guideline Implementation Guide, published by World Health Organization (WHO). This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/costateixeira/smart-anc/ and changes regularly. See the Directory of published versions
| Draft as of 2024-09-10 |
XML representation of the who-appointment resource profile.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="who-appointment"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureDefinition who-appointment</b></p><a name="who-appointment"> </a><a name="hcwho-appointment"> </a><a name="who-appointment-en-US"> </a><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 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-who-appointment-definitions.html#Appointment">Appointment</a><a name="Appointment"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><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/R4/appointment.html">Appointment</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 booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)</span></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://fhir.org/guides/who/core/StructureDefinition/who-appointment"/>
<version value="0.3.0"/>
<name value="WHOAppointment"/>
<title value="WHO Appointment"/>
<status value="draft"/>
<experimental value="false"/>
<date value="2024-09-10T04:55:21+00:00"/>
<publisher value="World Health Organization (WHO)"/>
<contact>
<telecom>
<system value="url"/>
<value value="https://www.who.int"/>
</telecom>
</contact>
<description value="WHO Appointment"/>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
</coding>
</jurisdiction>
<fhirVersion value="4.0.1"/>
<mapping>
<identity value="workflow"/>
<uri value="http://hl7.org/fhir/workflow"/>
<name value="Workflow Pattern"/>
</mapping>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<mapping>
<identity value="ical"/>
<uri value="http://ietf.org/rfc/2445"/>
<name value="iCalendar"/>
</mapping>
<mapping>
<identity value="w5"/>
<uri value="http://hl7.org/fhir/fivews"/>
<name value="FiveWs Pattern Mapping"/>
</mapping>
<mapping>
<identity value="v2"/>
<uri value="http://hl7.org/v2"/>
<name value="HL7 v2 Mapping"/>
</mapping>
<kind value="resource"/>
<abstract value="false"/>
<type value="Appointment"/>
<baseDefinition
value="http://hl7.org/fhir/StructureDefinition/Appointment"/>
<derivation value="constraint"/>
<snapshot>
<element id="Appointment">
<path value="Appointment"/>
<short
value="A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)"/>
<definition
value="A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Appointment"/>
<min value="0"/>
<max value="*"/>
</base>
<constraint>
<key value="app-2"/>
<severity value="error"/>
<human value="Either start and end are specified, or neither"/>
<expression value="start.exists() = end.exists()"/>
<xpath
value="((exists(f:start) and exists(f:end)) or (not(exists(f:start)) and not(exists(f:end))))"/>
<source value="http://hl7.org/fhir/StructureDefinition/Appointment"/>
</constraint>
<constraint>
<key value="app-3"/>
<severity value="error"/>
<human
value="Only proposed or cancelled appointments can be missing start/end dates"/>
<expression
value="(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))"/>
<xpath
value="((exists(f:start) and exists(f:end)) or (f:status/@value='proposed') or (f:status/@value='cancelled') or (f:status/@value='waitlist'))"/>
<source value="http://hl7.org/fhir/StructureDefinition/Appointment"/>
</constraint>
<constraint>
<key value="app-4"/>
<severity value="error"/>
<human
value="Cancelation reason is only used for appointments that have been cancelled, or no-show"/>
<expression
value="Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')"/>
<xpath
value="not(exists(f:cancellationReason)) or f:status/@value=('no-show', 'cancelled')"/>
<source value="http://hl7.org/fhir/StructureDefinition/Appointment"/>
</constraint>
<constraint>
<key value="dom-2"/>
<severity value="error"/>
<human
value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/>
<expression value="contained.contained.empty()"/>
<xpath value="not(parent::f:contained and f:contained)"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<constraint>
<key value="dom-3"/>
<severity value="error"/>
<human
value="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"/>
<expression
value="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()"/>
<xpath
value="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
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<constraint>
<key value="dom-4"/>
<severity value="error"/>
<human
value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/>
<expression
value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/>
<xpath
value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<constraint>
<key value="dom-5"/>
<severity value="error"/>
<human
value="If a resource is contained in another resource, it SHALL NOT have a security label"/>
<expression value="contained.meta.security.empty()"/>
<xpath value="not(exists(f:contained/*/f:meta/f:security))"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<constraint>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice">
<valueBoolean value="true"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation">
<valueMarkdown
value="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."/>
</extension>
<key value="dom-6"/>
<severity value="warning"/>
<human
value="A resource should have narrative for robust management"/>
<expression value="text.`div`.exists()"/>
<xpath value="exists(f:text/h:div)"/>
<source
value="http://hl7.org/fhir/StructureDefinition/DomainResource"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="Entity. Role, or Act"/>
</mapping>
<mapping>
<identity value="workflow"/>
<map value="Request"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="Act[@moodCode <= 'INT']"/>
</mapping>
<mapping>
<identity value="ical"/>
<map value="VEVENT"/>
</mapping>
</element>
<element id="Appointment.id">
<path value="Appointment.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="The only time that a resource does not have an id is when it is being submitted to the server using a create operation."/>
<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>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Appointment.meta">
<path value="Appointment.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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
</element>
<element id="Appointment.implicitRules">
<path value="Appointment.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 it's 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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<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 it's meaning or interpretation"/>
<isSummary value="true"/>
</element>
<element id="Appointment.language">
<path value="Appointment.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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
<valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Language"/>
</extension>
<strength value="preferred"/>
<description value="A human language."/>
<valueSet value="http://hl7.org/fhir/ValueSet/languages"/>
</binding>
</element>
<element id="Appointment.text">
<path value="Appointment.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 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>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="Act.text?"/>
</mapping>
</element>
<element id="Appointment.contained">
<path value="Appointment.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, and nor can they have their own independent transaction scope."/>
<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>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Appointment.extension">
<path value="Appointment.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 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."/>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<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()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<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="Appointment.modifierExtension">
<path value="Appointment.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 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.
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/R4/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())"/>
<xpath value="@value|f:*|h:div"/>
<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()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<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 resource that contains them"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="N/A"/>
</mapping>
</element>
<element id="Appointment.identifier">
<path value="Appointment.identifier"/>
<short value="External Ids for this item"/>
<definition
value="This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Appointment.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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Request.identifier"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.identifier"/>
</mapping>
<mapping>
<identity value="v2"/>
<map value="SCH-1, SCH-2, ARQ-1, ARQ-2"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".id"/>
</mapping>
<mapping>
<identity value="ical"/>
<map value="UID"/>
</mapping>
</element>
<element id="Appointment.status">
<path value="Appointment.status"/>
<short
value="proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist"/>
<definition
value="The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status."/>
<comment
value="If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE.
This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Appointment.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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="true"/>
<isModifierReason
value="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 value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="AppointmentStatus"/>
</extension>
<strength value="required"/>
<description value="The free/busy status of an appointment."/>
<valueSet
value="http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1"/>
</binding>
<mapping>
<identity value="workflow"/>
<map value="Request.status"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.status"/>
</mapping>
<mapping>
<identity value="v2"/>
<map value="SCH-25"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".statusCode"/>
</mapping>
<mapping>
<identity value="ical"/>
<map value="STATUS"/>
</mapping>
</element>
<element id="Appointment.cancelationReason">
<path value="Appointment.cancelationReason"/>
<short value="The coded reason for the appointment being cancelled"/>
<definition
value="The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Appointment.cancelationReason"/>
<min value="0"/>
<max value="1"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="cancelation-reason"/>
</extension>
<strength value="example"/>
<valueSet
value="http://hl7.org/fhir/ValueSet/appointment-cancellation-reason"/>
</binding>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Appointment.serviceCategory">
<path value="Appointment.serviceCategory"/>
<short
value="A broad categorization of the service that is to be performed during this appointment"/>
<definition
value="A broad categorization of the service that is to be performed during this appointment."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Appointment.serviceCategory"/>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="service-category"/>
</extension>
<strength value="example"/>
<valueSet value="http://hl7.org/fhir/ValueSet/service-category"/>
</binding>
<mapping>
<identity value="rim"/>
<map value="n/a, might be inferred from the ServiceDeliveryLocation"/>
</mapping>
<mapping>
<identity value="ical"/>
<map value="CATEGORIES"/>
</mapping>
</element>
<element id="Appointment.serviceType">
<path value="Appointment.serviceType"/>
<short
value="The specific service that is to be performed during this appointment"/>
<definition
value="The specific service that is to be performed during this appointment."/>
<comment
value="For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Appointment.serviceType"/>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="service-type"/>
</extension>
<strength value="example"/>
<valueSet value="http://hl7.org/fhir/ValueSet/service-type"/>
</binding>
<mapping>
<identity value="workflow"/>
<map value="Request.code"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="n/a, might be inferred from the ServiceDeliveryLocation"/>
</mapping>
</element>
<element id="Appointment.specialty">
<path value="Appointment.specialty"/>
<short
value="The specialty of a practitioner that would be required to perform the service requested in this appointment"/>
<definition
value="The specialty of a practitioner that would be required to perform the service requested in this appointment."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Appointment.specialty"/>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="specialty"/>
</extension>
<strength value="preferred"/>
<valueSet value="http://hl7.org/fhir/ValueSet/c80-practice-codes"/>
</binding>
<mapping>
<identity value="w5"/>
<map value="FiveWs.class"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".performer.AssignedPerson.code"/>
</mapping>
</element>
<element id="Appointment.appointmentType">
<path value="Appointment.appointmentType"/>
<short
value="The style of appointment or patient that has been booked in the slot (not service type)"/>
<definition
value="The style of appointment or patient that has been booked in the slot (not service type)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Appointment.appointmentType"/>
<min value="0"/>
<max value="1"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="appointment-type"/>
</extension>
<strength value="preferred"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v2-0276"/>
</binding>
<mapping>
<identity value="v2"/>
<map value="ARQ-7"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".code"/>
</mapping>
<mapping>
<identity value="ical"/>
<map value="CLASSIFICATION"/>
</mapping>
</element>
<element id="Appointment.reasonCode">
<path value="Appointment.reasonCode"/>
<short value="Coded reason this appointment is scheduled"/>
<definition
value="The coded reason that this appointment is being scheduled. This is more clinical than administrative."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Appointment.reasonCode"/>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="ApptReason"/>
</extension>
<strength value="preferred"/>
<description value="The Reason for the appointment to take place."/>
<valueSet value="http://hl7.org/fhir/ValueSet/encounter-reason"/>
</binding>
<mapping>
<identity value="workflow"/>
<map value="Request.reasonCode"/>
</mapping>
<mapping>
<identity value="v2"/>
<map value="AIS-3, SCH-7"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".reasonCode"/>
</mapping>
</element>
<element id="Appointment.reasonReference">
<path value="Appointment.reasonReference"/>
<short value="Reason the appointment is to take place (resource)"/>
<definition
value="Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Appointment.reasonReference"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Condition"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Procedure"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Observation"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="workflow"/>
<map value="Request.reasonReference"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".inboundRelationship[@typeCode = 'RSON'].observation"/>
</mapping>
</element>
<element id="Appointment.priority">
<path value="Appointment.priority"/>
<short
value="Used to make informed decisions if needing to re-prioritize"/>
<definition
value="The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority)."/>
<comment
value="Seeking implementer feedback on this property and how interoperable it is.
Using an extension to record a CodeableConcept for named values may be tested at a future connectathon."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Appointment.priority"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="unsignedInt"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="workflow"/>
<map value="Request.priority"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.class"/>
</mapping>
<mapping>
<identity value="v2"/>
<map value="ARQ-12, SCH-11.6 / TQ1-9"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".priorityCode"/>
</mapping>
<mapping>
<identity value="ical"/>
<map value="PRIORITY"/>
</mapping>
</element>
<element id="Appointment.description">
<path value="Appointment.description"/>
<short
value="Shown on a subject line in a meeting request, or appointment list"/>
<definition
value="The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Appointment.description"/>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="v2"/>
<map value="NTE-3"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".text"/>
</mapping>
<mapping>
<identity value="ical"/>
<map value="SUMMARY"/>
</mapping>
</element>
<element id="Appointment.supportingInformation">
<path value="Appointment.supportingInformation"/>
<short value="Additional information to support the appointment"/>
<definition
value="Additional information to support the appointment provided when making the appointment."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Appointment.supportingInformation"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Resource"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="workflow"/>
<map value="Request.supportingInfo"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.context"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".inboundRelationship[@typeCode = 'SPRT'].observation"/>
</mapping>
<mapping>
<identity value="ical"/>
<map value="ATTACH"/>
</mapping>
</element>
<element id="Appointment.start">
<path value="Appointment.start"/>
<short value="When appointment is to take place"/>
<definition value="Date/Time that the appointment is to take place."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Appointment.start"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="instant"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Request.occurrence[x]"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.init"/>
</mapping>
<mapping>
<identity value="v2"/>
<map value="ARQ-11.1, SCH-11.4 / TQ1-7"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".effectiveTime.low"/>
</mapping>
<mapping>
<identity value="ical"/>
<map value="DTSTART"/>
</mapping>
</element>
<element id="Appointment.end">
<path value="Appointment.end"/>
<short value="When appointment is to conclude"/>
<definition value="Date/Time that the appointment is to conclude."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Appointment.end"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="instant"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="workflow"/>
<map value="Request.occurrence[x]"/>
</mapping>
<mapping>
<identity value="w5"/>
<map value="FiveWs.done[x]"/>
</mapping>
<mapping>
<identity value="v2"/>
<map
value="SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".effectiveTime.high"/>
</mapping>
<mapping>
<identity value="ical"/>
<map value="DTEND"/>
</mapping>
</element>
<element id="Appointment.minutesDuration">
<path value="Appointment.minutesDuration"/>
<short value="Can be less than start/end (e.g. estimate)"/>
<definition
value="Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Appointment.minutesDuration"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="positiveInt"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="workflow"/>
<map value="Request.occurrence[x]"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width"/>
</mapping>
<mapping>
<identity value="ical"/>
<map value="DURATION (e.g. PT15M)"/>
</mapping>
</element>
<element id="Appointment.slot">
<path value="Appointment.slot"/>
<short value="The slots that this appointment is filling"/>
<definition
value="The slots from the participants' schedules that will be filled by the appointment."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Appointment.slot"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Reference"/>
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Slot"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map
value=".outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']"/>
</mapping>
</element>
<element id="Appointment.created">
<path value="Appointment.created"/>
<short value="The date that this appointment was initially created"/>
<definition
value="The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment."/>
<comment
value="This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Appointment.created"/>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="workflow"/>
<map value="Request.authoredOn"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".author.time"/>
</mapping>
<mapping>
<identity value="ical"/>
<map value="CREATED"/>
</mapping>
</element>
<element id="Appointment.comment">
<path value="Appointment.comment"/>
<short value="Additional comments"/>
<definition value="Additional comments about the appointment."/>
<comment
value="Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival"
Where this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Appointment.comment"/>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="workflow"/>
<map value="Request.note"/>
</mapping>
<mapping>
<identity value="v2"/>
<map value="NTE-3"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value=".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value"/>
</mapping>
<mapping>
<identity value="ical"/>
<map value="DESCRIPTION (for internal use)"/>
</mapping>
</element>
<element id="Appointment.patientInstruction">
<path value="Appointment.patientInstruction"/>
<short value="Detailed information and instructions for the patient"/>
<definition
value="While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before)."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Appointment.patientInstruction"/>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="v2"/>
<map value="NTE-3"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value=".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value"/>
</mapping>
<mapping>
<identity value="ical"/>
<map value="DESCRIPTION (for patient use)"/>
</mapping>
</element>
<element id="Appointment.basedOn">
<path value="Appointment.basedOn"/>
<short
value="The service request this appointment is allocated to assess"/>
<definition
value="The service request this appointment is allocated to assess (e.g. incoming referral or procedure request)."/>
<alias value="incomingReferral"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Appointment.basedOn"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Reference"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/ServiceRequest"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="workflow"/>
<map value="Request.basedOn"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value=".outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']"/>
</mapping>
</element>
<element id="Appointment.participant">
<path value="Appointment.participant"/>
<short value="Participants involved in appointment"/>
<definition value="List of participants involved in the appointment."/>
<min value="1"/>
<max value="*"/>
<base>
<path value="Appointment.participant"/>
<min value="1"/>
<max value="*"/>
</base>
<type>
<code value="BackboneElement"/>
</type>
<constraint>
<key value="app-1"/>
<severity value="error"/>
<human
value="Either the type or actor on the participant SHALL be specified"/>
<expression value="type.exists() or actor.exists()"/>
<xpath value="(exists(f:type) or exists(f:actor))"/>
<source value="http://hl7.org/fhir/StructureDefinition/Appointment"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="workflow"/>
<map value="Request.performer, Request.subject"/>
</mapping>
<mapping>
<identity value="v2"/>
<map value="PID, AIP, AIG, AIL"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value="performer | reusableDevice | subject | location"/>
</mapping>
<mapping>
<identity value="ical"/>
<map value="ATTENDEE component to be created"/>
</mapping>
</element>
<element id="Appointment.participant.id">
<path value="Appointment.participant.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>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Appointment.participant.extension">
<path value="Appointment.participant.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 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."/>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<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()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<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="Appointment.participant.modifierExtension">
<path value="Appointment.participant.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 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. 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/R4/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())"/>
<xpath value="@value|f:*|h:div"/>
<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()"/>
<xpath
value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])"/>
<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="Appointment.participant.type">
<path value="Appointment.participant.type"/>
<short value="Role of participant in the appointment"/>
<definition value="Role of participant in the appointment."/>
<comment
value="The role of the participant can be used to declare what the actor will be doing in the scope of this appointment.
If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.
This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Appointment.participant.type"/>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="ParticipantType"/>
</extension>
<strength value="extensible"/>
<description value="Role of participant in encounter."/>
<valueSet
value="http://hl7.org/fhir/ValueSet/encounter-participant-type"/>
</binding>
<mapping>
<identity value="v2"/>
<map value="AIP-4, AIG-4"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value="(performer | reusableDevice | subject | location).@typeCode"/>
</mapping>
<mapping>
<identity value="ical"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Appointment.participant.actor">
<path value="Appointment.participant.actor"/>
<short value="Person, Location/HealthcareService or Device"/>
<definition
value="A Person, Location/HealthcareService or Device that is participating in the appointment."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Appointment.participant.actor"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Reference"/>
<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"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Device"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/HealthcareService"/>
<targetProfile
value="http://hl7.org/fhir/StructureDefinition/Location"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="w5"/>
<map value="FiveWs.who"/>
</mapping>
<mapping>
<identity value="v2"/>
<map value="PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value="performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation"/>
</mapping>
<mapping>
<identity value="ical"/>
<map
value="ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only""/>
</mapping>
</element>
<element id="Appointment.participant.required">
<path value="Appointment.participant.required"/>
<short value="required | optional | information-only"/>
<definition
value="Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Appointment.participant.required"/>
<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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="ParticipantRequired"/>
</extension>
<strength value="required"/>
<description
value="Is the Participant required to attend the appointment."/>
<valueSet
value="http://hl7.org/fhir/ValueSet/participantrequired|4.0.1"/>
</binding>
<mapping>
<identity value="rim"/>
<map
value="(performer | reusableDevice | subject | location).@performInd"/>
</mapping>
<mapping>
<identity value="ical"/>
<map value="ROLE=REQ-PARTICIPANT (roleparam)"/>
</mapping>
</element>
<element id="Appointment.participant.status">
<path value="Appointment.participant.status"/>
<short value="accepted | declined | tentative | needs-action"/>
<definition value="Participation status of the actor."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="Appointment.participant.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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<binding>
<extension
url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="ParticipationStatus"/>
</extension>
<strength value="required"/>
<description value="The Participation status of an appointment."/>
<valueSet
value="http://hl7.org/fhir/ValueSet/participationstatus|4.0.1"/>
</binding>
<mapping>
<identity value="v2"/>
<map value="AIP-12, AIG-14"/>
</mapping>
<mapping>
<identity value="rim"/>
<map
value="(performer | reusableDevice | subject | location).statusCode"/>
</mapping>
<mapping>
<identity value="ical"/>
<map
value="ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)"/>
</mapping>
</element>
<element id="Appointment.participant.period">
<path value="Appointment.participant.period"/>
<short value="Participation period of the actor"/>
<definition value="Participation period of the actor."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="Appointment.participant.period"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="Period"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="Appointment.requestedPeriod">
<path value="Appointment.requestedPeriod"/>
<short
value="Potential date/time interval(s) requested to allocate the appointment within"/>
<definition
value="A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.
The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system."/>
<comment
value="This does not introduce a capacity for recurring appointments."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Appointment.requestedPeriod"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Period"/>
</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())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="workflow"/>
<map value="Request.occurrence[x]"/>
</mapping>
<mapping>
<identity value="v2"/>
<map value="ARQ-11"/>
</mapping>
<mapping>
<identity value="rim"/>
<map value=".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]"/>
</mapping>
</element>
</snapshot>
<differential>
<element id="Appointment">
<path value="Appointment"/>
</element>
</differential>
</StructureDefinition>
IG © 2019+ World Health Organization (WHO). Package who.fhir.anc-cds#0.3.0 based on FHIR 4.0.1. Generated 2024-09-10
Links: Table of Contents |
QA Report
| Version History 
|