0.9.0 - draft

NyTimelosingIG - Local Development build (v0.9.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: hn-basis-AppointmentResponse

Official URL: http://helsenorge.no/fhir/StructureDefinition/hn-basis-AppointmentResponse Version: 0.9.0
Draft as of 2025-02-15 Computable Name: HnBasisAppointmentResponse

Basisprofil for AppointmentResponse used in 'ny timeløsning'.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. AppointmentResponse C 0..* NoBasisAppointmentResponse A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: 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
dom-6: A resource should have narrative for robust management
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
apr-1: Either the participantType or actor must be specified
inv-1: The 'shortNotice' extension can only be used when the 'actor' is of type 'Patient'.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... shortNotice N 0..1 (Complex) no-basis-shortnotice
URL: http://hl7.no/fhir/StructureDefinition/no-basis-shortnotice
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension N 0..0
..... url 1..1 uri "http://hl7.no/fhir/StructureDefinition/no-basis-shortnotice"
.... changeConferenceType 0..1 (Complex) hn-basis-changeConferenceType
URL: http://helsenorge.no/fhir/StructureDefinition/hn-basis-changeConferenceType
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension 0..0
..... url 1..1 uri "http://helsenorge.no/fhir/StructureDefinition/hn-basis-changeConferenceType"
..... value[x] 0..1 Coding Pasient askes for changed conference type.
Binding: No Basis VirtualServiceType Value Set (required)
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... appointment ΣC 1..1 Reference(Appointment) Appointment this response relates to
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
... actor ΣC 1..1 Reference(Patient) Use only logical reference
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
.... type Σ 1..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).


ele-1: All FHIR elements must have a @value or children
Required Pattern: Patient
.... identifier ΣC 1..1 Identifier Logical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children
inv-a: Only urn:oid:2.16.578.1.12.4.1.4.1 (FNR) or urn:oid:2.16.578.1.12.4.1.4.2 (DNR) are allowed as systems to identify patient in this profile.
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... participantStatus ?!Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AppointmentResponse.extension:changeConferenceType.value[x]requiredNoBasisVirtualServiceType
http://hl7.no/fhir/ValueSet/no-basis-virtual-service-type
AppointmentResponse.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AppointmentResponse.actor.typeextensiblePattern: Patient
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
AppointmentResponse.actor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AppointmentResponse.participantStatusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
apr-1errorAppointmentResponseEither the participantType or actor must be specified
: participantType.exists() or actor.exists()
dom-2errorAppointmentResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentResponseIf 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-4errorAppointmentResponseIf 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-5errorAppointmentResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentResponseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorAppointmentResponseThe 'shortNotice' extension can only be used when the 'actor' is of type 'Patient'.
: extension.where(url = 'http://hl7.no/fhir/StructureDefinition/no-basis-shortnotice').value.exists() and actor.type.value = 'Patient'
inv-aerrorAppointmentResponse.actor.identifierOnly urn:oid:2.16.578.1.12.4.1.4.1 (FNR) or urn:oid:2.16.578.1.12.4.1.4.2 (DNR) are allowed as systems to identify patient in this profile.
: system = 'urn:oid:2.16.578.1.12.4.1.4.1' or system = 'urn:oid:2.16.578.1.12.4.1.4.2'
ref-1errorAppointmentResponse.appointment, AppointmentResponse.actorSHALL 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 NoBasisAppointmentResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. AppointmentResponse 0..* NoBasisAppointmentResponse A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
... Slices for extension Content/Rules for all slices
.... changeConferenceType 0..1 (Complex) hn-basis-changeConferenceType
URL: http://helsenorge.no/fhir/StructureDefinition/hn-basis-changeConferenceType
..... value[x] 0..1 Coding Pasient askes for changed conference type.
... 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
... appointment
.... reference 0..0
.... coding C 0..* Coding Code defined by a terminology system
inv-4: If code is used in a codable consept the system must be used
... actor 1..1 Reference(Patient) Use only logical reference
.... reference 0..0
.... type 1..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: Patient
.... identifier C 1..1 Identifier Logical reference, when literal reference is not known
inv-a: Only urn:oid:2.16.578.1.12.4.1.4.1 (FNR) or urn:oid:2.16.578.1.12.4.1.4.2 (DNR) are allowed as systems to identify patient in this profile.
..... type
...... coding C 0..* Coding Code defined by a terminology system
inv-3: Only FNR or DNR number are allowed as codes to identify patient in this profile.
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-3errorAppointmentResponse.actor.identifier.type.codingOnly FNR or DNR number are allowed as codes to identify patient in this profile.
: code = 'FNR' or code = 'DNR'
inv-4errorAppointmentResponse.participantType.codingIf code is used in a codable consept the system must be used
: code > '' implies (system > '' )
inv-aerrorAppointmentResponse.actor.identifierOnly urn:oid:2.16.578.1.12.4.1.4.1 (FNR) or urn:oid:2.16.578.1.12.4.1.4.2 (DNR) are allowed as systems to identify patient in this profile.
: system = 'urn:oid:2.16.578.1.12.4.1.4.1' or system = 'urn:oid:2.16.578.1.12.4.1.4.2'
NameFlagsCard.TypeDescription & Constraintsdoco
.. AppointmentResponse C 0..* NoBasisAppointmentResponse A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
apr-1: Either the participantType or actor must be specified
inv-1: The 'shortNotice' extension can only be used when the 'actor' is of type 'Patient'.
... 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
... text 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
.... shortNotice N 0..1 (Complex) no-basis-shortnotice
URL: http://hl7.no/fhir/StructureDefinition/no-basis-shortnotice
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..0
..... url 1..1 uri "http://hl7.no/fhir/StructureDefinition/no-basis-shortnotice"
..... value[x] N 0..1 boolean Patient can come on short notice.
.... changeConferenceType 0..1 (Complex) hn-basis-changeConferenceType
URL: http://helsenorge.no/fhir/StructureDefinition/hn-basis-changeConferenceType
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://helsenorge.no/fhir/StructureDefinition/hn-basis-changeConferenceType"
..... value[x] 0..1 Coding Pasient askes for changed conference type.
Binding: No Basis VirtualServiceType Value Set (required)
... 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
... appointment ΣC 1..1 Reference(Appointment) Appointment this response relates to
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
.... 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
.... display Σ 0..1 string Text alternative for the resource
... 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 Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.


