{
"description": null,
"_filename": "NHSDigital-Appointment.StructureDefinition.json",
"package_name": "uk.nhsdigital.r4.test",
"date": null,
"derivation": "constraint",
"publisher": null,
"fhirVersion": "4.0.1",
"name": "NHSDigitalAppointment",
"abstract": false,
"type": "Appointment",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "2.16.0-prerelease",
"status": "draft",
"id": "25732dd9-1284-439d-a51c-3757baccf7ed",
"kind": "resource",
"url": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Appointment",
"version": null,
"differential": {
"element": [ {
"id": "Appointment.extension",
"min": 0,
"path": "Appointment.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Appointment.extension:requester",
"max": "1",
"min": 0,
"path": "Appointment.extension",
"type": [ {
"code": "Extension",
"profile": [ "https://fhir.nhs.uk/StructureDefinition/Extension-Provenance-agent" ]
} ],
"sliceName": "requester"
}, {
"id": "Appointment.identifier",
"path": "Appointment.identifier",
"mustSupport": true
}, {
"id": "Appointment.identifier.system",
"min": 1,
"path": "Appointment.identifier.system"
}, {
"id": "Appointment.identifier.value",
"min": 1,
"path": "Appointment.identifier.value"
}, {
"id": "Appointment.status",
"path": "Appointment.status",
"definition": "The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.\r\n\r\n**e-RS**\r\n\r\nWill default to `booked`",
"mustSupport": true
}, {
"id": "Appointment.serviceCategory",
"path": "Appointment.serviceCategory",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "coding.system",
"type": "value"
} ]
}
}, {
"id": "Appointment.serviceCategory.coding.system",
"min": 1,
"path": "Appointment.serviceCategory.coding.system"
}, {
"id": "Appointment.serviceCategory.coding.code",
"min": 1,
"path": "Appointment.serviceCategory.coding.code"
}, {
"id": "Appointment.serviceCategory:NHSDataDictionaryTreatmentFunction",
"path": "Appointment.serviceCategory",
"sliceName": "NHSDataDictionaryTreatmentFunction"
}, {
"id": "Appointment.serviceCategory:NHSDataDictionaryTreatmentFunction.coding",
"path": "Appointment.serviceCategory.coding",
"binding": {
"strength": "required",
"valueSet": "https://fhir.nhs.uk/ValueSet/NHSDigital-CareSettingType"
}
}, {
"id": "Appointment.serviceCategory:NHSDataDictionaryTreatmentFunction.coding.system",
"path": "Appointment.serviceCategory.coding.system",
"fixedUri": "https://fhir.nhs.uk/CodeSystem/NHSDataModelAndDictionary-treatment-function"
}, {
"id": "Appointment.serviceCategory:eRSClinicType",
"max": "1",
"path": "Appointment.serviceCategory",
"sliceName": "eRSClinicType"
}, {
"id": "Appointment.serviceCategory:eRSClinicType.coding",
"path": "Appointment.serviceCategory.coding",
"binding": {
"strength": "required",
"valueSet": "https://fhir.nhs.uk/ValueSet/NHSDigital-eRS-ClinicType"
}
}, {
"id": "Appointment.serviceCategory:eRSClinicType.coding.system",
"path": "Appointment.serviceCategory.coding.system",
"fixedUri": "https://fhir.nhs.uk/CodeSystem/NHSDigital-ClinicType"
}, {
"id": "Appointment.serviceType",
"path": "Appointment.serviceType",
"binding": {
"strength": "required",
"valueSet": "https://fhir.nhs.uk/ValueSet/NHSDigital-CareSettingType"
},
"definition": "UKCore will probably use this ValueSet https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType\r\n\r\nAt present we will base this on NHS Data Dictionary ValueSet"
}, {
"id": "Appointment.specialty",
"path": "Appointment.specialty",
"binding": {
"strength": "required",
"valueSet": "https://fhir.nhs.uk/ValueSet/NHSDataModelAndDictionary-clinical-specialty",
"description": "NHS Dictionary Main Specialty"
}
}, {
"id": "Appointment.reasonCode",
"path": "Appointment.reasonCode",
"mustSupport": true
}, {
"id": "Appointment.start",
"min": 1,
"path": "Appointment.start",
"short": "Appointment Start Date Time",
"definition": "Date time of the current appointment booking (if there is a current appointment booking to a Directly Bookable Service)\r\n\r\n```json\r\n \"start\": \"2021-06-13T12:30:00+00:00\",\r\n```",
"mustSupport": true
}, {
"id": "Appointment.end",
"min": 1,
"path": "Appointment.end",
"short": "Appointment End Date Time",
"definition": "Date/Time that the appointment is to conclude.\r\n\r\n```json\r\n\"end\": \"2021-06-13T12:45:00+00:00\",\r\n```",
"mustSupport": true
}, {
"id": "Appointment.slot",
"path": "Appointment.slot",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "identifier.system",
"type": "value"
} ]
},
"mustSupport": true
}, {
"id": "Appointment.slot:alternativeSlot",
"max": "1",
"path": "Appointment.slot",
"sliceName": "alternativeSlot",
"definition": "```json\r\n \"slot\": [\r\n {\r\n \"identifier\": {\r\n \"system\": \"https://fhir.nhs.uk/CodeSystem/unique-slot-reference-number\",\r\n \"value\": \"USRN-12000001\"\r\n }\r\n }\r\n ],\r\n```"
}, {
"id": "Appointment.slot:alternativeSlot.identifier.system",
"path": "Appointment.slot.identifier.system",
"fixedUri": "https://fhir.nhs.uk/CodeSystem/unique-slot-reference-number"
}, {
"id": "Appointment.basedOn",
"path": "Appointment.basedOn",
"type": [ {
"code": "Reference",
"targetProfile": [ "https://fhir.nhs.uk/StructureDefinition/NHSDigital-ServiceRequest" ]
} ],
"definition": "The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).\r\n\r\n```json\r\n\"basedOn\": [\r\n {\r\n \"reference\": \"https://server.fire.ly/ServiceRequest/6c2a1f9b-2517-419d-9099-591ba63f176c\"\r\n }\r\n ],\r\n```",
"mustSupport": true
}, {
"id": "Appointment.basedOn.identifier",
"path": "Appointment.basedOn.identifier",
"mustSupport": true
}, {
"id": "Appointment.basedOn.identifier.system",
"min": 1,
"path": "Appointment.basedOn.identifier.system"
}, {
"id": "Appointment.basedOn.identifier.value",
"min": 1,
"path": "Appointment.basedOn.identifier.value"
}, {
"id": "Appointment.participant",
"path": "Appointment.participant",
"definition": "List of participants involved in the appointment.\r\n\r\nThis should include a Patient and a HealthcareService\r\n\r\n```json\r\n \"participant\": [\r\n {\r\n \"actor\": {\r\n \"identifier\": {\r\n \"system\": \"https://fhir.nhs.uk/Id/ers-service\",\r\n \"value\": \"11002\"\r\n }\r\n },\r\n \"status\": \"accepted\"\r\n },\r\n {\r\n \"actor\": {\r\n \"identifier\": {\r\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\r\n \"value\": \"9912003888\"\r\n }\r\n },\r\n \"status\": \"accepted\"\r\n }\r\n ]\r\n```",
"mustSupport": true
}, {
"id": "Appointment.participant.actor",
"min": 1,
"path": "Appointment.participant.actor",
"type": [ {
"code": "Reference",
"targetProfile": [ "https://fhir.nhs.uk/StructureDefinition/NHSDigital-HealthcareService", "https://fhir.nhs.uk/StructureDefinition/NHSDigital-PractitionerRole-Minimal", "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Patient", "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Location", "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Practitioner" ]
} ],
"constraint": [ {
"key": "participant",
"human": "An identifier reference or resource reference must be provided",
"source": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Appointment",
"severity": "error",
"expression": "(reference.exists() or identifier.exists())"
} ],
"mustSupport": true
}, {
"id": "Appointment.participant.actor.identifier.system",
"min": 1,
"path": "Appointment.participant.actor.identifier.system"
}, {
"id": "Appointment.participant.actor.identifier.value",
"min": 1,
"path": "Appointment.participant.actor.identifier.value"
} ]
},
"baseDefinition": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Appointment"
}