Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions
Resource Profile: Schedule
| Official URL: https://ancode.app/fhir/StructureDefinition/Schedule | Version: 0.2.0 | |||
| Draft as of 2023-08-28 | Computable Name: Schedule | |||
Usage:
- Refer to this Resource Profile:
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Schedule
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| Schedule.specialty | required | CBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO) |
Terminology Bindings
| Path | Conformance | ValueSet |
| Schedule.specialty | required | CBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO) |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Schedule | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Schedule | 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 : contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Schedule | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Schedule | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Schedule | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
  Schedule | 0..* | Schedule | A container for slots of time that may be available for booking appointments | |||||
  id | Σ | 0..1 | id | Logical id of this artifact | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 Slices for extension | 8..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
 type | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/ScheduleType Binding: ScheduleType (required) | |||||
| plan | 1..* | (Complex) | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/SchedulePlan | |||||
| durationMinute | 1..1 | code | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ScheduleDuration Binding: DurationMinute (required) | |||||
| dynamicSlot | 1..1 | boolean | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ScheduleDynamicSlot | |||||
| serviceProvider | 1..1 | Reference(Organization) | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ServiceProvider | |||||
| encounterClass | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/EncounterClass Binding: EncounterClass (required) | |||||
| encounterType | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/EncounterType Binding: EncounterType (required) | |||||
| confirmationType | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/ConfirmationType Binding: ConfirmationType (required) | |||||
| scheduleQuestionnaire | 0..* | Reference() | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ScheduleQuestionnaire | |||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | Identifier | An identifier intended for computation | |||||
| active | ?!Σ | 1..1 | boolean | Whether this schedule is in active use | ||||
| serviceCategory | Σ | 0..* | CodeableConcept | High-level category Binding: ServiceCategory (example) | ||||
| serviceType | Σ | 0..* | CodeableConcept | Specific service Binding: ServiceType (example) | ||||
| specialty | Σ | 0..* | CodeableConcept | Type of specialty needed Binding: CBOHealthcare (required) | ||||
  Slices for actor | Σ | 1..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Resource(s) that availability information is being provided for Slice: Unordered, Open by value:type | ||||
  actor:healthcareService | Σ | 0..* | Reference(HealthcareService) | Resource(s) that availability information is being provided for | ||||
| actor:practitioner | Σ | 0..* | Reference(Practitioner) | Resource(s) that availability information is being provided for | ||||
 actor:location | Σ | 1..1 | Reference(Location) | Resource(s) that availability information is being provided for | ||||
| planningHorizon | Σ | 1..1 | Period | Period of time covered by schedule | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
 end | ΣC | 1..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| comment | 1..1 | string | Comments on availability | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Schedule.language | preferred | CommonLanguages
