Service d'Accès aux Soins
1.0.0 - trial-use
This page is part of the Service d'Accès aux Soins (v1.0.0: trial-use) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://sas.fr/fhir/StructureDefinition/FrAppointmentSAS | Version: 1.0.0 | |||
Active as of 2024-09-05 | Computable Name: FrAppointmentSAS |
Profil de Appointment, dérivé de FrAppointment, pour le cas d’usage prise de RDV de la plateforme SAS (Service d’accès aux soins)
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from FrAppointment
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | 0..* | FrAppointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) | |
extension | 1..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
extension:appointmentOperator | 1..1 | FrAppointmentOperator | Optional Extensions Element | |
extension | 0..0 | |||
value[x] | 1..1 | Reference() | Value of extension | |
Slices for value[x] | Content/Rules for all slices | |||
value[x]:valueReference | 1..1 | Reference(FrOrganization | FrPractitioner | FrPatient | RelatedPerson) | Value of extension | |
identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
type | 1..1 | CodeableConcept | Description of identifier | |
coding | 1..1 | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system Required Pattern: http://interopsante.org/fhir/CodeSystem/fr-v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system | |
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
identifier | 1..1 | Identifier | External Ids for this item | |
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
start | 1..1 | instant | When appointment is to take place | |
end | 1..1 | instant | When appointment is to conclude | |
participant | ||||
actor | ||||
identifier | ||||
type | 1..1 | CodeableConcept | Description of identifier | |
coding | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://interopsante.org/fhir/CodeSystem/fr-v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: IDNPS | |
system | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.250.1.71.4.2.1 | |
value | 1..1 | string | The value that is unique | |
status | 1..1 | code | accepted | declined | tentative | needs-action Required Pattern: accepted | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | C | 0..* | FrAppointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show app-3: Only proposed or cancelled appointments can be missing start/end dates app-2: Either start and end are specified, or neither |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
appointmentOperator | 1..1 | (Complex) | Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrAppointmentOperator | |
extension | 0..0 | |||
url | 1..1 | uri | "http://interopsante.org/fhir/StructureDefinition/FrAppointmentOperator" | |
Slices for value[x] | 1..1 | Reference() | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueReference | 1..1 | Reference(FrOrganization | FrPractitioner | FrPatient | RelatedPerson) | Value of extension | |
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://interopsante.org/fhir/CodeSystem/fr-v2-0203 |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
identifier | Σ | 1..1 | Identifier | External Ids for this item |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. |
start | Σ | 1..1 | instant | When appointment is to take place |
end | Σ | 1..1 | instant | When appointment is to conclude |
participant | C | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Appointment.extension:appointmentOperator.value[x]:valueReference.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Appointment.extension:appointmentOperator.value[x]:valueReference.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Appointment.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus from the FHIR Standard | |
Appointment.participant.status | required | Pattern: acceptedhttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
app-2 | error | Appointment | Either start and end are specified, or neither : start.exists() = end.exists() | |
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')) | |
app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled') | |
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Appointment | 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Appointment | 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 | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Appointment | 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 | Appointment.extension, Appointment.extension:appointmentOperator, Appointment.modifierExtension, Appointment.participant.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Appointment | C | 0..* | FrAppointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show app-3: Only proposed or cancelled appointments can be missing start/end dates app-2: Either start and end are specified, or neither | ||||
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): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
appointmentOperator | 1..1 | (Complex) | Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrAppointmentOperator | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://interopsante.org/fhir/StructureDefinition/FrAppointmentOperator" | |||||
Slices for value[x] | 1..1 | Reference() | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueReference | 1..1 | Reference(FrOrganization | FrPractitioner | FrPatient | RelatedPerson) | Value of extension | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://interopsante.org/fhir/CodeSystem/fr-v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | ΣC | 0..1 | Period | Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end | ||||
assigner | ΣC | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
identifier | Σ | 1..1 | Identifier | External Ids for this item | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | ΣC | 0..1 | Period | Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end | ||||
assigner | ΣC | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided | ||||
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. | ||||
cancelationReason | Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: fr-practitioner-specialty (required) | ||||
appointmentType | Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
reasonCode | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
reasonReference | C | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) ref-1: SHALL have a contained resource if a local reference is provided | ||||
priority | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |||||
description | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
supportingInformation | C | 0..* | Reference(Resource) | Additional information to support the appointment ref-1: SHALL have a contained resource if a local reference is provided | ||||
start | Σ | 1..1 | instant | When appointment is to take place | ||||
end | Σ | 1..1 | instant | When appointment is to conclude | ||||
minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||
slot | C | 0..* | Reference(FrSlot) | The slots that this appointment is filling ref-1: SHALL have a contained resource if a local reference is provided | ||||
created | 0..1 | dateTime | The date that this appointment was initially created | |||||
comment | 0..1 | string | Additional comments | |||||
patientInstruction | 0..1 | string | Detailed information and instructions for the patient | |||||
basedOn | C | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess ref-1: SHALL have a contained resource if a local reference is provided | ||||
participant | C | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
actor | ΣC | 0..1 | Reference(Device | PractitionerRole | FrRelatedPerson | FrHealthcareService | FrPractitioner | FrPatient | FrLocation) | Person, Location/HealthcareService or Device ref-1: SHALL have a contained resource if a local reference is provided | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://interopsante.org/fhir/CodeSystem/fr-v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: IDNPS | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.250.1.71.4.2.1 | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | ΣC | 0..1 | Period | Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end | ||||
assigner | ΣC | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted | ||||
period | C | 0..1 | Period | Participation period of the actor per-1: If present, start SHALL have a lower value than end | ||||
requestedPeriod | C | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within per-1: If present, start SHALL have a lower value than end | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Appointment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Appointment.extension:appointmentOperator.value[x]:valueReference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Appointment.extension:appointmentOperator.value[x]:valueReference.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Appointment.extension:appointmentOperator.value[x]:valueReference.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Appointment.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Appointment.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus from the FHIR Standard | ||||
Appointment.cancelationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reason from the FHIR Standard | ||||
Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category from the FHIR Standard | ||||
Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Appointment.specialty | required | fr-practitioner-specialtyhttp://interopsante.org/fhir/ValueSet/fr-practitioner-specialty | ||||
Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 | ||||
Appointment.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Appointment.participant.actor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Appointment.participant.actor.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Appointment.participant.actor.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Appointment.participant.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1 from the FHIR Standard | ||||
Appointment.participant.status | required | Pattern: acceptedhttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
app-2 | error | Appointment | Either start and end are specified, or neither : start.exists() = end.exists() | |
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')) | |
app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled') | |
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Appointment | 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Appointment | 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 | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Appointment | 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 | Appointment.extension, Appointment.extension:appointmentOperator, Appointment.extension:appointmentOperator.value[x]:valueReference.extension, Appointment.extension:appointmentOperator.value[x]:valueReference.identifier.extension, Appointment.extension:appointmentOperator.value[x]:valueReference.identifier.type.extension, Appointment.extension:appointmentOperator.value[x]:valueReference.identifier.type.coding.extension, Appointment.modifierExtension, Appointment.identifier.extension, Appointment.participant.extension, Appointment.participant.modifierExtension, Appointment.participant.actor.extension, Appointment.participant.actor.identifier.extension, Appointment.participant.actor.identifier.type.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
per-1 | error | Appointment.extension:appointmentOperator.value[x]:valueReference.identifier.period, Appointment.identifier.period, Appointment.participant.actor.identifier.period, Appointment.participant.period, Appointment.requestedPeriod | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
ref-1 | error | Appointment.extension:appointmentOperator.value[x]:valueReference.identifier.assigner, Appointment.identifier.assigner, Appointment.reasonReference, Appointment.supportingInformation, Appointment.slot, Appointment.basedOn, Appointment.participant.actor, Appointment.participant.actor.identifier.assigner | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from FrAppointment
Differential View
This structure is derived from FrAppointment
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | 0..* | FrAppointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) | |
extension | 1..* | Extension | Extension | |
Slices for extension | Content/Rules for all slices | |||
extension:appointmentOperator | 1..1 | FrAppointmentOperator | Optional Extensions Element | |
extension | 0..0 | |||
value[x] | 1..1 | Reference() | Value of extension | |
Slices for value[x] | Content/Rules for all slices | |||
value[x]:valueReference | 1..1 | Reference(FrOrganization | FrPractitioner | FrPatient | RelatedPerson) | Value of extension | |
identifier | 1..1 | Identifier | Logical reference, when literal reference is not known | |
type | 1..1 | CodeableConcept | Description of identifier | |
coding | 1..1 | Coding | Code defined by a terminology system | |
system | 0..1 | uri | Identity of the terminology system Required Pattern: http://interopsante.org/fhir/CodeSystem/fr-v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system | |
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
identifier | 1..1 | Identifier | External Ids for this item | |
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
start | 1..1 | instant | When appointment is to take place | |
end | 1..1 | instant | When appointment is to conclude | |
participant | ||||
actor | ||||
identifier | ||||
type | 1..1 | CodeableConcept | Description of identifier | |
coding | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://interopsante.org/fhir/CodeSystem/fr-v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: IDNPS | |
system | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.250.1.71.4.2.1 | |
value | 1..1 | string | The value that is unique | |
status | 1..1 | code | accepted | declined | tentative | needs-action Required Pattern: accepted | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | C | 0..* | FrAppointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show app-3: Only proposed or cancelled appointments can be missing start/end dates app-2: Either start and end are specified, or neither |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
appointmentOperator | 1..1 | (Complex) | Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrAppointmentOperator | |
extension | 0..0 | |||
url | 1..1 | uri | "http://interopsante.org/fhir/StructureDefinition/FrAppointmentOperator" | |
Slices for value[x] | 1..1 | Reference() | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueReference | 1..1 | Reference(FrOrganization | FrPractitioner | FrPatient | RelatedPerson) | Value of extension | |
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://interopsante.org/fhir/CodeSystem/fr-v2-0203 |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
identifier | Σ | 1..1 | Identifier | External Ids for this item |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. |
start | Σ | 1..1 | instant | When appointment is to take place |
end | Σ | 1..1 | instant | When appointment is to conclude |
participant | C | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Appointment.extension:appointmentOperator.value[x]:valueReference.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Appointment.extension:appointmentOperator.value[x]:valueReference.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Appointment.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus from the FHIR Standard | |
Appointment.participant.status | required | Pattern: acceptedhttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
app-2 | error | Appointment | Either start and end are specified, or neither : start.exists() = end.exists() | |
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')) | |
app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled') | |
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Appointment | 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Appointment | 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 | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Appointment | 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 | Appointment.extension, Appointment.extension:appointmentOperator, Appointment.modifierExtension, Appointment.participant.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Appointment | C | 0..* | FrAppointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show app-3: Only proposed or cancelled appointments can be missing start/end dates app-2: Either start and end are specified, or neither | ||||
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): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
appointmentOperator | 1..1 | (Complex) | Optional Extensions Element URL: http://interopsante.org/fhir/StructureDefinition/FrAppointmentOperator | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://interopsante.org/fhir/StructureDefinition/FrAppointmentOperator" | |||||
Slices for value[x] | 1..1 | Reference() | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueReference | 1..1 | Reference(FrOrganization | FrPractitioner | FrPatient | RelatedPerson) | Value of extension | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://interopsante.org/fhir/CodeSystem/fr-v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | ΣC | 0..1 | Period | Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end | ||||
assigner | ΣC | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
identifier | Σ | 1..1 | Identifier | External Ids for this item | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | ΣC | 0..1 | Period | Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end | ||||
assigner | ΣC | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided | ||||
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. | ||||
cancelationReason | Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: fr-practitioner-specialty (required) | ||||
appointmentType | Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
reasonCode | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
reasonReference | C | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) ref-1: SHALL have a contained resource if a local reference is provided | ||||
priority | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |||||
description | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
supportingInformation | C | 0..* | Reference(Resource) | Additional information to support the appointment ref-1: SHALL have a contained resource if a local reference is provided | ||||
start | Σ | 1..1 | instant | When appointment is to take place | ||||
end | Σ | 1..1 | instant | When appointment is to conclude | ||||
minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||
slot | C | 0..* | Reference(FrSlot) | The slots that this appointment is filling ref-1: SHALL have a contained resource if a local reference is provided | ||||
created | 0..1 | dateTime | The date that this appointment was initially created | |||||
comment | 0..1 | string | Additional comments | |||||
patientInstruction | 0..1 | string | Detailed information and instructions for the patient | |||||
basedOn | C | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess ref-1: SHALL have a contained resource if a local reference is provided | ||||
participant | C | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
actor | ΣC | 0..1 | Reference(Device | PractitionerRole | FrRelatedPerson | FrHealthcareService | FrPractitioner | FrPatient | FrLocation) | Person, Location/HealthcareService or Device ref-1: SHALL have a contained resource if a local reference is provided | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://interopsante.org/fhir/CodeSystem/fr-v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: IDNPS | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.250.1.71.4.2.1 | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | ΣC | 0..1 | Period | Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end | ||||
assigner | ΣC | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Required Pattern: accepted | ||||
period | C | 0..1 | Period | Participation period of the actor per-1: If present, start SHALL have a lower value than end | ||||
requestedPeriod | C | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within per-1: If present, start SHALL have a lower value than end | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Appointment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Appointment.extension:appointmentOperator.value[x]:valueReference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Appointment.extension:appointmentOperator.value[x]:valueReference.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Appointment.extension:appointmentOperator.value[x]:valueReference.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Appointment.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Appointment.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus from the FHIR Standard | ||||
Appointment.cancelationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reason from the FHIR Standard | ||||
Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category from the FHIR Standard | ||||
Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Appointment.specialty | required | fr-practitioner-specialtyhttp://interopsante.org/fhir/ValueSet/fr-practitioner-specialty | ||||
Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 | ||||
Appointment.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Appointment.participant.actor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Appointment.participant.actor.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Appointment.participant.actor.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Appointment.participant.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1 from the FHIR Standard | ||||
Appointment.participant.status | required | Pattern: acceptedhttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
app-2 | error | Appointment | Either start and end are specified, or neither : start.exists() = end.exists() | |
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')) | |
app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled') | |
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Appointment | 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Appointment | 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 | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Appointment | 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 | Appointment.extension, Appointment.extension:appointmentOperator, Appointment.extension:appointmentOperator.value[x]:valueReference.extension, Appointment.extension:appointmentOperator.value[x]:valueReference.identifier.extension, Appointment.extension:appointmentOperator.value[x]:valueReference.identifier.type.extension, Appointment.extension:appointmentOperator.value[x]:valueReference.identifier.type.coding.extension, Appointment.modifierExtension, Appointment.identifier.extension, Appointment.participant.extension, Appointment.participant.modifierExtension, Appointment.participant.actor.extension, Appointment.participant.actor.identifier.extension, Appointment.participant.actor.identifier.type.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
per-1 | error | Appointment.extension:appointmentOperator.value[x]:valueReference.identifier.period, Appointment.identifier.period, Appointment.participant.actor.identifier.period, Appointment.participant.period, Appointment.requestedPeriod | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
ref-1 | error | Appointment.extension:appointmentOperator.value[x]:valueReference.identifier.assigner, Appointment.identifier.assigner, Appointment.reasonReference, Appointment.supportingInformation, Appointment.slot, Appointment.basedOn, Appointment.participant.actor, Appointment.participant.actor.identifier.assigner | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from FrAppointment
Other representations of profile: CSV, Excel, Schematron