Schedule.profile.json

StructureDefinition for schedule

{
  "resourceType": "StructureDefinition",
  "id": "Schedule",
  "meta": {
    "lastUpdated": "2015-03-27T00:13:00.999+11:00"
  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/StructureDefinition/Schedule",
  "name": "Schedule",
  "publisher": "HL7 FHIR Project (Patient Administration)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
        }
      ]
    }
  ],
  "description": "Base StructureDefinition for Schedule Resource",
  "status": "draft",
  "date": "2015-03-27T00:13:00+11:00",
  "mapping": [
    {
      "identity": "ical",
      "uri": "http://www.ietf.org/rfc/rfc2445.txt",
      "name": "iCalendar"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM"
    }
  ],
  "type": "resource",
  "abstract": true,
  "snapshot": {
    "element": [
      {
        "path": "Schedule",
        "short": "A container for slot(s) of time that may be available for booking appointments",
        "definition": "A container for slot(s) of time that may be available for booking appointments.",
        "alias": [
          "Availability"
        ],
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Schedule"
          }
        ],
        "mapping": [
          {
            "identity": "ical",
            "map": "BEGIN:VFREEBUSY  ???  END:VFREEBUSY\n(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)"
          }
        ]
      },
      {
        "path": "Schedule.id",
        "short": "Logical id of this artefact",
        "definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
        "comments": "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": 0,
        "max": "1",
        "type": [
          {
            "code": "id"
          }
        ]
      },
      {
        "path": "Schedule.meta",
        "short": "Metadata about the resource",
        "definition": "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": 0,
        "max": "1",
        "type": [
          {
            "code": "Meta"
          }
        ]
      },
      {
        "path": "Schedule.implicitRules",
        "short": "A set of rules under which this content was created",
        "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
        "comments": "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": 0,
        "max": "1",
        "type": [
          {
            "code": "uri"
          }
        ],
        "isModifier": true
      },
      {
        "path": "Schedule.language",
        "short": "Language of the resource content",
        "definition": "The base language in which the resource is written.",
        "comments": "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\n\nNot 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": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "Language",
          "strength": "required",
          "description": "A human language",
          "valueSetUri": "http://tools.ietf.org/html/bcp47"
        }
      },
      {
        "path": "Schedule.text",
        "short": "Text summary of the resource, for human interpretation",
        "definition": "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 \"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.",
        "comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
        "alias": [
          "narrative",
          "html",
          "xhtml",
          "display"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Narrative"
          }
        ],
        "condition": [
          "dom-1"
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "Act.text?"
          }
        ]
      },
      {
        "path": "Schedule.contained",
        "short": "Contained, inline Resources",
        "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
        "comments": "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": [
          "inline resources",
          "anonymous resources",
          "contained resources"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Resource"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "Schedule.extension",
        "short": "Additional Content defined by implementations",
        "definition": "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": "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": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "Schedule.modifierExtension",
        "short": "Extensions that cannot be ignored",
        "definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. 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": "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": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "Schedule.identifier",
        "short": "External Ids for this item",
        "definition": "External Ids for this item.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Identifier"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "ical",
            "map": "UID"
          },
          {
            "identity": "rim",
            "map": ".id"
          }
        ]
      },
      {
        "path": "Schedule.type",
        "short": "The schedule type can be used for the categorization of healthcare services or other appointment types",
        "definition": "The schedule type can be used for the categorization of healthcare services or other appointment types.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "name": "DocumentC80PracticeSetting",
          "strength": "preferred",
          "description": "Additional details about where the content was created (e.g. clinical specialty)",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/c80-practice-codes"
          }
        },
        "mapping": [
          {
            "identity": "ical",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "Schedule.actor",
        "short": "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": "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": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/Resource"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "ical",
            "map": "ATTENDEE:MAILTO:john_public@host2.com\nThis can be populated with a value from the referenced resource"
          }
        ]
      },
      {
        "path": "Schedule.planningHorizon",
        "short": "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 \"template\" for planning outside these dates",
        "definition": "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 \"template\" for planning outside these dates.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Period"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "ical",
            "map": "DTSTART:20131201T003000Z\nDTEND:2014030101T003000Z"
          }
        ]
      },
      {
        "path": "Schedule.comment",
        "short": "Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated",
        "definition": "Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "mapping": [
          {
            "identity": "ical",
            "map": "COMMENT:(comment)\nIf there is no comment, then the line can be excluded from the iCalendar entry"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "path": "Schedule",
        "short": "A container for slot(s) of time that may be available for booking appointments",
        "definition": "A container for slot(s) of time that may be available for booking appointments.",
        "alias": [
          "Availability"
        ],
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "DomainResource"
          }
        ],
        "mapping": [
          {
            "identity": "ical",
            "map": "BEGIN:VFREEBUSY  ???  END:VFREEBUSY\n(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)"
          }
        ]
      },
      {
        "path": "Schedule.identifier",
        "short": "External Ids for this item",
        "definition": "External Ids for this item.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Identifier"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "ical",
            "map": "UID"
          },
          {
            "identity": "rim",
            "map": ".id"
          }
        ]
      },
      {
        "path": "Schedule.type",
        "short": "The schedule type can be used for the categorization of healthcare services or other appointment types",
        "definition": "The schedule type can be used for the categorization of healthcare services or other appointment types.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "name": "DocumentC80PracticeSetting",
          "strength": "preferred",
          "description": "Additional details about where the content was created (e.g. clinical specialty)",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/c80-practice-codes"
          }
        },
        "mapping": [
          {
            "identity": "ical",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "Schedule.actor",
        "short": "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": "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": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/Resource"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "ical",
            "map": "ATTENDEE:MAILTO:john_public@host2.com\nThis can be populated with a value from the referenced resource"
          }
        ]
      },
      {
        "path": "Schedule.planningHorizon",
        "short": "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 \"template\" for planning outside these dates",
        "definition": "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 \"template\" for planning outside these dates.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Period"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "ical",
            "map": "DTSTART:20131201T003000Z\nDTEND:2014030101T003000Z"
          }
        ]
      },
      {
        "path": "Schedule.comment",
        "short": "Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated",
        "definition": "Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "mapping": [
          {
            "identity": "ical",
            "map": "COMMENT:(comment)\nIf there is no comment, then the line can be excluded from the iCalendar entry"
          }
        ]
      }
    ]
  }
}