| ||||
| Schedule.serviceCategory | example | ServiceCategory | ||||
| Schedule.serviceType | example | ServiceType | ||||
| Schedule.specialty | required | CBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO) |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-r4b | warning | Schedule.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Schedule
Summary
Mandatory: 14 elements
Structures
This structure refers to these other structures:
- Identifier (https://ancode.app/fhir/StructureDefinition/Identifier)
- HealthcareService (https://ancode.app/fhir/StructureDefinition/HealthcareService)
- Practitioner (https://ancode.app/fhir/StructureDefinition/Practitioner)
- Location (https://ancode.app/fhir/StructureDefinition/Location)
Extensions
This structure refers to these extensions:
- https://ancode.app/fhir/StructureDefinition/ScheduleType
- https://ancode.app/fhir/StructureDefinition/SchedulePlan
- https://ancode.app/fhir/StructureDefinition/ScheduleDuration
- https://ancode.app/fhir/StructureDefinition/ScheduleDynamicSlot
- https://ancode.app/fhir/StructureDefinition/ServiceProvider
- https://ancode.app/fhir/StructureDefinition/EncounterClass
- https://ancode.app/fhir/StructureDefinition/EncounterType
- https://ancode.app/fhir/StructureDefinition/ConfirmationType
- https://ancode.app/fhir/StructureDefinition/ScheduleQuestionnaire
Slices
This structure defines the following Slices:
- The element Schedule.actor is sliced based on the value of value:type
Differential View
This structure is derived from Schedule
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| Schedule.specialty | required | CBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO) |
Key Elements View
Terminology Bindings
| Path | Conformance | ValueSet |
| Schedule.specialty | required | CBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO) |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Schedule | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Schedule | 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 : contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Schedule | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Schedule | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Schedule | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Schedule | 0..* | Schedule | A container for slots of time that may be available for booking appointments | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 8..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| type | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/ScheduleType Binding: ScheduleType (required) | |||||
| plan | 1..* | (Complex) | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/SchedulePlan | |||||
| durationMinute | 1..1 | code | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ScheduleDuration Binding: DurationMinute (required) | |||||
| dynamicSlot | 1..1 | boolean | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ScheduleDynamicSlot | |||||
| serviceProvider | 1..1 | Reference(Organization) | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ServiceProvider | |||||
| encounterClass | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/EncounterClass Binding: EncounterClass (required) | |||||
| encounterType | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/EncounterType Binding: EncounterType (required) | |||||
| confirmationType | 1..1 | CodeableConcept | Extension URL: https://ancode.app/fhir/StructureDefinition/ConfirmationType Binding: ConfirmationType (required) | |||||
| scheduleQuestionnaire | 0..* | Reference() | Optional Extensions Element URL: https://ancode.app/fhir/StructureDefinition/ScheduleQuestionnaire | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | Identifier | An identifier intended for computation | |||||
| active | ?!Σ | 1..1 | boolean | Whether this schedule is in active use | ||||
| serviceCategory | Σ | 0..* | CodeableConcept | High-level category Binding: ServiceCategory (example) | ||||
| serviceType | Σ | 0..* | CodeableConcept | Specific service Binding: ServiceType (example) | ||||
| specialty | Σ | 0..* | CodeableConcept | Type of specialty needed Binding: CBOHealthcare (required) | ||||
| Slices for actor | Σ | 1..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Resource(s) that availability information is being provided for Slice: Unordered, Open by value:type | ||||
| actor:healthcareService | Σ | 0..* | Reference(HealthcareService) | Resource(s) that availability information is being provided for | ||||
| actor:practitioner | Σ | 0..* | Reference(Practitioner) | Resource(s) that availability information is being provided for | ||||
| actor:location | Σ | 1..1 | Reference(Location) | Resource(s) that availability information is being provided for | ||||
| planningHorizon | Σ | 1..1 | Period | Period of time covered by schedule | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
| end | ΣC | 1..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| comment | 1..1 | string | Comments on availability | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Schedule.language | preferred | CommonLanguages
| ||||
| Schedule.serviceCategory | example | ServiceCategory | ||||
| Schedule.serviceType | example | ServiceType | ||||
| Schedule.specialty | required | CBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO) |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-r4b | warning | Schedule.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Schedule
Summary
Mandatory: 14 elements
Structures
This structure refers to these other structures:
- Identifier (https://ancode.app/fhir/StructureDefinition/Identifier)
- HealthcareService (https://ancode.app/fhir/StructureDefinition/HealthcareService)
- Practitioner (https://ancode.app/fhir/StructureDefinition/Practitioner)
- Location (https://ancode.app/fhir/StructureDefinition/Location)
Extensions
This structure refers to these extensions:
- https://ancode.app/fhir/StructureDefinition/ScheduleType
- https://ancode.app/fhir/StructureDefinition/SchedulePlan
- https://ancode.app/fhir/StructureDefinition/ScheduleDuration
- https://ancode.app/fhir/StructureDefinition/ScheduleDynamicSlot
- https://ancode.app/fhir/StructureDefinition/ServiceProvider
- https://ancode.app/fhir/StructureDefinition/EncounterClass
- https://ancode.app/fhir/StructureDefinition/EncounterType
- https://ancode.app/fhir/StructureDefinition/ConfirmationType
- https://ancode.app/fhir/StructureDefinition/ScheduleQuestionnaire
Slices
This structure defines the following Slices:
- The element Schedule.actor is sliced based on the value of value:type
Other representations of profile: CSV, Excel, Schematron