0.1.0 - draft
NyTimelosingIG - Local Development build (v0.1.0). See the Directory of published versions
Official URL: http://helsenorge.no/fhir/StructureDefinition/hn-basis-AppointmentResponse | Version: 0.1.0 | |||
Draft as of 2024-06-01 | Computable Name: HnBasisAppointmentResponse |
Basisprofil for AppointmentResponse used in ‘ny timeløsning’.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NoBasisAppointmentResponse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AppointmentResponse | 0..* | NoBasisAppointmentResponse | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection | |
changeConferenceType | 0..1 | Coding | hn-basis-changeConferenceType URL: http://helsenorge.no/fhir/StructureDefinition/hn-basis-changeConferenceType Binding: No Basis VirtualServiceType Value Set (required) | |
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 | |||
participantType | ||||
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-2: 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 | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
inv-2 | error | AppointmentResponse.actor.identifier | 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. : 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' | |
inv-3 | error | AppointmentResponse.actor.identifier.type.coding | Only FNR or DNR number are allowed as codes to identify patient in this profile. : code = 'FNR' or code = 'DNR' | |
inv-4 | error | AppointmentResponse.participantType.coding | If code is used in a codable consept the system must be used : code > '' implies (system > '' ) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AppointmentResponse | C | 0..* | NoBasisAppointmentResponse | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection |
implicitRules | ?!ΣN | 0..1 | uri | A set of rules under which this content was created |
shortNotice | N | 0..1 | boolean | no-basis-shortnotice URL: http://hl7.no/fhir/StructureDefinition/no-basis-shortnotice |
extension | N | 0..0 | ||
url | 1..1 | uri | "http://hl7.no/fhir/StructureDefinition/no-basis-shortnotice" | |
changeConferenceType | 0..1 | Coding | hn-basis-changeConferenceType URL: http://helsenorge.no/fhir/StructureDefinition/hn-basis-changeConferenceType Binding: No Basis VirtualServiceType Value Set (required) | |
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 |
use | ?!ΣN | 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 |
appointment | ΣCN | 1..1 | Reference(Appointment) | Appointment this response relates to |
actor | ΣC | 1..1 | Reference(Patient) | Use only logical reference |
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-2: 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 | ?!ΣN | 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 |
participantStatus | ?!ΣN | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
Documentation for this format |
Path | Conformance | ValueSet / Code |
AppointmentResponse.extension:changeConferenceType.value[x] | required | NoBasisVirtualServiceType |
AppointmentResponse.identifier.use | required | IdentifierUse |
AppointmentResponse.actor.type | extensible | Pattern: Patient |
AppointmentResponse.actor.identifier.use | required | IdentifierUse |
AppointmentResponse.participantStatus | required | ParticipationStatus |
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().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 | 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** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-1 | error | AppointmentResponse | The '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-2 | error | AppointmentResponse.actor.identifier | 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. : 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-1 | error | AppointmentResponse.appointment, AppointmentResponse.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')) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
AppointmentResponse | C | 0..* | NoBasisAppointmentResponse | 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 | ΣN | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!ΣN | 0..1 | uri | A set of rules under which this content was created | ||||
language | N | 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 | ||||
shortNotice | N | 0..1 | boolean | 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 | Coding | hn-basis-changeConferenceType URL: http://helsenorge.no/fhir/StructureDefinition/hn-basis-changeConferenceType Binding: No Basis VirtualServiceType Value Set (required) | |||||
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 | ?!ΣN | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | ΣN | 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 | ΣCN | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | ΣCN | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
appointment | ΣCN | 1..1 | Reference(Appointment) | Appointment this response relates to | ||||
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 | ΣN | 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 | ΣN | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | ΣN | 0..1 | string | Text alternative for the resource | ||||
start | N | 0..1 | instant | Time from appointment, or requested new start time | ||||
end | N | 0..1 | instant | Time from appointment, or requested new end time | ||||
participantType | ΣN | 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 | ΣN | 0..1 | string | Plain text representation of the concept | ||||
actor | ΣC | 1..1 | Reference(Patient) | Use only logical reference | ||||
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-2: 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 | ?!ΣN | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | ΣN | 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 | ΣN | 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 | ΣCN | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | ΣCN | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
display | ΣN | 0..1 | string | Text alternative for the resource | ||||
participantStatus | ?!ΣN | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
comment | N | 0..1 | string | Additional comments | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
AppointmentResponse.language | preferred | CommonLanguages
| ||||
AppointmentResponse.extension:changeConferenceType.value[x] | required | NoBasisVirtualServiceType | ||||
AppointmentResponse.identifier.use | required | IdentifierUse | ||||
AppointmentResponse.identifier.type | extensible | Identifier Type Codes | ||||
AppointmentResponse.appointment.type | extensible | ResourceType | ||||
AppointmentResponse.participantType | extensible | ParticipantType | ||||
AppointmentResponse.actor.type | extensible | Pattern: Patient | ||||
AppointmentResponse.actor.identifier.use | required | IdentifierUse | ||||
AppointmentResponse.actor.identifier.type | extensible | Identifier Type Codes | ||||
AppointmentResponse.participantStatus | required | ParticipationStatus |
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().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 | 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** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-1 | error | AppointmentResponse | The '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-2 | error | AppointmentResponse.actor.identifier | 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. : 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' | |
inv-3 | error | AppointmentResponse.actor.identifier.type.coding | Only FNR or DNR number are allowed as codes to identify patient in this profile. : code = 'FNR' or code = 'DNR' | |
inv-4 | error | AppointmentResponse.participantType.coding | If code is used in a codable consept the system must be used : code > '' implies (system > '' ) | |
per-1 | error | AppointmentResponse.identifier.period, AppointmentResponse.actor.identifier.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
ref-1 | error | AppointmentResponse.identifier.assigner, AppointmentResponse.appointment, AppointmentResponse.actor, AppointmentResponse.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 NoBasisAppointmentResponse
Differential View
This structure is derived from NoBasisAppointmentResponse
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AppointmentResponse | 0..* | NoBasisAppointmentResponse | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection | |
changeConferenceType | 0..1 | Coding | hn-basis-changeConferenceType URL: http://helsenorge.no/fhir/StructureDefinition/hn-basis-changeConferenceType Binding: No Basis VirtualServiceType Value Set (required) | |
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 | |||
participantType | ||||
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-2: 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 | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
inv-2 | error | AppointmentResponse.actor.identifier | 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. : 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' | |
inv-3 | error | AppointmentResponse.actor.identifier.type.coding | Only FNR or DNR number are allowed as codes to identify patient in this profile. : code = 'FNR' or code = 'DNR' | |
inv-4 | error | AppointmentResponse.participantType.coding | If code is used in a codable consept the system must be used : code > '' implies (system > '' ) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AppointmentResponse | C | 0..* | NoBasisAppointmentResponse | A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection |
implicitRules | ?!ΣN | 0..1 | uri | A set of rules under which this content was created |
shortNotice | N | 0..1 | boolean | no-basis-shortnotice URL: http://hl7.no/fhir/StructureDefinition/no-basis-shortnotice |
extension | N | 0..0 | ||
url | 1..1 | uri | "http://hl7.no/fhir/StructureDefinition/no-basis-shortnotice" | |
changeConferenceType | 0..1 | Coding | hn-basis-changeConferenceType URL: http://helsenorge.no/fhir/StructureDefinition/hn-basis-changeConferenceType Binding: No Basis VirtualServiceType Value Set (required) | |
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 |
use | ?!ΣN | 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 |
appointment | ΣCN | 1..1 | Reference(Appointment) | Appointment this response relates to |
actor | ΣC | 1..1 | Reference(Patient) | Use only logical reference |
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-2: 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 | ?!ΣN | 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 |
participantStatus | ?!ΣN | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
Documentation for this format |
Path | Conformance | ValueSet / Code |
AppointmentResponse.extension:changeConferenceType.value[x] | required | NoBasisVirtualServiceType |
AppointmentResponse.identifier.use | required | IdentifierUse |
AppointmentResponse.actor.type | extensible | Pattern: Patient |
AppointmentResponse.actor.identifier.use | required | IdentifierUse |
AppointmentResponse.participantStatus | required | ParticipationStatus |
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().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 | 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** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-1 | error | AppointmentResponse | The '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-2 | error | AppointmentResponse.actor.identifier | 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. : 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-1 | error | AppointmentResponse.appointment, AppointmentResponse.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')) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
AppointmentResponse | C | 0..* | NoBasisAppointmentResponse | 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 | ΣN | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!ΣN | 0..1 | uri | A set of rules under which this content was created | ||||
language | N | 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 | ||||
shortNotice | N | 0..1 | boolean | 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 | Coding | hn-basis-changeConferenceType URL: http://helsenorge.no/fhir/StructureDefinition/hn-basis-changeConferenceType Binding: No Basis VirtualServiceType Value Set (required) | |||||
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 | ?!ΣN | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | ΣN | 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 | ΣCN | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | ΣCN | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
appointment | ΣCN | 1..1 | Reference(Appointment) | Appointment this response relates to | ||||
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 | ΣN | 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 | ΣN | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | ΣN | 0..1 | string | Text alternative for the resource | ||||
start | N | 0..1 | instant | Time from appointment, or requested new start time | ||||
end | N | 0..1 | instant | Time from appointment, or requested new end time | ||||
participantType | ΣN | 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 | ΣN | 0..1 | string | Plain text representation of the concept | ||||
actor | ΣC | 1..1 | Reference(Patient) | Use only logical reference | ||||
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-2: 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 | ?!ΣN | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | ΣN | 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 | ΣN | 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 | ΣCN | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | ΣCN | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
display | ΣN | 0..1 | string | Text alternative for the resource | ||||
participantStatus | ?!ΣN | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
comment | N | 0..1 | string | Additional comments | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
AppointmentResponse.language | preferred | CommonLanguages
| ||||
AppointmentResponse.extension:changeConferenceType.value[x] | required | NoBasisVirtualServiceType | ||||
AppointmentResponse.identifier.use | required | IdentifierUse | ||||
AppointmentResponse.identifier.type | extensible | Identifier Type Codes | ||||
AppointmentResponse.appointment.type | extensible | ResourceType | ||||
AppointmentResponse.participantType | extensible | ParticipantType | ||||
AppointmentResponse.actor.type | extensible | Pattern: Patient | ||||
AppointmentResponse.actor.identifier.use | required | IdentifierUse | ||||
AppointmentResponse.actor.identifier.type | extensible | Identifier Type Codes | ||||
AppointmentResponse.participantStatus | required | ParticipationStatus |
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().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 | 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** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-1 | error | AppointmentResponse | The '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-2 | error | AppointmentResponse.actor.identifier | 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. : 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' | |
inv-3 | error | AppointmentResponse.actor.identifier.type.coding | Only FNR or DNR number are allowed as codes to identify patient in this profile. : code = 'FNR' or code = 'DNR' | |
inv-4 | error | AppointmentResponse.participantType.coding | If code is used in a codable consept the system must be used : code > '' implies (system > '' ) | |
per-1 | error | AppointmentResponse.identifier.period, AppointmentResponse.actor.identifier.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
ref-1 | error | AppointmentResponse.identifier.assigner, AppointmentResponse.appointment, AppointmentResponse.actor, AppointmentResponse.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 NoBasisAppointmentResponse
Other representations of profile: CSV, Excel, Schematron