### ----------------------------------------------------
### -- FHIR
### -- Licenses: Artistic-2.0
### -- Authors: Hugh Simpson
### -- File: t/resources/structureDefinition/Schedule.json
### ----------------------------------------------------
### -- Chunk 3 of 3
 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" : "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" : ["narrative",
      "html",
      "xhtml",
      "display"],
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "DomainResource.text",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "Narrative"
      }],
      "isModifier" : false,
      "isSummary" : false,
      "mapping" : [{
        "identity" : "rim",
        "map" : "Act.text?"
      }]
    },
    {
      "id" : "Schedule.contained",
      "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.",
      "comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
      "alias" : ["inline resources",
      "anonymous resources",
      "contained resources"],
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "DomainResource.contained",
        "min" : 0,
        "max" : "*"
      },
      "type" : [{
        "code" : "Resource"
      }],
      "isModifier" : false,
      "isSummary" : false,
      "mapping" : [{
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "Schedule.extension",
      "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. 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" : "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" : "*",
      "base" : {
        "path" : "DomainResource.extension",
        "min" : 0,
        "max" : "*"
      },
      "type" : [{
        "code" : "Extension"
      }],
      "isModifier" : false,
      "isSummary" : false,
      "mapping" : [{
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "Schedule.modifierExtension",
      "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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
      "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
      "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
      "alias" : ["extensions",
      "user content"],
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "DomainResource.modifierExtension",
        "min" : 0,
        "max" : "*"
      },
      "type" : [{
        "code" : "Extension"
      }],
      "isModifier" : true,
      "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
      "isSummary" : false,
      "mapping" : [{
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "Schedule.identifier",
      "path" : "Schedule.identifier",
      "short" : "External Ids for this item",
      "definition" : "External Ids for this item.",
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "Schedule.identifier",
        "min" : 0,
        "max" : "*"
      },
      "type" : [{
        "code" : "Identifier"
      }],
      "isModifier" : false,
      "isSummary" : true,
      "mapping" : [{
        "identity" : "w5",
        "map" : "FiveWs.identifier"
      },
      {
        "identity" : "ical",
        "map" : "UID"
      }]
    },
    {
      "id" : "Schedule.active",
      "path" : "Schedule.active",
      "short" : "Whether this schedule is in active use",
      "definition" : "Whether this schedule record is in active use or should not be used (such as was entered in error).",
      "comment" : "This element is labeled as a modifier because it may be used to mark that the resource was created in error.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "Schedule.active",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "boolean"
      }],
      "meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
      "isModifier" : true,
      "isModifierReason" : "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
      "isSummary" : true,
      "mapping" : [{
        "identity" : "w5",
        "map" : "FiveWs.status"
      }]
    },
    {
      "id" : "Schedule.serviceCategory",
      "path" : "Schedule.serviceCategory",
      "short" : "High-level category",
      "definition" : "A broad categorization of the service that is to be performed during this appointment.",
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "Schedule.serviceCategory",
        "min" : 0,
        "max" : "*"
      },
      "type" : [{
        "code" : "CodeableConcept"
      }],
      "isModifier" : false,
      "isSummary" : true,
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "service-category"
        }],
        "strength" : "example",
        "valueSet" : "http://hl7.org/fhir/ValueSet/service-category"
      },
      "mapping" : [{
        "identity" : "w5",
        "map" : "FiveWs.class"
      }]
    },
    {
      "id" : "Schedule.serviceType",
      "path" : "Schedule.serviceType",
      "short" : "Specific service",
      "definition" : "The specific service that is to be performed during this appointment.",
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "Schedule.serviceType",
        "min" : 0,
        "max" : "*"
      },
      "type" : [{
        "code" : "CodeableConcept"
      }],
      "isModifier" : false,
      "isSummary" : true,
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "service-type"
        }],
        "strength" : "example",
        "valueSet" : "http://hl7.org/fhir/ValueSet/service-type"
      },
      "mapping" : [{
        "identity" : "w5",
        "map" : "FiveWs.class"
      },
      {
        "identity" : "ical",
        "map" : "n/a"
      }]
    },
    {
      "id" : "Schedule.specialty",
      "path" : "Schedule.specialty",
      "short" : "Type of specialty needed",
      "definition" : "The specialty of a practitioner that would be required to perform the service requested in this appointment.",
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "Schedule.specialty",
        "min" : 0,
        "max" : "*"
      },
      "type" : [{
        "code" : "CodeableConcept"
      }],
      "isModifier" : false,
      "isSummary" : true,
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "specialty"
        }],
        "strength" : "preferred",
        "description" : "Additional details about where the content was created (e.g. clinical specialty).",
        "valueSet" : "http://hl7.org/fhir/ValueSet/c80-practice-codes"
      },
      "mapping" : [{
        "identity" : "w5",
        "map" : "FiveWs.class"
      }]
    },
    {
      "id" : "Schedule.actor",
      "path" : "Schedule.actor",
      "short" : "Resource(s) that availability information is being provided for",
      "definition" : "Slots that reference this schedule resource provide the availability details to these referenced resource(s).",
      "comment" : "The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system.",
      "min" : 1,
      "max" : "*",
      "base" : {
        "path" : "Schedule.actor",
        "min" : 1,
        "max" : "*"
      },
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
        "http://hl7.org/fhir/StructureDefinition/Practitioner",
        "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
        "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
        "http://hl7.org/fhir/StructureDefinition/Device",
        "http://hl7.org/fhir/StructureDefinition/HealthcareService",
        "http://hl7.org/fhir/StructureDefinition/Location"]
      }],
      "isModifier" : false,
      "isSummary" : true,
      "mapping" : [{
        "identity" : "w5",
        "map" : "FiveWs.subject[x]"
      },
      {
        "identity" : "ical",
        "map" : "ATTENDEE:MAILTO:john_public@host2.com This can be populated with a value from the referenced resource"
      },
      {
        "identity" : "w5",
        "map" : "FiveWs.subject"
      }]
    },
    {
      "id" : "Schedule.planningHorizon",
      "path" : "Schedule.planningHorizon",
      "short" : "Period of time covered by schedule",
      "definition" : "The period of time that the slots that reference 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",
      "base" : {
        "path" : "Schedule.planningHorizon",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "Period"
      }],
      "isModifier" : false,
      "isSummary" : true,
      "mapping" : [{
        "identity" : "w5",
        "map" : "FiveWs.planned"
      },
      {
        "identity" : "ical",
        "map" : "DTSTART:20131201T003000Z DTEND:2014030101T003000Z"
      }]
    },
    {
      "id" : "Schedule.comment",
      "path" : "Schedule.comment",
      "short" : "Comments on availability",
      "definition" : "Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "Schedule.comment",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "string"
      }],
      "isModifier" : false,
      "isSummary" : false,
      "mapping" : [{
        "identity" : "ical",
        "map" : "COMMENT:(comment) If there is no comment, then the line can be excluded from the iCalendar entry"
      }]
    }]
  },
  "differential" : {
    "element" : [{
      "id" : "Schedule",
      "path" : "Schedule",
      "short" : "A container for slots of time that may be available for booking appointments",
      "definition" : "A container for slots of time that may be available for booking appointments.",
      "alias" : ["Availability"],
      "min" : 0,
      "max" : "*",
      "mapping" : [{
        "identity" : "rim",
        "map" : "n/a"
      },
      {
        "identity" : "ical",
        "map" : "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)"
      }]
    },
    {
      "id" : "Schedule.identifier",
      "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" : "w5",
        "map" : "FiveWs.identifier"
      },
      {
        "identity" : "ical",
        "map" : "UID"
      }]
    },
    {
      "id" : "Schedule.active",
      "path" : "Schedule.active",
      "short" : "Whether this schedule is in active use",
      "definition" : "Whether this schedule record is in active use or should not be used (such as was entered in error).",
      "comment" : "This element is labeled as a modifier because it may be used to mark that the resource was created in error.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "boolean"
      }],
      "meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
      "isModifier" : true,
      "isModifierReason" : "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
      "isSummary" : true,
      "mapping" : [{
        "identity" : "w5",
        "map" : "FiveWs.status"
      }]
    },
    {
      "id" : "Schedule.serviceCategory",
      "path" : "Schedule.serviceCategory",
      "short" : "High-level category",
      "definition" : "A broad categorization of the service that is to be performed during this appointment.",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "CodeableConcept"
      }],
      "isSummary" : true,
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "service-category"
        }],
        "strength" : "example",
        "valueSet" : "http://hl7.org/fhir/ValueSet/service-category"
      },
      "mapping" : [{
        "identity" : "w5",
        "map" : "FiveWs.class"
      }]
    },
    {
      "id" : "Schedule.serviceType",
      "path" : "Schedule.serviceType",
      "short" : "Specific service",
      "definition" : "The specific service that is to be performed during this appointment.",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "CodeableConcept"
      }],
      "isSummary" : true,
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "service-type"
        }],
        "strength" : "example",
        "valueSet" : "http://hl7.org/fhir/ValueSet/service-type"
      },
      "mapping" : [{
        "identity" : "w5",
        "map" : "FiveWs.class"
      },
      {
        "identity" : "ical",
        "map" : "n/a"
      }]
    },
    {
      "id" : "Schedule.specialty",
      "path" : "Schedule.specialty",
      "short" : "Type of specialty needed",
      "definition" : "The specialty of a practitioner that would be required to perform the service requested in this appointment.",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "CodeableConcept"
      }],
      "isSummary" : true,
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "specialty"
        }],
        "strength" : "preferred",
        "description" : "Additional details about where the content was created (e.g. clinical specialty).",
        "valueSet" : "http://hl7.org/fhir/ValueSet/c80-practice-codes"
      },
      "mapping" : [{
        "identity" : "w5",
        "map" : "FiveWs.class"
      }]
    },
    {
      "id" : "Schedule.actor",
      "path" : "Schedule.actor",
      "short" : "Resource(s) that availability information is being provided for",
      "definition" : "Slots that reference this schedule resource provide the availability details to these referenced resource(s).",
      "comment" : "The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system.",
      "min" : 1,
      "max" : "*",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient",
        "http://hl7.org/fhir/StructureDefinition/Practitioner",
        "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
        "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
        "http://hl7.org/fhir/StructureDefinition/Device",
        "http://hl7.org/fhir/StructureDefinition/HealthcareService",
        "http://hl7.org/fhir/StructureDefinition/Location"]
      }],
      "isSummary" : true,
      "mapping" : [{
        "identity" : "w5",
        "map" : "FiveWs.subject[x]"
      },
      {
        "identity" : "ical",
        "map" : "ATTENDEE:MAILTO:john_public@host2.com This can be populated with a value from the referenced resource"
      },
      {
        "identity" : "w5",
        "map" : "FiveWs.subject"
      }]
    },
    {
      "id" : "Schedule.planningHorizon",
      "path" : "Schedule.planningHorizon",
      "short" : "Period of time covered by schedule",
      "definition" : "The period of time that the slots that reference 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" : "w5",
        "map" : "FiveWs.planned"
      },
      {
        "identity" : "ical",
        "map" : "DTSTART:20131201T003000Z DTEND:2014030101T003000Z"
      }]
    },
    {
      "id" : "Schedule.comment",
      "path" : "Schedule.comment",
      "short" : "Comments on availability",
      "definition" : "Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "string"
      }],
      "mapping" : [{
        "identity" : "ical",
        "map" : "COMMENT:(comment) If there is no comment, then the line can be excluded from the iCalendar entry"
      }]
    }]
  }
}


