0.0.5 - ci-build
0.0.5 - ci-build
testfsh - Local Development build (v0.0.5). See the Directory of published versions
| Official URL: http://hl7.no/test/StructureDefinition/derived-Appointment | Version: 0.0.5 | |||
| Draft as of 2023-10-12 | Computable Name: DerivedAppointment | |||
Derived appointment profile testing a profile derived from no-basis-Appointment profile
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NoBasisAppointment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Appointment | 0..* | NoBasisAppointment | 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) | |
  appointmentType | ||||
  coding | 1..* | Coding | Recomended code systems for no-basis-Appointment. | |
  coding:omsorgsNiva | 1..1 | Coding | Volven 8406 | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | C | 0..* | NoBasisAppointment | 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) |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| virtualService | SN | 0..* | (Complex) | Virtual Service URL: http://hl7.no/fhir/StructureDefinition/no-basis-virtual-service |
| group | SN | 0..1 | boolean | no-basis-group URL: http://hl7.no/fhir/StructureDefinition/no-basis-group |
| partOf | SN | 0..1 | Reference(no-basis-Appointment) | no-basis-partof URL: http://hl7.no/fhir/StructureDefinition/no-basis-partof |
 modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| 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. |
 participant | CN | 1..* | BackboneElement | Participants involved in appointment |
| modifierExtension | ?!ΣN | 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. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Appointment.status | required | AppointmentStatus |
| Appointment.participant.status | required | ParticipationStatus |
| 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 | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Appointment | C | 0..* | NoBasisAppointment | 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) | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | ΣN | 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 | N | 0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| virtualService | SN | 0..* | (Complex) | Virtual Service URL: http://hl7.no/fhir/StructureDefinition/no-basis-virtual-service | ||||
| group | SN | 0..1 | boolean | no-basis-group URL: http://hl7.no/fhir/StructureDefinition/no-basis-group | ||||
| partOf | SN | 0..1 | Reference(no-basis-Appointment) | no-basis-partof URL: http://hl7.no/fhir/StructureDefinition/no-basis-partof | ||||
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| identifier | ΣN | 0..* | Identifier | External Ids for this item | ||||
| 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 | ΣN | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
| serviceCategory | ΣN | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
| serviceType | ΣN | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
| specialty | ΣN | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) | ||||
 appointmentType | ΣN | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
 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 | ||||
 Slices for coding | Σ | 1..* | Coding | Recomended code systems for no-basis-Appointment. Slice: Unordered, Open by value:$this | ||||
 coding:omsorgsNiva | Σ | 1..1 | Coding | Volven 8406 Binding: urn:oid:2.16.578.1.12.4.1.1.8406 (required): Volven | ||||
| coding:kontaktType | ΣN | 0..1 | Coding | Volven 8432 Binding: urn:oid:2.16.578.1.12.4.1.1.8432 (required): Volven | ||||
 coding:innbygger | ΣN | 0..1 | Coding | Volven 7617 Binding: urn:oid:2.16.578.1.12.4.1.1.7617 (required): Volven | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| reasonCode | ΣN | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
 reasonReference | CN | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | ||||
