3.0.0-alpha - ci-build
3.0.0-alpha - ci-build
Publication Build: This will be filled in by the publication tooling
| Official URL: http://hl7.no/fhir/StructureDefinition/no-basis-AppointmentResponse | Version: 3.0.0-alpha | |||
| Draft as of 2023-06-13 | Computable Name: NoBasisAppointmentResponse | |||
Basisprofil for Norwegian AppointmentResponse information. Defined by HL7 Norway. Should be used as a basis for further profiling in use-cases where specific appointment respons information is needed. The basis profile is open, but derived profiles should close down the information elements according to specification relevant to the use-case.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AppointmentResponse
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AppointmentResponse | 0..* | AppointmentResponse | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
  shortNotice | 0..1 | boolean | Extension URL: http://hl7.no/fhir/structuredefinition/no-basis-appointmentresponse/no-basis-shortnotice | |
   value[x] | 0..1 | boolean | Pasient can come on short notice. | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AppointmentResponse | C | 0..* | AppointmentResponse | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 shortNotice | 0..1 | boolean | Extension URL: http://hl7.no/fhir/structuredefinition/no-basis-appointmentresponse/no-basis-shortnotice | |
  url | 1..1 | uri | "http://hl7.no/fhir/structuredefinition/no-basis-appointmentresponse/no-basis-shortnotice" | |
| value[x] | 0..1 | boolean | Pasient can come on short notice. | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
 appointment | Σ | 1..1 | Reference(Appointment) | Appointment this response relates to |
 participantStatus | ?!Σ | 1..1 | code | accepted | declined | tentative | needs-action | entered-in-error Binding: AppointmentResponseStatus (required): The Participation status of an appointment. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AppointmentResponse.participantStatus | required | AppointmentResponseStatus |
| Id | Grade | Path(s) | Details | Requirements |
| apr-1 | error | AppointmentResponse | Either the participantType or actor must be specified : participantType.exists() or actor.exists() | |
| dom-2 | error | AppointmentResponse | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | AppointmentResponse | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | AppointmentResponse | 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 | AppointmentResponse | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | AppointmentResponse | 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 |
|---|---|---|---|---|
| AppointmentResponse | C | 0..* | AppointmentResponse | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection |
| 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: AllLanguages (required): IETF language tag for a human language | |
| 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 | |
| shortNotice | 0..1 | boolean | Extension URL: http://hl7.no/fhir/structuredefinition/no-basis-appointmentresponse/no-basis-shortnotice | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.no/fhir/structuredefinition/no-basis-appointmentresponse/no-basis-shortnotice" | |
| value[x] | 0..1 | boolean | Pasient can come on short notice. | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | External Ids for this item |
| appointment | Σ | 1..1 | Reference(Appointment) | Appointment this response relates to |
| proposedNewTime | Σ | 0..1 | boolean | Indicator for a counter proposal |
| start | 0..1 | instant | Time from appointment, or requested new start time | |
| end | 0..1 | instant | Time from appointment, or requested new end time | |
| participantType | ΣC | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| actor | ΣC | 0..1 | Reference(Patient | Group | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person(s), Location, HealthcareService, or Device |
| participantStatus | ?!Σ | 1..1 | code | accepted | declined | tentative | needs-action | entered-in-error Binding: AppointmentResponseStatus (required): The Participation status of an appointment. |
| comment | 0..1 | markdown | Additional comments | |
| recurring | 0..1 | boolean | This response is for all occurrences in a recurring request | |
| occurrenceDate | 0..1 | date | Original date within a recurring request | |
| recurrenceId | 0..1 | positiveInt | The recurrence ID of the specific recurring request | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AppointmentResponse.language | required | AllLanguages |
| AppointmentResponse.participantType | extensible | ParticipantType |
| AppointmentResponse.participantStatus | required | AppointmentResponseStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 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 AppointmentResponse
Differential View
This structure is derived from AppointmentResponse
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AppointmentResponse | 0..* | AppointmentResponse | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| shortNotice | 0..1 | boolean | Extension URL: http://hl7.no/fhir/structuredefinition/no-basis-appointmentresponse/no-basis-shortnotice | |
| value[x] | 0..1 | boolean | Pasient can come on short notice. | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AppointmentResponse | C | 0..* | AppointmentResponse | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| shortNotice | 0..1 | boolean | Extension URL: http://hl7.no/fhir/structuredefinition/no-basis-appointmentresponse/no-basis-shortnotice | |
| url | 1..1 | uri | "http://hl7.no/fhir/structuredefinition/no-basis-appointmentresponse/no-basis-shortnotice" | |
| value[x] | 0..1 | boolean | Pasient can come on short notice. | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| appointment | Σ | 1..1 | Reference(Appointment) | Appointment this response relates to |
| participantStatus | ?!Σ | 1..1 | code | accepted | declined | tentative | needs-action | entered-in-error Binding: AppointmentResponseStatus (required): The Participation status of an appointment. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AppointmentResponse.participantStatus | required | AppointmentResponseStatus |
| Id | Grade | Path(s) | Details | Requirements |
| apr-1 | error | AppointmentResponse | Either the participantType or actor must be specified : participantType.exists() or actor.exists() | |
| dom-2 | error | AppointmentResponse | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | AppointmentResponse | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | AppointmentResponse | 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 | AppointmentResponse | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | AppointmentResponse | 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 |
|---|---|---|---|---|
| AppointmentResponse | C | 0..* | AppointmentResponse | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection |
| 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: AllLanguages (required): IETF language tag for a human language | |
| 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 | |
| shortNotice | 0..1 | boolean | Extension URL: http://hl7.no/fhir/structuredefinition/no-basis-appointmentresponse/no-basis-shortnotice | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| url | 1..1 | uri | "http://hl7.no/fhir/structuredefinition/no-basis-appointmentresponse/no-basis-shortnotice" | |
| value[x] | 0..1 | boolean | Pasient can come on short notice. | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | External Ids for this item |
| appointment | Σ | 1..1 | Reference(Appointment) | Appointment this response relates to |
| proposedNewTime | Σ | 0..1 | boolean | Indicator for a counter proposal |
| start | 0..1 | instant | Time from appointment, or requested new start time | |
| end | 0..1 | instant | Time from appointment, or requested new end time | |
| participantType | ΣC | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| actor | ΣC | 0..1 | Reference(Patient | Group | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person(s), Location, HealthcareService, or Device |
| participantStatus | ?!Σ | 1..1 | code | accepted | declined | tentative | needs-action | entered-in-error Binding: AppointmentResponseStatus (required): The Participation status of an appointment. |
| comment | 0..1 | markdown | Additional comments | |
| recurring | 0..1 | boolean | This response is for all occurrences in a recurring request | |
| occurrenceDate | 0..1 | date | Original date within a recurring request | |
| recurrenceId | 0..1 | positiveInt | The recurrence ID of the specific recurring request | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AppointmentResponse.language | required | AllLanguages |
| AppointmentResponse.participantType | extensible | ParticipantType |
| AppointmentResponse.participantStatus | required | AppointmentResponseStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 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 AppointmentResponse
Other representations of profile: CSV, Excel, Schematron