.... 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 ΣC 0..* Coding Code defined by a terminology system
inv-4: If code is used in a codable consept the system must be used
.... text Σ 0..1 string Plain text representation of the concept
... actor ΣC 1..1 Reference(Patient) Use only logical reference
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
.... type Σ 1..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).


Required Pattern: Patient
.... identifier ΣC 1..1 Identifier Logical reference, when literal reference is not known
inv-a: Only urn:oid:2.16.578.1.12.4.1.4.1 (FNR) or urn:oid:2.16.578.1.12.4.1.4.2 (DNR) are allowed as systems to identify patient in this profile.
..... 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.

...... 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 ΣC 0..* Coding Code defined by a terminology system
inv-3: Only FNR or DNR number are allowed as codes to identify patient in this profile.
...... 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
... participantStatus ?!Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

... comment 0..1 string Additional comments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AppointmentResponse.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
AppointmentResponse.extension:changeConferenceType.value[x]requiredNoBasisVirtualServiceType
http://hl7.no/fhir/ValueSet/no-basis-virtual-service-type
AppointmentResponse.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AppointmentResponse.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AppointmentResponse.appointment.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
AppointmentResponse.participantTypeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
AppointmentResponse.actor.typeextensiblePattern: Patient
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
AppointmentResponse.actor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AppointmentResponse.actor.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AppointmentResponse.participantStatusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
apr-1errorAppointmentResponseEither the participantType or actor must be specified
: participantType.exists() or actor.exists()
dom-2errorAppointmentResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentResponseIf 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-4errorAppointmentResponseIf 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-5errorAppointmentResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentResponseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorAppointmentResponseThe 'shortNotice' extension can only be used when the 'actor' is of type 'Patient'.
: extension.where(url = 'http://hl7.no/fhir/StructureDefinition/no-basis-shortnotice').value.exists() and actor.type.value = 'Patient'
inv-3errorAppointmentResponse.actor.identifier.type.codingOnly FNR or DNR number are allowed as codes to identify patient in this profile.
: code = 'FNR' or code = 'DNR'
inv-4errorAppointmentResponse.participantType.codingIf code is used in a codable consept the system must be used
: code > '' implies (system > '' )
inv-aerrorAppointmentResponse.actor.identifierOnly urn:oid:2.16.578.1.12.4.1.4.1 (FNR) or urn:oid:2.16.578.1.12.4.1.4.2 (DNR) are allowed as systems to identify patient in this profile.
: system = 'urn:oid:2.16.578.1.12.4.1.4.1' or system = 'urn:oid:2.16.578.1.12.4.1.4.2'
per-1errorAppointmentResponse.identifier.period, AppointmentResponse.actor.identifier.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorAppointmentResponse.identifier.assigner, AppointmentResponse.appointment, AppointmentResponse.actor, AppointmentResponse.actor.identifier.assignerSHALL 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 NoBasisAppointmentResponse