| 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 | CN | 0..* | Reference(Resource) | Additional information to support the appointment | ||||
| start | Σ | 0..1 | instant | When appointment is to take place | ||||
| end | Σ | 0..1 | instant | When appointment is to conclude | ||||
| minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||
| slot | CN | 0..* | Reference(Slot) | The slots that this appointment is filling | ||||
| 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 | CN | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | ||||
| participant | CN | 1..* | BackboneElement | Participants involved in appointment | ||||
| 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 | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | ΣN | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| actor | ΣCN | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person, Location/HealthcareService or Device | ||||
| 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. | ||||
| period | CN | 0..1 | Period | Participation period of the actor | ||||
| requestedPeriod | CN | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Appointment.language | preferred | CommonLanguages
| ||||
| Appointment.status | required | AppointmentStatus | ||||
| Appointment.cancelationReason | example | AppointmentCancellationReason | ||||
| Appointment.serviceCategory | example | ServiceCategory | ||||
| Appointment.serviceType | example | ServiceType | ||||
| Appointment.specialty | preferred | PracticeSettingCodeValueSet | ||||
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes | ||||
| Appointment.appointmentType.coding:omsorgsNiva | required | | ||||
| Appointment.appointmentType.coding:kontaktType | required | | ||||
| Appointment.appointmentType.coding:innbygger | required | | ||||
| Appointment.reasonCode | preferred | EncounterReasonCodes | ||||
| Appointment.participant.type | extensible | ParticipantType | ||||
| Appointment.participant.required | required | ParticipantRequired | ||||
| Appointment.participant.status | required | ParticipationStatus |
| 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 | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| per-1 | error | 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.reasonReference, Appointment.supportingInformation, Appointment.slot, Appointment.basedOn, Appointment.participant.actor | 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 NoBasisAppointment
Differential View
This structure is derived from NoBasisAppointment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | 0..* | NoBasisAppointment | 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) | |
| appointmentType | ||||
| coding | 1..* | Coding | Recomended code systems for no-basis-Appointment. | |
| coding:omsorgsNiva | 1..1 | Coding | Volven 8406 | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | C | 0..* | NoBasisAppointment | 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) |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| virtualService | SN | 0..* | (Complex) | Virtual Service URL: http://hl7.no/fhir/StructureDefinition/no-basis-virtual-service |
| group | SN | 0..1 | boolean | no-basis-group URL: http://hl7.no/fhir/StructureDefinition/no-basis-group |
| partOf | SN | 0..1 | Reference(no-basis-Appointment) | no-basis-partof URL: http://hl7.no/fhir/StructureDefinition/no-basis-partof |
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| 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. |
| participant | CN | 1..* | BackboneElement | Participants involved in appointment |
| modifierExtension | ?!ΣN | 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. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Appointment.status | required | AppointmentStatus |
| Appointment.participant.status | required | ParticipationStatus |
| 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 | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Appointment | C | 0..* | NoBasisAppointment | 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) | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | ΣN | 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 | N | 0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| virtualService | SN | 0..* | (Complex) | Virtual Service URL: http://hl7.no/fhir/StructureDefinition/no-basis-virtual-service | ||||
| group | SN | 0..1 | boolean | no-basis-group URL: http://hl7.no/fhir/StructureDefinition/no-basis-group | ||||
| partOf | SN | 0..1 | Reference(no-basis-Appointment) | no-basis-partof URL: http://hl7.no/fhir/StructureDefinition/no-basis-partof | ||||
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| identifier | ΣN | 0..* | Identifier | External Ids for this item | ||||
| 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 | ΣN | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
| serviceCategory | ΣN | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
| serviceType | ΣN | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
| specialty | ΣN | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) | ||||
| appointmentType | ΣN | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
| 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 | ||||
| Slices for coding | Σ | 1..* | Coding | Recomended code systems for no-basis-Appointment. Slice: Unordered, Open by value:$this | ||||
| coding:omsorgsNiva | Σ | 1..1 | Coding | Volven 8406 Binding: urn:oid:2.16.578.1.12.4.1.1.8406 (required): Volven | ||||
| coding:kontaktType | ΣN | 0..1 | Coding | Volven 8432 Binding: urn:oid:2.16.578.1.12.4.1.1.8432 (required): Volven | ||||
| coding:innbygger | ΣN | 0..1 | Coding | Volven 7617 Binding: urn:oid:2.16.578.1.12.4.1.1.7617 (required): Volven | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| reasonCode | ΣN | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
| reasonReference | CN | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | ||||
| 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 | CN | 0..* | Reference(Resource) | Additional information to support the appointment | ||||
| start | Σ | 0..1 | instant | When appointment is to take place | ||||
| end | Σ | 0..1 | instant | When appointment is to conclude | ||||
| minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||
| slot | CN | 0..* | Reference(Slot) | The slots that this appointment is filling | ||||
| 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 | CN | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | ||||
| participant | CN | 1..* | BackboneElement | Participants involved in appointment | ||||
| 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 | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | ΣN | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| actor | ΣCN | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person, Location/HealthcareService or Device | ||||
| 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. | ||||
| period | CN | 0..1 | Period | Participation period of the actor | ||||
| requestedPeriod | CN | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Appointment.language | preferred | CommonLanguages
| ||||
| Appointment.status | required | AppointmentStatus | ||||
| Appointment.cancelationReason | example | AppointmentCancellationReason | ||||
| Appointment.serviceCategory | example | ServiceCategory | ||||
| Appointment.serviceType | example | ServiceType | ||||
| Appointment.specialty | preferred | PracticeSettingCodeValueSet | ||||
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes | ||||
| Appointment.appointmentType.coding:omsorgsNiva | required | | ||||
| Appointment.appointmentType.coding:kontaktType | required | | ||||
| Appointment.appointmentType.coding:innbygger | required | | ||||
| Appointment.reasonCode | preferred | EncounterReasonCodes | ||||
| Appointment.participant.type | extensible | ParticipantType | ||||
| Appointment.participant.required | required | ParticipantRequired | ||||
| Appointment.participant.status | required | ParticipationStatus |
| 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 | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| per-1 | error | 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.reasonReference, Appointment.supportingInformation, Appointment.slot, Appointment.basedOn, Appointment.participant.actor | 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 NoBasisAppointment
Other representations of profile: CSV, Excel, Schematron