Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions
Resource Profile: Slot
| Official URL: https://ancode.app/fhir/StructureDefinition/Slot | Version: 0.2.0 | |||
| Draft as of 2023-08-28 | Computable Name: Slot | |||
Usage:
- This Resource Profile is not used by any profiles in this Implementation Guide
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Slot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Slot | 0..* | Slot | A slot of time on a schedule that may be available for booking appointments | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 InsuranceProvider | 0..1 | Reference(Organization) | Extension URL: https://ancode.app/fhir/StructureDefinition/InsuranceProvider | |
 specialty | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: CBOHealthcare (required) | |
 appointmentType | 1..1 | CodeableConcept | The style of appointment or patient that may be booked in the slot (not service type) Binding: EncounterType (required) | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| Slot.specialty | required | CBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO) |
| Slot.appointmentType | required | EncounterType |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Slot | 0..* | Slot | A slot of time on a schedule that may be available for booking appointments | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| InsuranceProvider | 0..1 | Reference(Organization) | Extension URL: https://ancode.app/fhir/StructureDefinition/InsuranceProvider | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: CBOHealthcare (required) |
| appointmentType | Σ | 1..1 | CodeableConcept | The style of appointment or patient that may be booked in the slot (not service type) Binding: EncounterType (required) |
 schedule | Σ | 1..1 | Reference(Schedule) | The schedule resource that this slot defines an interval of status information |
| status | Σ | 1..1 | code | busy | free | busy-unavailable | busy-tentative | entered-in-error Binding: SlotStatus (required): The free/busy status of the slot. |
| start | Σ | 1..1 | instant | Date/Time that the slot is to begin |
| end | Σ | 1..1 | instant | Date/Time that the slot is to conclude |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Slot.specialty | required | CBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO) |
| Slot.appointmentType | required | EncounterType |
| Slot.status | required | SlotStatus |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Slot | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Slot | 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 | Slot | 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 | Slot | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Slot | 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 | ||||
|---|---|---|---|---|---|---|---|---|
| Slot | 0..* | Slot | A slot of time on a schedule 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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| InsuranceProvider | 0..1 | Reference(Organization) | Extension URL: https://ancode.app/fhir/StructureDefinition/InsuranceProvider | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | External Ids for this item | ||||
| serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
| serviceType | Σ | 0..* | CodeableConcept | The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource Binding: ServiceType (example) | ||||
| specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: CBOHealthcare (required) | ||||
| appointmentType | Σ | 1..1 | CodeableConcept | The style of appointment or patient that may be booked in the slot (not service type) Binding: EncounterType (required) | ||||
| schedule | Σ | 1..1 | Reference(Schedule) | The schedule resource that this slot defines an interval of status information | ||||
| status | Σ | 1..1 | code | busy | free | busy-unavailable | busy-tentative | entered-in-error Binding: SlotStatus (required): The free/busy status of the slot. | ||||
| start | Σ | 1..1 | instant | Date/Time that the slot is to begin | ||||
| end | Σ | 1..1 | instant | Date/Time that the slot is to conclude | ||||
| overbooked | 0..1 | boolean | This slot has already been overbooked, appointments are unlikely to be accepted for this time | |||||
| comment | 0..1 | string | Comments on the slot to describe any extended information. Such as custom constraints on the slot | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Slot.language | preferred | CommonLanguages
| ||||
| Slot.serviceCategory | example | ServiceCategory | ||||
| Slot.serviceType | example | ServiceType | ||||
| Slot.specialty | required | CBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO) | ||||
| Slot.appointmentType | required | EncounterType | ||||
| Slot.status | required | SlotStatus |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-r4b | warning | Slot.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 Slot
Differential View
This structure is derived from Slot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Slot | 0..* | Slot | A slot of time on a schedule that may be available for booking appointments | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| InsuranceProvider | 0..1 | Reference(Organization) | Extension URL: https://ancode.app/fhir/StructureDefinition/InsuranceProvider | |
| specialty | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: CBOHealthcare (required) | |
| appointmentType | 1..1 | CodeableConcept | The style of appointment or patient that may be booked in the slot (not service type) Binding: EncounterType (required) | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| Slot.specialty | required | CBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO) |
| Slot.appointmentType | required | EncounterType |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Slot | 0..* | Slot | A slot of time on a schedule that may be available for booking appointments | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| InsuranceProvider | 0..1 | Reference(Organization) | Extension URL: https://ancode.app/fhir/StructureDefinition/InsuranceProvider | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: CBOHealthcare (required) |
| appointmentType | Σ | 1..1 | CodeableConcept | The style of appointment or patient that may be booked in the slot (not service type) Binding: EncounterType (required) |
| schedule | Σ | 1..1 | Reference(Schedule) | The schedule resource that this slot defines an interval of status information |
| status | Σ | 1..1 | code | busy | free | busy-unavailable | busy-tentative | entered-in-error Binding: SlotStatus (required): The free/busy status of the slot. |
| start | Σ | 1..1 | instant | Date/Time that the slot is to begin |
| end | Σ | 1..1 | instant | Date/Time that the slot is to conclude |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Slot.specialty | required | CBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO) |
| Slot.appointmentType | required | EncounterType |
| Slot.status | required | SlotStatus |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Slot | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Slot | 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 | Slot | 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 | Slot | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Slot | 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 | ||||
|---|---|---|---|---|---|---|---|---|
| Slot | 0..* | Slot | A slot of time on a schedule 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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| InsuranceProvider | 0..1 | Reference(Organization) | Extension URL: https://ancode.app/fhir/StructureDefinition/InsuranceProvider | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | External Ids for this item | ||||
| serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
| serviceType | Σ | 0..* | CodeableConcept | The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource Binding: ServiceType (example) | ||||
| specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: CBOHealthcare (required) | ||||
| appointmentType | Σ | 1..1 | CodeableConcept | The style of appointment or patient that may be booked in the slot (not service type) Binding: EncounterType (required) | ||||
| schedule | Σ | 1..1 | Reference(Schedule) | The schedule resource that this slot defines an interval of status information | ||||
| status | Σ | 1..1 | code | busy | free | busy-unavailable | busy-tentative | entered-in-error Binding: SlotStatus (required): The free/busy status of the slot. | ||||
| start | Σ | 1..1 | instant | Date/Time that the slot is to begin | ||||
| end | Σ | 1..1 | instant | Date/Time that the slot is to conclude | ||||
| overbooked | 0..1 | boolean | This slot has already been overbooked, appointments are unlikely to be accepted for this time | |||||
| comment | 0..1 | string | Comments on the slot to describe any extended information. Such as custom constraints on the slot | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Slot.language | preferred | CommonLanguages
| ||||
| Slot.serviceCategory | example | ServiceCategory | ||||
| Slot.serviceType | example | ServiceType | ||||
| Slot.specialty | required | CBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO) | ||||
| Slot.appointmentType | required | EncounterType | ||||
| Slot.status | required | SlotStatus |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-r4b | warning | Slot.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 Slot
Other representations of profile: CSV, Excel, Schematron