Summary

Mandatory: 8 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AppointmentResponse C 0..* NoBasisAppointmentResponse A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: 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
dom-6: A resource should have narrative for robust management
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
apr-1: Either the participantType or actor must be specified
inv-1: The 'shortNotice' extension can only be used when the 'actor' is of type 'Patient'.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... shortNotice N 0..1 (Complex) no-basis-shortnotice
URL: http://hl7.no/fhir/StructureDefinition/no-basis-shortnotice
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension N 0..0
..... url 1..1 uri "http://hl7.no/fhir/StructureDefinition/no-basis-shortnotice"
.... changeConferenceType 0..1 (Complex) hn-basis-changeConferenceType
URL: http://helsenorge.no/fhir/StructureDefinition/hn-basis-changeConferenceType
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension 0..0
..... url 1..1 uri "http://helsenorge.no/fhir/StructureDefinition/hn-basis-changeConferenceType"
..... value[x] 0..1 Coding Pasient askes for changed conference type.
Binding: No Basis VirtualServiceType Value Set (required)
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... appointment ΣC 1..1 Reference(Appointment) Appointment this response relates to
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
... actor ΣC 1..1 Reference(Patient) Use only logical reference
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided
.... type Σ 1..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).


ele-1: All FHIR elements must have a @value or children
Required Pattern: Patient
.... identifier ΣC 1..1 Identifier Logical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children
inv-a: Only urn:oid:2.16.578.1.12.4.1.4.1 (FNR) or urn:oid:2.16.578.1.12.4.1.4.2 (DNR) are allowed as systems to identify patient in this profile.
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... participantStatus ?!Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AppointmentResponse.extension:changeConferenceType.value[x]requiredNoBasisVirtualServiceType
http://hl7.no/fhir/ValueSet/no-basis-virtual-service-type
AppointmentResponse.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AppointmentResponse.actor.typeextensiblePattern: Patient
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
AppointmentResponse.actor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AppointmentResponse.participantStatusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
apr-1errorAppointmentResponseEither the participantType or actor must be specified
: participantType.exists() or actor.exists()
dom-2errorAppointmentResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentResponseIf 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-4errorAppointmentResponseIf 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-5errorAppointmentResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentResponseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorAppointmentResponseThe 'shortNotice' extension can only be used when the 'actor' is of type 'Patient'.
: extension.where(url = 'http://hl7.no/fhir/StructureDefinition/no-basis-shortnotice').value.exists() and actor.type.value = 'Patient'
inv-aerrorAppointmentResponse.actor.identifierOnly urn:oid:2.16.578.1.12.4.1.4.1 (FNR) or urn:oid:2.16.578.1.12.4.1.4.2 (DNR) are allowed as systems to identify patient in this profile.
: system = 'urn:oid:2.16.578.1.12.4.1.4.1' or system = 'urn:oid:2.16.578.1.12.4.1.4.2'
ref-1errorAppointmentResponse.appointment, AppointmentResponse.actorSHALL 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'))

Differential View

