Schedule.profile.xml

StructureDefinition for schedule

Raw XML

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Schedule"/>
  <meta>
    <lastUpdated value="2015-03-27T00:13:00.999+11:00"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/StructureDefinition/Schedule"/>
  <name value="Schedule"/>
  <publisher value="HL7 FHIR Project (Patient Administration)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/pafm/index.cfm"/>
    </telecom>
  </contact>
  <description value="Base StructureDefinition for Schedule Resource"/>
  <status value="draft"/>
  <date value="2015-03-27T00:13:00+11:00"/>
  <mapping>
    <identity value="ical"/>
    <uri value="http://www.ietf.org/rfc/rfc2445.txt"/>
    <name value="iCalendar"/>
  </mapping>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <type value="resource"/>
  <abstract value="true"/>
  <snapshot>
    <element>
      <path value="Schedule"/>
      <short value="A container for slot(s) of time that may be available for booking appointments"/>
      <definition value="A container for slot(s) of time that may be available for booking appointments."/>
      <alias value="Availability"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Schedule"/>
      </type>
      <mapping>
        <identity value="ical"/>
        <map value="BEGIN:VFREEBUSY  ???  END:VFREEBUSY (If your fhir server provides this information via
         calDAV, then you may want to include addressing information in a URL section, and with
         the search, a DTSTART and DTEND component can be included to indicate the range of time
         that has been covered in the collection of slots, where these overlap the resources period
         values. For all slots that reference this resource, include a FREEBUSY row for each slot)"/>
      </mapping>
    </element>
    <element>
      <path value="Schedule.id"/>
      <short value="Logical id of this artefact"/>
      <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this
       value never changes."/>
      <comments 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. Bundles always have an id, though it is usually a generated
       UUID."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
    </element>
    <element>
      <path value="Schedule.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 may not always be associated with version changes to the resource."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Meta"/>
      </type>
    </element>
    <element>
      <path value="Schedule.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."/>
      <comments 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 as much as possible."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
      <isModifier value="true"/>
    </element>
    <element>
      <path value="Schedule.language"/>
      <short value="Language of the resource content"/>
      <definition value="The base language in which the resource is written."/>
      <comments 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"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="Language"/>
        <strength value="required"/>
        <description value="A human language"/>
        <valueSetUri value="http://tools.ietf.org/html/bcp47"/>
      </binding>
    </element>
    <element>
      <path value="Schedule.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 may 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 &quot;clinically
       safe&quot; for a human to just read the narrative. Resource definitions may define what
       content should be represented in the narrative to ensure clinical safety."/>
      <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have
       a narrative."/>
      <alias value="narrative"/>
      <alias value="html"/>
      <alias value="xhtml"/>
      <alias value="display"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Narrative"/>
      </type>
      <condition value="dom-1"/>
      <mapping>
        <identity value="rim"/>
        <map value="Act.text?"/>
      </mapping>
    </element>
    <element>
      <path value="Schedule.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."/>
      <comments 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."/>
      <alias value="inline resources"/>
      <alias value="anonymous resources"/>
      <alias value="contained resources"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Resource"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Schedule.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. In order 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."/>
      <comments 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="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Schedule.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.
       Usually modifier elements provide negation or qualification. In order 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."/>
      <comments 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="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Schedule.identifier"/>
      <short value="External Ids for this item"/>
      <definition value="External Ids for this item."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Identifier"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="ical"/>
        <map value="UID"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value=".id"/>
      </mapping>
    </element>
    <element>
      <path value="Schedule.type"/>
      <short value="The schedule type can be used for the categorization of healthcare services or other appointment
       types"/>
      <definition value="The schedule type can be used for the categorization of healthcare services or other appointment
       types."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <binding>
        <name value="DocumentC80PracticeSetting"/>
        <strength value="preferred"/>
        <description value="Additional details about where the content was created (e.g. clinical specialty)"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/c80-practice-codes"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="ical"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Schedule.actor"/>
      <short value="The resource this Schedule resource is providing availability information for. These are
       expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient
       or RelatedPerson"/>
      <definition value="The resource this Schedule resource is providing availability information for. These are
       expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient
       or RelatedPerson."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Resource"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="ical"/>
        <map value="ATTENDEE:MAILTO:john_public@host2.com This can be populated with a value from the referenced
         resource"/>
      </mapping>
    </element>
    <element>
      <path value="Schedule.planningHorizon"/>
      <short value="The period of time that the slots that are attached to this Schedule resource cover (even
       if none exist). These  cover the amount of time that an organization's planning horizon;
       the interval for which they are currently accepting appointments. This does not define
       a &quot;template&quot; for planning outside these dates"/>
      <definition value="The period of time that the slots that are attached to this Schedule resource cover (even
       if none exist). These  cover the amount of time that an organization's planning horizon;
       the interval for which they are currently accepting appointments. This does not define
       a &quot;template&quot; for planning outside these dates."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Period"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="ical"/>
        <map value="DTSTART:20131201T003000Z DTEND:2014030101T003000Z"/>
      </mapping>
    </element>
    <element>
      <path value="Schedule.comment"/>
      <short value="Comments on the availability to describe any extended information. Such as custom constraints
       on the slot(s) that may be associated"/>
      <definition value="Comments on the availability to describe any extended information. Such as custom constraints
       on the slot(s) that may be associated."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <mapping>
        <identity value="ical"/>
        <map value="COMMENT:(comment) If there is no comment, then the line can be excluded from the iCalendar
         entry"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="Schedule"/>
      <short value="A container for slot(s) of time that may be available for booking appointments"/>
      <definition value="A container for slot(s) of time that may be available for booking appointments."/>
      <alias value="Availability"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="DomainResource"/>
      </type>
      <mapping>
        <identity value="ical"/>
        <map value="BEGIN:VFREEBUSY  ???  END:VFREEBUSY (If your fhir server provides this information via
         calDAV, then you may want to include addressing information in a URL section, and with
         the search, a DTSTART and DTEND component can be included to indicate the range of time
         that has been covered in the collection of slots, where these overlap the resources period
         values. For all slots that reference this resource, include a FREEBUSY row for each slot)"/>
      </mapping>
    </element>
    <element>
      <path value="Schedule.identifier"/>
      <short value="External Ids for this item"/>
      <definition value="External Ids for this item."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Identifier"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="ical"/>
        <map value="UID"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value=".id"/>
      </mapping>
    </element>
    <element>
      <path value="Schedule.type"/>
      <short value="The schedule type can be used for the categorization of healthcare services or other appointment
       types"/>
      <definition value="The schedule type can be used for the categorization of healthcare services or other appointment
       types."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <binding>
        <name value="DocumentC80PracticeSetting"/>
        <strength value="preferred"/>
        <description value="Additional details about where the content was created (e.g. clinical specialty)"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/vs/c80-practice-codes"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="ical"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Schedule.actor"/>
      <short value="The resource this Schedule resource is providing availability information for. These are
       expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient
       or RelatedPerson"/>
      <definition value="The resource this Schedule resource is providing availability information for. These are
       expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient
       or RelatedPerson."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Resource"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="ical"/>
        <map value="ATTENDEE:MAILTO:john_public@host2.com This can be populated with a value from the referenced
         resource"/>
      </mapping>
    </element>
    <element>
      <path value="Schedule.planningHorizon"/>
      <short value="The period of time that the slots that are attached to this Schedule resource cover (even
       if none exist). These  cover the amount of time that an organization's planning horizon;
       the interval for which they are currently accepting appointments. This does not define
       a &quot;template&quot; for planning outside these dates"/>
      <definition value="The period of time that the slots that are attached to this Schedule resource cover (even
       if none exist). These  cover the amount of time that an organization's planning horizon;
       the interval for which they are currently accepting appointments. This does not define
       a &quot;template&quot; for planning outside these dates."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Period"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="ical"/>
        <map value="DTSTART:20131201T003000Z DTEND:2014030101T003000Z"/>
      </mapping>
    </element>
    <element>
      <path value="Schedule.comment"/>
      <short value="Comments on the availability to describe any extended information. Such as custom constraints
       on the slot(s) that may be associated"/>
      <definition value="Comments on the availability to describe any extended information. Such as custom constraints
       on the slot(s) that may be associated."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <mapping>
        <identity value="ical"/>
        <map value="COMMENT:(comment) If there is no comment, then the line can be excluded from the iCalendar
         entry"/>
      </mapping>
    </element>
  </differential>
</StructureDefinition>