This structure is derived from NoBasisAppointmentResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. AppointmentResponse 0..* NoBasisAppointmentResponse A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
... Slices for extension Content/Rules for all slices
.... changeConferenceType 0..1 (Complex) hn-basis-changeConferenceType
URL: http://helsenorge.no/fhir/StructureDefinition/hn-basis-changeConferenceType
..... value[x] 0..1 Coding Pasient askes for changed conference type.
... 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
... appointment
.... reference 0..0
.... coding C 0..* Coding Code defined by a terminology system
inv-4: If code is used in a codable consept the system must be used
... actor 1..1 Reference(Patient) Use only logical reference
.... reference 0..0
.... type 1..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: Patient
.... identifier C 1..1 Identifier Logical reference, when literal reference is not known
inv-a: Only urn:oid:2.16.578.1.12.4.1.4.1 (FNR) or urn:oid:2.16.578.1.12.4.1.4.2 (DNR) are allowed as systems to identify patient in this profile.
..... type
...... coding C 0..* Coding Code defined by a terminology system
inv-3: Only FNR or DNR number are allowed as codes to identify patient in this profile.
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-3errorAppointmentResponse.actor.identifier.type.codingOnly FNR or DNR number are allowed as codes to identify patient in this profile.
: code = 'FNR' or code = 'DNR'
inv-4errorAppointmentResponse.participantType.codingIf code is used in a codable consept the system must be used
: code > '' implies (system > '' )
inv-aerrorAppointmentResponse.actor.identifierOnly urn:oid:2.16.578.1.12.4.1.4.1 (FNR) or urn:oid:2.16.578.1.12.4.1.4.2 (DNR) are allowed as systems to identify patient in this profile.
: system = 'urn:oid:2.16.578.1.12.4.1.4.1' or system = 'urn:oid:2.16.578.1.12.4.1.4.2'

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AppointmentResponse C 0..* NoBasisAppointmentResponse A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
apr-1: Either the participantType or actor must be specified
inv-1: The 'shortNotice' extension can only be used when the 'actor' is of type 'Patient'.
... 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
... text 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
.... shortNotice N 0..1 (Complex) no-basis-shortnotice
URL: http://hl7.no/fhir/StructureDefinition/no-basis-shortnotice
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..0
..... url 1..1 uri "http://hl7.no/fhir/StructureDefinition/no-basis-shortnotice"
..... value[x] N 0..1 boolean Patient can come on short notice.
.... changeConferenceType 0..1 (Complex) hn-basis-changeConferenceType
URL: http://helsenorge.no/fhir/StructureDefinition/hn-basis-changeConferenceType
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://helsenorge.no/fhir/StructureDefinition/hn-basis-changeConferenceType"
..... value[x] 0..1 Coding Pasient askes for changed conference type.
Binding: No Basis VirtualServiceType Value Set (required)
... 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
... appointment ΣC 1..1 Reference(Appointment) Appointment this response relates to
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
.... 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
.... display Σ 0..1 string Text alternative for the resource
... 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 Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.


.... 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 ΣC 0..* Coding Code defined by a terminology system
inv-4: If code is used in a codable consept the system must be used
.... text Σ 0..1 string Plain text representation of the concept
... actor ΣC 1..1 Reference(Patient) Use only logical reference
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
.... type Σ 1..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).


Required Pattern: Patient
.... identifier ΣC 1..1 Identifier Logical reference, when literal reference is not known
inv-a: Only urn:oid:2.16.578.1.12.4.1.4.1 (FNR) or urn:oid:2.16.578.1.12.4.1.4.2 (DNR) are allowed as systems to identify patient in this profile.
..... 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.

...... 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 ΣC 0..* Coding Code defined by a terminology system
inv-3: Only FNR or DNR number are allowed as codes to identify patient in this profile.
...... 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
... participantStatus ?!Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

... comment 0..1 string Additional comments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AppointmentResponse.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
AppointmentResponse.extension:changeConferenceType.value[x]requiredNoBasisVirtualServiceType
http://hl7.no/fhir/ValueSet/no-basis-virtual-service-type
AppointmentResponse.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AppointmentResponse.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AppointmentResponse.appointment.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
AppointmentResponse.participantTypeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
AppointmentResponse.actor.typeextensiblePattern: Patient
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
AppointmentResponse.actor.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AppointmentResponse.actor.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AppointmentResponse.participantStatusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
apr-1errorAppointmentResponseEither the participantType or actor must be specified
: participantType.exists() or actor.exists()
dom-2errorAppointmentResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentResponseIf 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-4errorAppointmentResponseIf 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-5errorAppointmentResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentResponseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorAppointmentResponseThe 'shortNotice' extension can only be used when the 'actor' is of type 'Patient'.
: extension.where(url = 'http://hl7.no/fhir/StructureDefinition/no-basis-shortnotice').value.exists() and actor.type.value = 'Patient'
inv-3errorAppointmentResponse.actor.identifier.type.codingOnly FNR or DNR number are allowed as codes to identify patient in this profile.
: code = 'FNR' or code = 'DNR'
inv-4errorAppointmentResponse.participantType.codingIf code is used in a codable consept the system must be used
: code > '' implies (system > '' )
inv-aerrorAppointmentResponse.actor.identifierOnly urn:oid:2.16.578.1.12.4.1.4.1 (FNR) or urn:oid:2.16.578.1.12.4.1.4.2 (DNR) are allowed as systems to identify patient in this profile.
: system = 'urn:oid:2.16.578.1.12.4.1.4.1' or system = 'urn:oid:2.16.578.1.12.4.1.4.2'
per-1errorAppointmentResponse.identifier.period, AppointmentResponse.actor.identifier.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorAppointmentResponse.identifier.assigner, AppointmentResponse.appointment, AppointmentResponse.actor, AppointmentResponse.actor.identifier.assignerSHALL 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 NoBasisAppointmentResponse

Summary

Mandatory: 8 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron