- SDS-Device
- SDS-Endpoint
- Spine-OperationOutcome
- NHSDigital-CapabilityStatement
- NHSDigital-CommunicationRequest
- NHSDigital-HealthcareService
- NHSDigital-Immunization
- NHSDigital-MessageHeader
- NHSDigital-Observation
- NHSDigital-OperationOutcome
- NHSDigital-Organization
- NHSDigital-Patient
- NHSDigital-Practitioner
- NHSDigital-PractitionerRole
- NHSDigital-DocumentReference
- NHSDigital-Encounter
- NHSDigital-Composition
- NHSDigital-Flag
- NHSDigital-Bundle
- NHSDigital-Questionnaire
- NHSDigital-QuestionnaireResponse
- NHSDigital-ImmunizationRecommendation
- NHSDigital-Task
- NHSDigital-Provenance
- NHSDigital-Location
- NHSDigital-OperationDefinition
- NHSDigital-MessageDefinition
- NHSDigital-ServiceRequest
- NHSDigital-Appointment
- England-Slot
- NHSDigital-Binary
- England-Parameters-SubscriptionStatus
Profiles
- Profiles
- SDS-Device
- SDS-Endpoint
- Spine-OperationOutcome
- NHSDigital-CapabilityStatement
- NHSDigital-CommunicationRequest
- NHSDigital-HealthcareService
- NHSDigital-Immunization
- NHSDigital-MessageHeader
- NHSDigital-Observation
- NHSDigital-OperationOutcome
- NHSDigital-Organization
- NHSDigital-Patient
- NHSDigital-Practitioner
- NHSDigital-PractitionerRole
- NHSDigital-DocumentReference
- NHSDigital-Encounter
- NHSDigital-Composition
- NHSDigital-Flag
- NHSDigital-Bundle
- NHSDigital-Questionnaire
- NHSDigital-QuestionnaireResponse
- NHSDigital-ImmunizationRecommendation
- NHSDigital-Task
- NHSDigital-Provenance
- NHSDigital-Location
- NHSDigital-OperationDefinition
- NHSDigital-MessageDefinition
- NHSDigital-ServiceRequest
- NHSDigital-Appointment
- England-Slot
- NHSDigital-Binary
- England-Parameters-SubscriptionStatus
SDS-Device
Conformance url |
---|
https://fhir.nhs.uk/StructureDefinition/SDS-Device |
with Device
Device | I | Device | There are no (further) constraints on this element Element IdDevice Item used in healthcare DefinitionA type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.
| |
extension | I | 0..* | Extension | Element IdDevice.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
managingOrganisation | S I | 1..1 | Extension(Reference()) | Element IdDevice.extension:managingOrganisation Managing or manufacturing organisation providing an Accredited System Alternate namesextensions, user content DefinitionODS reference that represents the managing or manufacturing organisation providing an Accredited System Reference to the managing, manufacturing or supplying organisation of an Accredited System. https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ManagingOrganisation Constraints
|
identifier | S | 0..* | Identifier | Element IdDevice.identifier Instance identifier DefinitionUnique instance identifiers assigned to a device by manufacturers other organizations or owners. The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used. Unordered, Open, by system(Value) Constraints
|
NhsSpineASID | S | 1..1 | Identifier | Element IdDevice.identifier:NhsSpineASID NHS Spine Accredited System Identifier DefinitionUnique instance identifiers assigned to a device by manufacturers other organizations or owners. The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.identifier:NhsSpineASID.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdDevice.identifier:NhsSpineASID.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uriFixed Value | Element IdDevice.identifier:NhsSpineASID.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/nhsSpineASID
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.identifier:NhsSpineASID.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdDevice.identifier:NhsSpineASID.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdDevice.identifier:NhsSpineASID.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
NhsMhsPartyKey | S | 1..1 | Identifier | Element IdDevice.identifier:NhsMhsPartyKey Nhs Mhs Party Key DefinitionUnique instance identifiers assigned to a device by manufacturers other organizations or owners. The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.identifier:NhsMhsPartyKey.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdDevice.identifier:NhsMhsPartyKey.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uriFixed Value | Element IdDevice.identifier:NhsMhsPartyKey.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/nhsMhsPartyKey
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.identifier:NhsMhsPartyKey.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdDevice.identifier:NhsMhsPartyKey.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdDevice.identifier:NhsMhsPartyKey.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
NhsEndpointServiceId | S | 1..1 | Identifier | Element IdDevice.identifier:NhsEndpointServiceId NHS Endpoint Service Id DefinitionUnique instance identifiers assigned to a device by manufacturers other organizations or owners. The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.identifier:NhsEndpointServiceId.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdDevice.identifier:NhsEndpointServiceId.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uriFixed Value | Element IdDevice.identifier:NhsEndpointServiceId.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/nhsEndpointServiceId
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.identifier:NhsEndpointServiceId.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdDevice.identifier:NhsEndpointServiceId.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdDevice.identifier:NhsEndpointServiceId.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
definition | I | 0..1 | Reference(DeviceDefinition) | There are no (further) constraints on this element Element IdDevice.definition The reference to the definition for the device DefinitionThe reference to the definition for the device. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
udiCarrier | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element IdDevice.udiCarrier Unique Device Identifier (UDI) Barcode string DefinitionUnique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold. UDI may identify an unique instance of a device, or it may only identify the type of the device. See UDI mappings for a complete mapping of UDI parts to Device.
|
deviceIdentifier | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.udiCarrier.deviceIdentifier Mandatory fixed portion of UDI Alternate namesDI DefinitionThe device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device. Note that FHIR strings SHALL NOT exceed 1MB in size
|
issuer | 0..1 | uri | There are no (further) constraints on this element Element IdDevice.udiCarrier.issuer UDI Issuing Organization Alternate namesBarcode System DefinitionOrganization that is charged with issuing UDIs for devices. For example, the US FDA issuers include :
see http://en.wikipedia.org/wiki/Uniform_resource_identifier
| |
jurisdiction | 0..1 | uri | There are no (further) constraints on this element Element IdDevice.udiCarrier.jurisdiction Regional UDI authority DefinitionThe identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi. Allows a recipient of a UDI to know which database will contain the UDI-associated metadata. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
| |
carrierAIDC | Σ | 0..1 | base64Binary | There are no (further) constraints on this element Element IdDevice.udiCarrier.carrierAIDC UDI Machine Readable Barcode String Alternate namesAutomatic Identification and Data Capture DefinitionThe full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats SHALL be base64 encoded. The AIDC form of UDIs should be scanned or otherwise used for the identification of the device whenever possible to minimize errors in records resulting from manual transcriptions. If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.
|
carrierHRF | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.udiCarrier.carrierHRF UDI Human Readable Barcode String Alternate namesHuman Readable Form DefinitionThe full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device. If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.
|
entryType | 0..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.udiCarrier.entryType barcode | rfid | manual + DefinitionA coded entry to indicate how the data was entered. Supports a way to distinguish hand entered from machine read data. Note that FHIR strings SHALL NOT exceed 1MB in size Codes to identify how UDI data was entered. UDIEntryType (required)Constraints
| |
status | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.status active | inactive | entered-in-error | unknown DefinitionStatus of the Device availability. This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the device (record)as not currently valid. The availability status of the device. FHIRDeviceStatus (required)Constraints
|
statusReason | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdDevice.statusReason online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off DefinitionReason for the dtatus of the Device availability. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The availability status reason of the device. FHIRDeviceStatusReason (extensible)Constraints
| |
distinctIdentifier | 0..1 | string | There are no (further) constraints on this element Element IdDevice.distinctIdentifier The distinct identification string Alternate namesDistinct Identification Code (DIC) DefinitionThe distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product. For example, this applies to devices in the United States regulated under Code of Federal Regulation 21CFR§1271.290(c).
| |
manufacturer | 0..1 | string | There are no (further) constraints on this element Element IdDevice.manufacturer Name of device manufacturer DefinitionA name of the manufacturer. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
manufactureDate | 0..1 | dateTime | There are no (further) constraints on this element Element IdDevice.manufactureDate Date when the device was made DefinitionThe date and time when the device was manufactured.
| |
expirationDate | 0..1 | dateTime | There are no (further) constraints on this element Element IdDevice.expirationDate Date and time of expiry of this device (if applicable) DefinitionThe date and time beyond which this device is no longer valid or should not be used (if applicable).
| |
lotNumber | 0..1 | string | There are no (further) constraints on this element Element IdDevice.lotNumber Lot number of manufacture DefinitionLot number assigned by the manufacturer. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
serialNumber | 0..1 | string | There are no (further) constraints on this element Element IdDevice.serialNumber Serial number assigned by the manufacturer DefinitionThe serial number assigned by the organization when the device was manufactured. Alphanumeric Maximum 20.
| |
deviceName | 0..* | BackboneElement | There are no (further) constraints on this element Element IdDevice.deviceName The name of the device as given by the manufacturer DefinitionThis represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.
| |
name | 1..1 | string | There are no (further) constraints on this element Element IdDevice.deviceName.name The name of the device Alternate namesΣ DefinitionThe name of the device. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
type | 1..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.deviceName.type udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other DefinitionThe type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName. Note that FHIR strings SHALL NOT exceed 1MB in size The type of name the device is referred by. DeviceNameType (required)Constraints
| |
modelNumber | 0..1 | string | There are no (further) constraints on this element Element IdDevice.modelNumber The model number for the device DefinitionThe model number for the device. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
partNumber | 0..1 | string | There are no (further) constraints on this element Element IdDevice.partNumber The part number of the device DefinitionThe part number of the device. Alphanumeric Maximum 20.
| |
type | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdDevice.type The kind or type of device DefinitionThe kind or type of device. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes to identify medical devices. DeviceType (example)Constraints
| |
specialization | 0..* | BackboneElement | There are no (further) constraints on this element Element IdDevice.specialization The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication DefinitionThe capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
| |
systemType | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdDevice.specialization.systemType The standard that is used to operate and communicate Alternate namesΣ DefinitionThe standard that is used to operate and communicate. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
| |
version | 0..1 | string | There are no (further) constraints on this element Element IdDevice.specialization.version The version of the standard that is used to operate and communicate DefinitionThe version of the standard that is used to operate and communicate. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
version | 0..* | BackboneElement | There are no (further) constraints on this element Element IdDevice.version The actual design of the device or software version running on the device DefinitionThe actual design of the device or software version running on the device.
| |
type | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdDevice.version.type The type of the device version Alternate namesΣ DefinitionThe type of the device version. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
| |
component | 0..1 | Identifier | There are no (further) constraints on this element Element IdDevice.version.component A single component of the device version DefinitionA single component of the device version.
| |
value | 1..1 | string | There are no (further) constraints on this element Element IdDevice.version.value The version text DefinitionThe version text. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
property | 0..* | BackboneElement | There are no (further) constraints on this element Element IdDevice.property The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties DefinitionThe actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
| |
type | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdDevice.property.type Code that specifies the property DeviceDefinitionPropetyCode (Extensible) DefinitionCode that specifies the property DeviceDefinitionPropetyCode (Extensible). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
| |
valueQuantity | I | 0..* | Quantity | There are no (further) constraints on this element Element IdDevice.property.valueQuantity Property value as a quantity DefinitionProperty value as a quantity. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
valueCode | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdDevice.property.valueCode Property value as a code, e.g., NTP4 (synced to NTP) DefinitionProperty value as a code, e.g., NTP4 (synced to NTP). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
| |
patient | I | 0..1 | Reference(Patient) | There are no (further) constraints on this element Element IdDevice.patient Patient to whom Device is affixed DefinitionPatient information, If the device is affixed to a person. If the device is implanted in a patient, then need to associate the device to the patient. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
owner | S I | 1..1 | Reference(Organization) | There are no (further) constraints on this element Element IdDevice.owner Organization responsible for device DefinitionAn organization that is responsible for the provision and ongoing maintenance of the device. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
contact | I | 0..* | ContactPoint | There are no (further) constraints on this element Element IdDevice.contact Details for human/organization for support DefinitionContact details for an organization or a particular human that is responsible for the device. used for troubleshooting etc.
|
location | I | 0..1 | Reference(Location) | There are no (further) constraints on this element Element IdDevice.location Where the device is found DefinitionThe place where the device can be found. Device.location can be used to track device location. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
url | 0..1 | uri | There are no (further) constraints on this element Element IdDevice.url Network address to contact device DefinitionA network address on which the device may be contacted directly. If the device is running a FHIR server, the network address should be the Base URL from which a conformance statement may be retrieved.
| |
note | 0..* | Annotation | There are no (further) constraints on this element Element IdDevice.note Device notes and comments DefinitionDescriptive information, usage information or implantation information that is not captured in an existing element. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
| |
safety | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdDevice.safety Safety Characteristics of Device DefinitionProvides additional safety characteristics about a medical device. For example devices containing latex. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
|
parent | I | 0..1 | Reference(Device) | There are no (further) constraints on this element Element IdDevice.parent The parent device DefinitionThe parent device. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
from Device
Device | I | Device | There are no (further) constraints on this element Element IdDevice Item used in healthcare DefinitionA type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.
| |
extension | I | 0..* | Extension | Element IdDevice.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
managingOrganisation | S I | 1..1 | Extension(Reference()) | Element IdDevice.extension:managingOrganisation Managing or manufacturing organisation providing an Accredited System Alternate namesextensions, user content DefinitionODS reference that represents the managing or manufacturing organisation providing an Accredited System Reference to the managing, manufacturing or supplying organisation of an Accredited System. https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ManagingOrganisation Constraints
|
identifier | S | 0..* | Identifier | Element IdDevice.identifier Instance identifier DefinitionUnique instance identifiers assigned to a device by manufacturers other organizations or owners. The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used. Unordered, Open, by system(Value) Constraints
|
NhsSpineASID | S | 1..1 | Identifier | Element IdDevice.identifier:NhsSpineASID NHS Spine Accredited System Identifier DefinitionUnique instance identifiers assigned to a device by manufacturers other organizations or owners. The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.identifier:NhsSpineASID.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdDevice.identifier:NhsSpineASID.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uriFixed Value | Element IdDevice.identifier:NhsSpineASID.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/nhsSpineASID
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.identifier:NhsSpineASID.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdDevice.identifier:NhsSpineASID.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdDevice.identifier:NhsSpineASID.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
NhsMhsPartyKey | S | 1..1 | Identifier | Element IdDevice.identifier:NhsMhsPartyKey Nhs Mhs Party Key DefinitionUnique instance identifiers assigned to a device by manufacturers other organizations or owners. The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.identifier:NhsMhsPartyKey.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdDevice.identifier:NhsMhsPartyKey.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uriFixed Value | Element IdDevice.identifier:NhsMhsPartyKey.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/nhsMhsPartyKey
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.identifier:NhsMhsPartyKey.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdDevice.identifier:NhsMhsPartyKey.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdDevice.identifier:NhsMhsPartyKey.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
NhsEndpointServiceId | S | 1..1 | Identifier | Element IdDevice.identifier:NhsEndpointServiceId NHS Endpoint Service Id DefinitionUnique instance identifiers assigned to a device by manufacturers other organizations or owners. The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.identifier:NhsEndpointServiceId.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdDevice.identifier:NhsEndpointServiceId.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uriFixed Value | Element IdDevice.identifier:NhsEndpointServiceId.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/nhsEndpointServiceId
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.identifier:NhsEndpointServiceId.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdDevice.identifier:NhsEndpointServiceId.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdDevice.identifier:NhsEndpointServiceId.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
definition | I | 0..1 | Reference(DeviceDefinition) | There are no (further) constraints on this element Element IdDevice.definition The reference to the definition for the device DefinitionThe reference to the definition for the device. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
udiCarrier | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element IdDevice.udiCarrier Unique Device Identifier (UDI) Barcode string DefinitionUnique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold. UDI may identify an unique instance of a device, or it may only identify the type of the device. See UDI mappings for a complete mapping of UDI parts to Device.
|
deviceIdentifier | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.udiCarrier.deviceIdentifier Mandatory fixed portion of UDI Alternate namesDI DefinitionThe device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device. Note that FHIR strings SHALL NOT exceed 1MB in size
|
issuer | 0..1 | uri | There are no (further) constraints on this element Element IdDevice.udiCarrier.issuer UDI Issuing Organization Alternate namesBarcode System DefinitionOrganization that is charged with issuing UDIs for devices. For example, the US FDA issuers include :
see http://en.wikipedia.org/wiki/Uniform_resource_identifier
| |
jurisdiction | 0..1 | uri | There are no (further) constraints on this element Element IdDevice.udiCarrier.jurisdiction Regional UDI authority DefinitionThe identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi. Allows a recipient of a UDI to know which database will contain the UDI-associated metadata. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
| |
carrierAIDC | Σ | 0..1 | base64Binary | There are no (further) constraints on this element Element IdDevice.udiCarrier.carrierAIDC UDI Machine Readable Barcode String Alternate namesAutomatic Identification and Data Capture DefinitionThe full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats SHALL be base64 encoded. The AIDC form of UDIs should be scanned or otherwise used for the identification of the device whenever possible to minimize errors in records resulting from manual transcriptions. If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.
|
carrierHRF | Σ | 0..1 | string | There are no (further) constraints on this element Element IdDevice.udiCarrier.carrierHRF UDI Human Readable Barcode String Alternate namesHuman Readable Form DefinitionThe full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device. If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.
|
entryType | 0..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.udiCarrier.entryType barcode | rfid | manual + DefinitionA coded entry to indicate how the data was entered. Supports a way to distinguish hand entered from machine read data. Note that FHIR strings SHALL NOT exceed 1MB in size Codes to identify how UDI data was entered. UDIEntryType (required)Constraints
| |
status | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.status active | inactive | entered-in-error | unknown DefinitionStatus of the Device availability. This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the device (record)as not currently valid. The availability status of the device. FHIRDeviceStatus (required)Constraints
|
statusReason | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdDevice.statusReason online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off DefinitionReason for the dtatus of the Device availability. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The availability status reason of the device. FHIRDeviceStatusReason (extensible)Constraints
| |
distinctIdentifier | 0..1 | string | There are no (further) constraints on this element Element IdDevice.distinctIdentifier The distinct identification string Alternate namesDistinct Identification Code (DIC) DefinitionThe distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product. For example, this applies to devices in the United States regulated under Code of Federal Regulation 21CFR§1271.290(c).
| |
manufacturer | 0..1 | string | There are no (further) constraints on this element Element IdDevice.manufacturer Name of device manufacturer DefinitionA name of the manufacturer. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
manufactureDate | 0..1 | dateTime | There are no (further) constraints on this element Element IdDevice.manufactureDate Date when the device was made DefinitionThe date and time when the device was manufactured.
| |
expirationDate | 0..1 | dateTime | There are no (further) constraints on this element Element IdDevice.expirationDate Date and time of expiry of this device (if applicable) DefinitionThe date and time beyond which this device is no longer valid or should not be used (if applicable).
| |
lotNumber | 0..1 | string | There are no (further) constraints on this element Element IdDevice.lotNumber Lot number of manufacture DefinitionLot number assigned by the manufacturer. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
serialNumber | 0..1 | string | There are no (further) constraints on this element Element IdDevice.serialNumber Serial number assigned by the manufacturer DefinitionThe serial number assigned by the organization when the device was manufactured. Alphanumeric Maximum 20.
| |
deviceName | 0..* | BackboneElement | There are no (further) constraints on this element Element IdDevice.deviceName The name of the device as given by the manufacturer DefinitionThis represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.
| |
name | 1..1 | string | There are no (further) constraints on this element Element IdDevice.deviceName.name The name of the device Alternate namesΣ DefinitionThe name of the device. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
type | 1..1 | codeBinding | There are no (further) constraints on this element Element IdDevice.deviceName.type udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other DefinitionThe type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName. Note that FHIR strings SHALL NOT exceed 1MB in size The type of name the device is referred by. DeviceNameType (required)Constraints
| |
modelNumber | 0..1 | string | There are no (further) constraints on this element Element IdDevice.modelNumber The model number for the device DefinitionThe model number for the device. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
partNumber | 0..1 | string | There are no (further) constraints on this element Element IdDevice.partNumber The part number of the device DefinitionThe part number of the device. Alphanumeric Maximum 20.
| |
type | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdDevice.type The kind or type of device DefinitionThe kind or type of device. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes to identify medical devices. DeviceType (example)Constraints
| |
specialization | 0..* | BackboneElement | There are no (further) constraints on this element Element IdDevice.specialization The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication DefinitionThe capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
| |
systemType | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdDevice.specialization.systemType The standard that is used to operate and communicate Alternate namesΣ DefinitionThe standard that is used to operate and communicate. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
| |
version | 0..1 | string | There are no (further) constraints on this element Element IdDevice.specialization.version The version of the standard that is used to operate and communicate DefinitionThe version of the standard that is used to operate and communicate. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
version | 0..* | BackboneElement | There are no (further) constraints on this element Element IdDevice.version The actual design of the device or software version running on the device DefinitionThe actual design of the device or software version running on the device.
| |
type | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdDevice.version.type The type of the device version Alternate namesΣ DefinitionThe type of the device version. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
| |
component | 0..1 | Identifier | There are no (further) constraints on this element Element IdDevice.version.component A single component of the device version DefinitionA single component of the device version.
| |
value | 1..1 | string | There are no (further) constraints on this element Element IdDevice.version.value The version text DefinitionThe version text. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
property | 0..* | BackboneElement | There are no (further) constraints on this element Element IdDevice.property The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties DefinitionThe actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
| |
type | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdDevice.property.type Code that specifies the property DeviceDefinitionPropetyCode (Extensible) DefinitionCode that specifies the property DeviceDefinitionPropetyCode (Extensible). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
| |
valueQuantity | I | 0..* | Quantity | There are no (further) constraints on this element Element IdDevice.property.valueQuantity Property value as a quantity DefinitionProperty value as a quantity. The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
|
valueCode | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdDevice.property.valueCode Property value as a code, e.g., NTP4 (synced to NTP) DefinitionProperty value as a code, e.g., NTP4 (synced to NTP). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
| |
patient | I | 0..1 | Reference(Patient) | There are no (further) constraints on this element Element IdDevice.patient Patient to whom Device is affixed DefinitionPatient information, If the device is affixed to a person. If the device is implanted in a patient, then need to associate the device to the patient. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
owner | S I | 1..1 | Reference(Organization) | There are no (further) constraints on this element Element IdDevice.owner Organization responsible for device DefinitionAn organization that is responsible for the provision and ongoing maintenance of the device. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
contact | I | 0..* | ContactPoint | There are no (further) constraints on this element Element IdDevice.contact Details for human/organization for support DefinitionContact details for an organization or a particular human that is responsible for the device. used for troubleshooting etc.
|
location | I | 0..1 | Reference(Location) | There are no (further) constraints on this element Element IdDevice.location Where the device is found DefinitionThe place where the device can be found. Device.location can be used to track device location. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
url | 0..1 | uri | There are no (further) constraints on this element Element IdDevice.url Network address to contact device DefinitionA network address on which the device may be contacted directly. If the device is running a FHIR server, the network address should be the Base URL from which a conformance statement may be retrieved.
| |
note | 0..* | Annotation | There are no (further) constraints on this element Element IdDevice.note Device notes and comments DefinitionDescriptive information, usage information or implantation information that is not captured in an existing element. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
| |
safety | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdDevice.safety Safety Characteristics of Device DefinitionProvides additional safety characteristics about a medical device. For example devices containing latex. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
|
parent | I | 0..1 | Reference(Device) | There are no (further) constraints on this element Element IdDevice.parent The parent device DefinitionThe parent device. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
SDS-Endpoint
Conformance url |
---|
https://fhir.nhs.uk/StructureDefinition/SDS-Endpoint |
with Endpoint
Endpoint | I | Endpoint | There are no (further) constraints on this element Element IdEndpoint The technical details of an endpoint that can be used for electronic services DefinitionThe technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.
| |
extension | I | 0..* | Extension | Element IdEndpoint.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
ExtensionSDSReliabilityConfiguration | S I | 0..1 | Extension(Complex) | Element IdEndpoint.extension:ExtensionSDSReliabilityConfiguration Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Complex) Extension URLhttps://fhir.nhs.uk/StructureDefinition/Extension-SDS-ReliabilityConfiguration Constraints
|
identifier | S Σ | 0..* | Identifier | Element IdEndpoint.identifier Identifies this endpoint across multiple systems DefinitionIdentifier for the organization that is used to identify the endpoint across multiple disparate systems. Unordered, Open, by system(Value) Constraints
|
NhsEndpointServiceId | Σ | 1..1 | Identifier | Element IdEndpoint.identifier:NhsEndpointServiceId NHS Endpoint Service Id DefinitionIdentifier for the service that is used to identify the endpoint across multiple disparate systems.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsEndpointServiceId.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsEndpointServiceId.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uriFixed Value | Element IdEndpoint.identifier:NhsEndpointServiceId.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/nhsEndpointServiceId
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsEndpointServiceId.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsEndpointServiceId.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsEndpointServiceId.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
NhsMhsFQDN | Σ | 1..1 | Identifier | Element IdEndpoint.identifier:NhsMhsFQDN NHS Message Handling Service Fully Qualified Domain Name DefinitionIdentifier for the service that is used to identify the endpoint across multiple disparate systems.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsFQDN.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsFQDN.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uriFixed Value | Element IdEndpoint.identifier:NhsMhsFQDN.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/nhsMhsFQDN
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsFQDN.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsFQDN.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsFQDN.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
NhsMhsPartyKey | Σ | 1..1 | Identifier | Element IdEndpoint.identifier:NhsMhsPartyKey NHS Message Handling Service Party Key DefinitionIdentifier for the service that is used to identify the endpoint across multiple disparate systems.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsPartyKey.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsPartyKey.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uriFixed Value | Element IdEndpoint.identifier:NhsMhsPartyKey.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/nhsMhsPartyKey
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsPartyKey.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsPartyKey.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsPartyKey.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
NhsMhsCPAId | Σ | 1..1 | Identifier | Element IdEndpoint.identifier:NhsMhsCPAId NHS Message Handling Service CPA Identifier DefinitionIdentifier for the service that is used to identify the endpoint across multiple disparate systems.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsCPAId.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsCPAId.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uriFixed Value | Element IdEndpoint.identifier:NhsMhsCPAId.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/nhsMhsCPAId
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsCPAId.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsCPAId.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsCPAId.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
NhsSpineASID | Σ | 1..* | Identifier | Element IdEndpoint.identifier:NhsSpineASID NHS Spine Accredited System Identifier DefinitionIdentifier for the organization that is used to identify the endpoint across multiple disparate systems.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsSpineASID.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsSpineASID.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uriFixed Value | Element IdEndpoint.identifier:NhsSpineASID.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/nhsSpineASID
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsSpineASID.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsSpineASID.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsSpineASID.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdEndpoint.status active | suspended | error | off | entered-in-error | test Definitionactive | suspended | error | off | test. This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid. The status of the endpoint. EndpointStatus (required)Constraints
|
connectionType | S Σ | 1..1 | CodingBinding | There are no (further) constraints on this element Element IdEndpoint.connectionType Protocol/Profile/Standard to be used with this endpoint connection DefinitionA coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook). For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example. EndpointConnectionType (extensible) Constraints
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element IdEndpoint.name A name that this endpoint can be identified by DefinitionA friendly name that this endpoint can be referred to with. Note that FHIR strings SHALL NOT exceed 1MB in size
|
managingOrganization | S Σ I | 1..1 | Reference(Organization) | There are no (further) constraints on this element Element IdEndpoint.managingOrganization Organization that manages this endpoint (might not be the organization that exposes the endpoint) DefinitionThe organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data). This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an applicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy.
|
contact | I | 0..* | ContactPoint | There are no (further) constraints on this element Element IdEndpoint.contact Contact details for source (e.g. troubleshooting) DefinitionContact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdEndpoint.period Interval the endpoint is expected to be operational DefinitionThe interval during which the endpoint is expected to be operational. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
payloadType | S Σ | 1..* | CodeableConcept | There are no (further) constraints on this element Element IdEndpoint.payloadType The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) DefinitionThe payload type describes the acceptable content that can be communicated on the endpoint. The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan.
|
coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element IdEndpoint.payloadType.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | Σ | 1..1 | uriFixed Value | Element IdEndpoint.payloadType.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
http://terminology.hl7.org/CodeSystem/endpoint-payload-type
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdEndpoint.payloadType.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | Σ | 1..1 | codeFixed Value | Element IdEndpoint.payloadType.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
any
|
display | Σ | 1..1 | stringFixed Value | Element IdEndpoint.payloadType.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
Any
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdEndpoint.payloadType.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdEndpoint.payloadType.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
payloadMimeType | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element IdEndpoint.payloadMimeType Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) DefinitionThe mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType). Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured. The mime type of an attachment. Any valid mime type is allowed. Mime Types (required)Constraints
|
address | S Σ | 1..1 | url | Element IdEndpoint.address The technical base address, NhsMhsEndPoint, for connecting to this endpoint DefinitionThe uri that describes the actual end-point to connect to. Represents the NHS Message Handling System (MHS) EndPoint. For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs) This address will be to the service base, without any parameters, or sub-services or resources tacked on. E.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs" and not "https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...".
|
header | 0..* | string | There are no (further) constraints on this element Element IdEndpoint.header Usage depends on the channel type DefinitionAdditional headers / information to send as part of the notification. Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.
|
from Endpoint
Endpoint | I | Endpoint | There are no (further) constraints on this element Element IdEndpoint The technical details of an endpoint that can be used for electronic services DefinitionThe technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.
| |
extension | I | 0..* | Extension | Element IdEndpoint.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
ExtensionSDSReliabilityConfiguration | S I | 0..1 | Extension(Complex) | Element IdEndpoint.extension:ExtensionSDSReliabilityConfiguration Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Complex) Extension URLhttps://fhir.nhs.uk/StructureDefinition/Extension-SDS-ReliabilityConfiguration Constraints
|
identifier | S Σ | 0..* | Identifier | Element IdEndpoint.identifier Identifies this endpoint across multiple systems DefinitionIdentifier for the organization that is used to identify the endpoint across multiple disparate systems. Unordered, Open, by system(Value) Constraints
|
NhsEndpointServiceId | Σ | 1..1 | Identifier | Element IdEndpoint.identifier:NhsEndpointServiceId NHS Endpoint Service Id DefinitionIdentifier for the service that is used to identify the endpoint across multiple disparate systems.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsEndpointServiceId.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsEndpointServiceId.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uriFixed Value | Element IdEndpoint.identifier:NhsEndpointServiceId.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/nhsEndpointServiceId
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsEndpointServiceId.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsEndpointServiceId.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsEndpointServiceId.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
NhsMhsFQDN | Σ | 1..1 | Identifier | Element IdEndpoint.identifier:NhsMhsFQDN NHS Message Handling Service Fully Qualified Domain Name DefinitionIdentifier for the service that is used to identify the endpoint across multiple disparate systems.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsFQDN.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsFQDN.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uriFixed Value | Element IdEndpoint.identifier:NhsMhsFQDN.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/nhsMhsFQDN
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsFQDN.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsFQDN.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsFQDN.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
NhsMhsPartyKey | Σ | 1..1 | Identifier | Element IdEndpoint.identifier:NhsMhsPartyKey NHS Message Handling Service Party Key DefinitionIdentifier for the service that is used to identify the endpoint across multiple disparate systems.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsPartyKey.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsPartyKey.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uriFixed Value | Element IdEndpoint.identifier:NhsMhsPartyKey.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/nhsMhsPartyKey
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsPartyKey.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsPartyKey.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsPartyKey.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
NhsMhsCPAId | Σ | 1..1 | Identifier | Element IdEndpoint.identifier:NhsMhsCPAId NHS Message Handling Service CPA Identifier DefinitionIdentifier for the service that is used to identify the endpoint across multiple disparate systems.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsCPAId.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsCPAId.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uriFixed Value | Element IdEndpoint.identifier:NhsMhsCPAId.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/nhsMhsCPAId
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsCPAId.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsCPAId.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsMhsCPAId.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
NhsSpineASID | Σ | 1..* | Identifier | Element IdEndpoint.identifier:NhsSpineASID NHS Spine Accredited System Identifier DefinitionIdentifier for the organization that is used to identify the endpoint across multiple disparate systems.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsSpineASID.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsSpineASID.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | Σ | 0..1 | uriFixed Value | Element IdEndpoint.identifier:NhsSpineASID.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
https://fhir.nhs.uk/Id/nhsSpineASID
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsSpineASID.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsSpineASID.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdEndpoint.identifier:NhsSpineASID.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdEndpoint.status active | suspended | error | off | entered-in-error | test Definitionactive | suspended | error | off | test. This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid. The status of the endpoint. EndpointStatus (required)Constraints
|
connectionType | S Σ | 1..1 | CodingBinding | There are no (further) constraints on this element Element IdEndpoint.connectionType Protocol/Profile/Standard to be used with this endpoint connection DefinitionA coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook). For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example. EndpointConnectionType (extensible) Constraints
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element IdEndpoint.name A name that this endpoint can be identified by DefinitionA friendly name that this endpoint can be referred to with. Note that FHIR strings SHALL NOT exceed 1MB in size
|
managingOrganization | S Σ I | 1..1 | Reference(Organization) | There are no (further) constraints on this element Element IdEndpoint.managingOrganization Organization that manages this endpoint (might not be the organization that exposes the endpoint) DefinitionThe organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data). This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an applicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy.
|
contact | I | 0..* | ContactPoint | There are no (further) constraints on this element Element IdEndpoint.contact Contact details for source (e.g. troubleshooting) DefinitionContact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdEndpoint.period Interval the endpoint is expected to be operational DefinitionThe interval during which the endpoint is expected to be operational. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
payloadType | S Σ | 1..* | CodeableConcept | There are no (further) constraints on this element Element IdEndpoint.payloadType The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) DefinitionThe payload type describes the acceptable content that can be communicated on the endpoint. The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan.
|
coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element IdEndpoint.payloadType.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | Σ | 1..1 | uriFixed Value | Element IdEndpoint.payloadType.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
http://terminology.hl7.org/CodeSystem/endpoint-payload-type
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdEndpoint.payloadType.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | Σ | 1..1 | codeFixed Value | Element IdEndpoint.payloadType.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
any
|
display | Σ | 1..1 | stringFixed Value | Element IdEndpoint.payloadType.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
Any
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdEndpoint.payloadType.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdEndpoint.payloadType.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
payloadMimeType | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element IdEndpoint.payloadMimeType Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) DefinitionThe mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType). Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured. The mime type of an attachment. Any valid mime type is allowed. Mime Types (required)Constraints
|
address | S Σ | 1..1 | url | Element IdEndpoint.address The technical base address, NhsMhsEndPoint, for connecting to this endpoint DefinitionThe uri that describes the actual end-point to connect to. Represents the NHS Message Handling System (MHS) EndPoint. For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs) This address will be to the service base, without any parameters, or sub-services or resources tacked on. E.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs" and not "https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...".
|
header | 0..* | string | There are no (further) constraints on this element Element IdEndpoint.header Usage depends on the channel type DefinitionAdditional headers / information to send as part of the notification. Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.
|
Spine-OperationOutcome
NHSDigital-CapabilityStatement
Conformance url | FHIR Module | Maturity Level |
---|---|---|
https://fhir.nhs.uk/StructureDefinition/NHSDigital-CapabilityStatement | Implementation Support | draft |
Conformance Rules
with CapabilityStatement
CapabilityStatement | I | CapabilityStatement | There are no (further) constraints on this element Element IdCapabilityStatement A statement of system capabilities DefinitionA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation. Applications may implement multiple versions (see Managing Multiple Versions, and the $versions operation). If they do, then a CapabilityStatement describes the system's support for a particular version of FHIR, and the server will have multiple statements, one for each version.
| |
extension | I | 0..* | Extension | Element IdCapabilityStatement.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
Package | S I | 0..1 | Extension(Complex) | Element IdCapabilityStatement.extension:Package Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Complex) Extension URLhttps://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Package Constraints
|
url | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdCapabilityStatement.url Canonical identifier for this capability statement, represented as a URI (globally unique) DefinitionAn absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different servers. Allows the capability statement to be referenced by a single globally unique identifier. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCapabilityStatement.version Business version of the capability statement DefinitionThe identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different capability statement instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the capability statement with the format [url]|[version].
|
name | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdCapabilityStatement.name Name for this capability statement (computer friendly) DefinitionA natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation. Support human navigation and code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
|
title | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCapabilityStatement.title Name for this capability statement (human friendly) DefinitionA short, descriptive, user-friendly title for the capability statement. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
|
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.status draft | active | retired | unknown DefinitionThe status of this capability statement. Enables tracking the life-cycle of the content. Allows filtering of capability statements that are appropriate for use versus not.This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems. The lifecycle status of an artifact. PublicationStatus (required)Constraints
|
experimental | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdCapabilityStatement.experimental For testing purposes, not real usage DefinitionA Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Enables experimental content to be developed following the same lifecycle that would be used for a production-level capability statement. Allows filtering of capability statements that are appropriate for use versus not.
|
date | Σ | 1..1 | dateTime | There are no (further) constraints on this element Element IdCapabilityStatement.date Date last changed Alternate namesRevision Date DefinitionThe date (and optionally time) when the capability statement was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the capability statement. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
|
publisher | Σ | 1..1 | string | There are no (further) constraints on this element Element IdCapabilityStatement.publisher Name of the publisher (organization or individual) DefinitionThe name of the organization or individual that published the capability statement. Helps establish the "authority/credibility" of the capability statement. May also allow for contact. Usually an organization but may be an individual. The publisher (or steward) of the capability statement is the organization or individual primarily responsible for the maintenance and upkeep of the capability statement. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the capability statement. This item SHOULD be populated unless the information is available from context.
|
contact | Σ | 0..* | ContactDetail | There are no (further) constraints on this element Element IdCapabilityStatement.contact Contact details for the publisher DefinitionContact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
|
description | I | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.description Natural language description of the capability statement DefinitionA free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP. This description can be used to capture details such as why the capability statement was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the capability statement as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the capability statement is presumed to be the predominant language in the place the capability statement was created).This does not need to be populated if the description is adequately implied by the software or implementation details.
|
useContext | Σ | 0..* | UsageContext | There are no (further) constraints on this element Element IdCapabilityStatement.useContext The context that the content is intended to support DefinitionThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement instances. Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
|
jurisdiction | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdCapabilityStatement.jurisdiction Intended jurisdiction for capability statement (if applicable) DefinitionA legal or geographic region in which the capability statement is intended to be used. It may be possible for the capability statement to be used in jurisdictions other than those for which it was originally designed or intended. Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible)Constraints
|
purpose | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.purpose Why this capability statement is defined DefinitionExplanation of why this capability statement is needed and why it has been designed as it has. This element does not describe the usage of the capability statement. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this capability statement.
| |
copyright | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.copyright Use and/or publishing restrictions Alternate namesLicense, Restrictions DefinitionA copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement. Consumers must be able to determine any legal restrictions on the use of the capability statement and/or its content. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
kind | S Σ I | 1..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.kind instance | capability | requirements DefinitionThe way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase). Allow searching the 3 modes. Note that FHIR strings SHALL NOT exceed 1MB in size How a capability statement is intended to be used. CapabilityStatementKind (required)Constraints
|
instantiates | Σ | 0..* | canonical(CapabilityStatement) | There are no (further) constraints on this element Element IdCapabilityStatement.instantiates Canonical URL of another capability statement this implements DefinitionReference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details. HL7 defines the following Services: Terminology Service. Many Implementation Guides define additional services. canonical(CapabilityStatement) Constraints
|
imports | Σ | 0..* | canonical(CapabilityStatement) | There are no (further) constraints on this element Element IdCapabilityStatement.imports Canonical URL of another capability statement this adds to DefinitionReference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them. the contents of any directly or indirectly imported CapabilityStatements SHALL NOT overlap, i.e. they cannot refer to the same rest/resource, operations/name, searchparam/name, interaction/code, messaging/endpoint, document/mode pair. A capability statement that imports another CapabilityStatement automatically instantiates it too (though this is often not a very useful statement for the kinds of CapabilityStatements that are suitable for importing). canonical(CapabilityStatement) Constraints
|
software | S Σ I | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.software Software that is covered by this capability statement DefinitionSoftware that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.
|
name | Σ | 1..1 | string | There are no (further) constraints on this element Element IdCapabilityStatement.software.name A name the software is known by DefinitionName the software is known by. Note that FHIR strings SHALL NOT exceed 1MB in size
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCapabilityStatement.software.version Version covered by this statement DefinitionThe version identifier for the software covered by this statement. If possible, a version should be specified, as statements are likely to be different for different versions of software.
|
releaseDate | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdCapabilityStatement.software.releaseDate Date this version was released DefinitionDate this version of the software was released.
|
implementation | Σ I | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.implementation If this describes a specific instance DefinitionIdentifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.
|
description | Σ | 1..1 | string | There are no (further) constraints on this element Element IdCapabilityStatement.implementation.description Describes this specific instance DefinitionInformation about the specific installation that this capability statement relates to. Note that FHIR strings SHALL NOT exceed 1MB in size
|
url | Σ | 0..1 | url | There are no (further) constraints on this element Element IdCapabilityStatement.implementation.url Base URL for the installation DefinitionAn absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
custodian | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdCapabilityStatement.implementation.custodian Organization that manages the data DefinitionThe organization responsible for the management of the instance and oversight of the data on the server at the specified URL. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
fhirVersion | S Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.fhirVersion FHIR Version the system supports DefinitionThe version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value. Servers may implement multiple versions (see Managing Multiple Versions, and the $versions operation). If they do, and the CapabilityStatement is requested from the server, then this fhirVersion will be either the version requested, or the server's default version. All published FHIR Versions. FHIRVersion (required)Constraints
|
format | Σ | 1..* | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.format formats supported (xml | json | ttl | mime type) DefinitionA list of the formats supported by this implementation using their content types. "xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here. The mime type of an attachment. Any valid mime type is allowed. Mime Types (required)Constraints
|
patchFormat | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.patchFormat Patch formats supported DefinitionA list of the patch formats supported by this implementation using their content types. At present, the patch mime types application/json-patch+json and application/xml-patch+xml are legal. Generally, if a server supports PATCH, it would be expected to support the patch formats and match the formats it supports, but this is not always possible or necessary. The mime type of an attachment. Any valid mime type is allowed. Mime Types (required)Constraints
|
implementationGuide | S Σ | 0..* | canonical(ImplementationGuide) | There are no (further) constraints on this element Element IdCapabilityStatement.implementationGuide Implementation guides supported DefinitionA list of implementation guides that the server does (or should) support in their entirety. canonical(ImplementationGuide) Constraints
|
rest | S Σ I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.rest If the endpoint is a RESTful one DefinitionA definition of the restful capabilities of the solution, if any. Multiple repetitions allow definition of both client and/or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).
|
mode | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.mode client | server DefinitionIdentifies whether this portion of the statement is describing the ability to initiate or receive restful operations. Note that FHIR strings SHALL NOT exceed 1MB in size The mode of a RESTful capability statement. RestfulCapabilityMode (required)Constraints
|
documentation | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.rest.documentation General description of implementation DefinitionInformation about the system's restful capabilities that apply across all applications, such as security. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
security | S Σ | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.rest.security Information about security of implementation DefinitionInformation about security implementation from an interface perspective - what a client needs to know.
|
extension | I | 0..* | Extension | Element IdCapabilityStatement.rest.security.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
oauthUris | S I | 0..1 | Extension(Complex) | Element IdCapabilityStatement.rest.security.extension:oauthUris Automated discovery of OAuth2 endpoints Alternate namesextensions, user content DefinitionSupports automated discovery of OAuth2 endpoints. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Complex) Extension URLhttp://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris Constraints
|
cors | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdCapabilityStatement.rest.security.cors Adds CORS Headers (http://enable-cors.org/) DefinitionServer adds CORS headers when responding to requests - this enables Javascript applications to use the server. The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Method: GET, POST, PUT, DELETE. All servers SHOULD support CORS.
|
service | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.security.service OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates DefinitionTypes of security services that are supported/required by the system. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Types of security services used with FHIR. RestfulSecurityService (extensible)Constraints
|
description | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.rest.security.description General description of how security works DefinitionGeneral description of how security works. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
resource | S Σ I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource Resource served on the REST interface DefinitionA specification of the restful capabilities of the solution for a specific resource type. Max of one repetition per resource type.
|
extension | I | 0..* | Extension | Element IdCapabilityStatement.rest.resource.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
searchParameterCombination | I | 0..* | Extension(Complex) | Element IdCapabilityStatement.rest.resource.extension:searchParameterCombination An allowable parameter combination Alternate namesextensions, user content DefinitionThis extension defines a possible search parameter combination, by listing a set of search parameters and indicating whether they are required or optional. If a search combination is specified, clients should expect that they must submit a search that meets one of the required combinations or the search will be unsuccessful. If multiple search parameter combinations are specified, a client may pick between them, and supply the minimal required parameters for any of the combinations. For example, on the Patient Resource you could use this to state support for searching by Patient.name and Patient.gender is required. Extension(Complex) Extension URLhttp://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination Constraints
|
type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.type A resource type that is supported DefinitionA type of resource exposed via the restful interface. Note that FHIR strings SHALL NOT exceed 1MB in size One of the resource types defined as part of this version of FHIR. ResourceType (required)Constraints
|
profile | Σ | 1..1 | canonical(StructureDefinition) | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.profile Base System profile for all uses of resource DefinitionA specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in Using Profiles. The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system. canonical(StructureDefinition) Constraints
|
supportedProfile | Σ | 0..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.supportedProfile Profiles for use cases supported DefinitionA list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in Using Profiles. Supported profiles are different than the profile that applies to a particular resource in .rest.resource.profile. The resource profile is a general statement of what features of the resource are supported overall by the system - the sum total of the facilities it supports. A supported profile is a deeper statement about the functionality of the data and services provided by the server (or used by the client). A typical case is a laboratory system that produces a set of different reports - this is the list of types of data that it publishes. A key aspect of declaring profiles here is the question of how the client converts knowledge that the server publishes this data into working with the data; the client can inspect individual resources to determine whether they conform to a particular profile, but how does it find the ones that do? It does so by searching using the _profile parameter, so any resources listed here must be valid values for the _profile resource (using the identifier in the target profile). canonical(StructureDefinition) Constraints
|
documentation | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.documentation Additional information about the use of the resource type DefinitionAdditional information about the resource type used by the system. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
interaction | 0..* | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.interaction What operations are supported? DefinitionIdentifies a restful operation supported by the solution. In general, a Resource will only appear in a CapabilityStatement if the server actually has some capabilities - e.g. there is at least one interaction supported. However interactions can be omitted to support summarization (_summary = true).
| |
extension | I | 0..* | Extension | Element IdCapabilityStatement.rest.resource.interaction.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
Examples | I | 0..1 | Extension(Complex) | Element IdCapabilityStatement.rest.resource.interaction.extension:Examples Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Complex) Extension URLhttps://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples Constraints
|
code | 1..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.interaction.code read | vread | update | patch | delete | history-instance | history-type | create | search-type DefinitionCoded identifier of the operation, supported by the system resource. Note that FHIR strings SHALL NOT exceed 1MB in size Operations supported by REST at the type or instance level. TypeRestfulInteraction (required)Constraints
| |
documentation | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.interaction.documentation Anything special about operation behavior DefinitionGuidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'. REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
versioning | 0..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.versioning no-version | versioned | versioned-update DefinitionThis field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API. If a server supports versionIds correctly, it SHOULD support vread too, but is not required to do so. How the system supports versioning for a resource. ResourceVersionPolicy (required)Constraints
| |
readHistory | 0..1 | boolean | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.readHistory Whether vRead can return past versions DefinitionA flag for whether the server is able to return past versions as part of the vRead operation. It is useful to support the vRead operation for current operations, even if past versions aren't available.
| |
updateCreate | 0..1 | boolean | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.updateCreate If update can commit to a new identity DefinitionA flag to indicate that the server allows or needs to allow the client to create new identities on the server (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server. Allowing the clients to create new identities on the server means that the system administrator needs to have confidence that the clients do not create clashing identities between them. Obviously, if there is only one client, this won't happen. While creating identities on the client means that the clients need to be managed, it's much more convenient for many scenarios if such management can be put in place.
| |
conditionalCreate | 0..1 | boolean | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.conditionalCreate If allows/uses conditional create DefinitionA flag that indicates that the server supports conditional create. Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2.
| |
conditionalRead | 0..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.conditionalRead not-supported | modified-since | not-match | full-support DefinitionA code that indicates how the server supports conditional read. Conditional Read is mainly appropriate for interface engine scripts converting from other formats, such as v2. A code that indicates how the server supports conditional read. ConditionalReadStatus (required)Constraints
| |
conditionalUpdate | 0..1 | boolean | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.conditionalUpdate If allows/uses conditional update DefinitionA flag that indicates that the server supports conditional update. Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2.
| |
conditionalDelete | 0..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.conditionalDelete not-supported | single | multiple - how conditional delete is supported DefinitionA code that indicates how the server supports conditional delete. Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2. A code that indicates how the server supports conditional delete. ConditionalDeleteStatus (required)Constraints
| |
referencePolicy | 0..* | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.referencePolicy literal | logical | resolves | enforced | local DefinitionA set of flags that defines how references are supported. Note that FHIR strings SHALL NOT exceed 1MB in size A set of flags that defines how references are supported. ReferenceHandlingPolicy (required)Constraints
| |
searchInclude | 0..* | string | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.searchInclude _include values supported by the server DefinitionA list of _include values supported by the server. If this list is empty, the server does not support includes.
| |
searchRevInclude | 0..* | string | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.searchRevInclude _revinclude values supported by the server DefinitionA list of _revinclude (reverse include) values supported by the server. If this list is empty, the server does not support reverse includes.
| |
searchParam | 0..* | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.searchParam Search parameters supported by implementation DefinitionSearch parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation. The search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at CapabilityStatement.rest.searchParam). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked SearchParameter definitions.
| |
name | 1..1 | string | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.searchParam.name Name of search parameter DefinitionThe name of the search parameter used in the interface. Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined.
| |
definition | 0..1 | canonical(SearchParameter) | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.searchParam.definition Source of definition for parameter DefinitionAn absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to SearchParameter.url). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs. This SHOULD be present, and matches refers to a SearchParameter by its canonical URL. If systems wish to document their support for modifiers, comparators, target resource types, and chained parameters, they should do using a search parameter resource. This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.
| |
type | 1..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.searchParam.type number | date | string | token | reference | composite | quantity | uri | special DefinitionThe type of value a search parameter refers to, and how the content is interpreted. While this can be looked up from the definition, it is included here as a convenience for systems that autogenerate a query interface based on the server capability statement. It SHALL be the same as the type in the search parameter definition. Data types allowed to be used for search parameters. SearchParamType (required)Constraints
| |
documentation | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.searchParam.documentation Server-specific usage DefinitionThis allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
operation | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.operation Definition of a resource operation DefinitionDefinition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters. Operations linked from CapabilityStatement.rest.resource.operation must have OperationDefinition.type = true or OperationDefinition.instance = true. If an operation that is listed in multiple CapabilityStatement.rest.resource.operation (e.g. for different resource types), then clients should understand that the operation is only supported on the specified resource types, and that may be a subset of those listed in OperationDefinition.resource.
|
name | Σ | 1..1 | string | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.operation.name Name by which the operation/query is invoked DefinitionThe name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called. The name here SHOULD be the same as the name in the definition, unless there is a name clash and the name cannot be used. The name does not include the "$" portion that is always included in the URL.
|
definition | Σ | 1..1 | canonical(OperationDefinition) | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.operation.definition The defined operation/query DefinitionWhere the formal definition can be found. If a server references the base definition of an Operation (i.e. from the specification itself such as This can be used to build an HTML form to invoke the operation, for instance. canonical(OperationDefinition) Constraints
|
documentation | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.operation.documentation Specific details about operation behavior DefinitionDocumentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
interaction | 0..* | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.rest.interaction What operations are supported? DefinitionA specification of restful operations supported by the system.
| |
code | 1..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.interaction.code transaction | batch | search-system | history-system DefinitionA coded identifier of the operation, supported by the system. Note that FHIR strings SHALL NOT exceed 1MB in size Operations supported by REST at the system level. SystemRestfulInteraction (required)Constraints
| |
documentation | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.rest.interaction.documentation Anything special about operation behavior DefinitionGuidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
searchParam | 0..* | see (searchParam) | There are no (further) constraints on this element Element IdCapabilityStatement.rest.searchParam Search parameters for searching all resources DefinitionSearch parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation. Typically, the only search parameters supported for all searches are those that apply to all resources - tags, profiles, text search etc. These search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at CapabilityStatement.rest.searchParam). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked SearchParameter definitions. | |
operation | Σ | 0..* | see (operation) | There are no (further) constraints on this element Element IdCapabilityStatement.rest.operation Definition of a system level operation DefinitionDefinition of an operation or a named query together with its parameters and their meaning and type. CapabilityStatement.rest.operation is for operations invoked at the system level, or for operations that are supported across multiple resource types. Operations linked from CapabilityStatement.rest.operation must have OperationDefinition.system = true, or more than one Operation.resource. |
compartment | 0..* | canonical(CompartmentDefinition) | There are no (further) constraints on this element Element IdCapabilityStatement.rest.compartment Compartments served/used by system DefinitionAn absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL . At present, the only defined compartments are at CompartmentDefinition. canonical(CompartmentDefinition) Constraints
| |
messaging | S Σ I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.messaging If messaging is supported DefinitionA description of the messaging capabilities of the solution. Multiple repetitions allow the documentation of multiple endpoints per solution.
|
endpoint | 0..* | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.messaging.endpoint Where messages should be sent Alternate names3 DefinitionAn endpoint (network accessible address) to which messages and/or replies are to be sent.
| |
protocol | 1..1 | CodingBinding | There are no (further) constraints on this element Element IdCapabilityStatement.messaging.endpoint.protocol http | ftp | mllp + DefinitionA list of the messaging transport protocol(s) identifiers, supported by this endpoint. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. The protocol used for message transport. MessageTransport (extensible)Constraints
| |
address | 1..1 | url | There are no (further) constraints on this element Element IdCapabilityStatement.messaging.endpoint.address Network address or identifier of the end-point DefinitionThe network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
| |
reliableCache | 0..1 | unsignedInt | There are no (further) constraints on this element Element IdCapabilityStatement.messaging.reliableCache Reliable Message Cache Length (min) DefinitionLength if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender). If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging.
| |
documentation | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.messaging.documentation Messaging interface behavior details DefinitionDocumentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
supportedMessage | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.messaging.supportedMessage Messages supported by this system DefinitionReferences to message definitions for messages this system can send or receive. This is a proposed alternative to the messaging.event structure.
|
extension | I | 0..* | Extension | Element IdCapabilityStatement.messaging.supportedMessage.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
Examples | I | 0..* | Extension(Complex) | Element IdCapabilityStatement.messaging.supportedMessage.extension:Examples Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Complex) Extension URLhttps://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples Constraints
|
mode | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.messaging.supportedMessage.mode sender | receiver DefinitionThe mode of this event declaration - whether application is sender or receiver. Note that FHIR strings SHALL NOT exceed 1MB in size The mode of a message capability statement. EventCapabilityMode (required)Constraints
|
definition | Σ | 1..1 | canonical(MessageDefinition) | There are no (further) constraints on this element Element IdCapabilityStatement.messaging.supportedMessage.definition Message supported by this system DefinitionPoints to a message definition that identifies the messaging event, message structure, allowed responses, etc.
|
document | Σ I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.document Document definition DefinitionA document definition.
|
mode | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.document.mode producer | consumer DefinitionMode of this document declaration - whether an application is a producer or consumer. Note that FHIR strings SHALL NOT exceed 1MB in size Whether the application produces or consumes documents. DocumentMode (required)Constraints
|
documentation | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.document.documentation Description of document support DefinitionA description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
profile | Σ | 1..1 | canonical(StructureDefinition) | There are no (further) constraints on this element Element IdCapabilityStatement.document.profile Constraint on the resources used in the document DefinitionA profile on the document Bundle that constrains which resources are present, and their contents. The profile is actually on the Bundle. canonical(StructureDefinition) Constraints
|
from CapabilityStatement
CapabilityStatement | I | CapabilityStatement | There are no (further) constraints on this element Element IdCapabilityStatement A statement of system capabilities DefinitionA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation. Applications may implement multiple versions (see Managing Multiple Versions, and the $versions operation). If they do, then a CapabilityStatement describes the system's support for a particular version of FHIR, and the server will have multiple statements, one for each version.
| |
extension | I | 0..* | Extension | Element IdCapabilityStatement.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
Package | S I | 0..1 | Extension(Complex) | Element IdCapabilityStatement.extension:Package Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Complex) Extension URLhttps://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Package Constraints
|
url | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdCapabilityStatement.url Canonical identifier for this capability statement, represented as a URI (globally unique) DefinitionAn absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different servers. Allows the capability statement to be referenced by a single globally unique identifier. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCapabilityStatement.version Business version of the capability statement DefinitionThe identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different capability statement instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the capability statement with the format [url]|[version].
|
name | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdCapabilityStatement.name Name for this capability statement (computer friendly) DefinitionA natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation. Support human navigation and code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
|
title | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCapabilityStatement.title Name for this capability statement (human friendly) DefinitionA short, descriptive, user-friendly title for the capability statement. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
|
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.status draft | active | retired | unknown DefinitionThe status of this capability statement. Enables tracking the life-cycle of the content. Allows filtering of capability statements that are appropriate for use versus not.This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems. The lifecycle status of an artifact. PublicationStatus (required)Constraints
|
experimental | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdCapabilityStatement.experimental For testing purposes, not real usage DefinitionA Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Enables experimental content to be developed following the same lifecycle that would be used for a production-level capability statement. Allows filtering of capability statements that are appropriate for use versus not.
|
date | Σ | 1..1 | dateTime | There are no (further) constraints on this element Element IdCapabilityStatement.date Date last changed Alternate namesRevision Date DefinitionThe date (and optionally time) when the capability statement was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the capability statement. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
|
publisher | Σ | 1..1 | string | There are no (further) constraints on this element Element IdCapabilityStatement.publisher Name of the publisher (organization or individual) DefinitionThe name of the organization or individual that published the capability statement. Helps establish the "authority/credibility" of the capability statement. May also allow for contact. Usually an organization but may be an individual. The publisher (or steward) of the capability statement is the organization or individual primarily responsible for the maintenance and upkeep of the capability statement. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the capability statement. This item SHOULD be populated unless the information is available from context.
|
contact | Σ | 0..* | ContactDetail | There are no (further) constraints on this element Element IdCapabilityStatement.contact Contact details for the publisher DefinitionContact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
|
description | I | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.description Natural language description of the capability statement DefinitionA free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP. This description can be used to capture details such as why the capability statement was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the capability statement as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the capability statement is presumed to be the predominant language in the place the capability statement was created).This does not need to be populated if the description is adequately implied by the software or implementation details.
|
useContext | Σ | 0..* | UsageContext | There are no (further) constraints on this element Element IdCapabilityStatement.useContext The context that the content is intended to support DefinitionThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement instances. Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
|
jurisdiction | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdCapabilityStatement.jurisdiction Intended jurisdiction for capability statement (if applicable) DefinitionA legal or geographic region in which the capability statement is intended to be used. It may be possible for the capability statement to be used in jurisdictions other than those for which it was originally designed or intended. Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible)Constraints
|
purpose | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.purpose Why this capability statement is defined DefinitionExplanation of why this capability statement is needed and why it has been designed as it has. This element does not describe the usage of the capability statement. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this capability statement.
| |
copyright | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.copyright Use and/or publishing restrictions Alternate namesLicense, Restrictions DefinitionA copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement. Consumers must be able to determine any legal restrictions on the use of the capability statement and/or its content. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
kind | S Σ I | 1..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.kind instance | capability | requirements DefinitionThe way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase). Allow searching the 3 modes. Note that FHIR strings SHALL NOT exceed 1MB in size How a capability statement is intended to be used. CapabilityStatementKind (required)Constraints
|
instantiates | Σ | 0..* | canonical(CapabilityStatement) | There are no (further) constraints on this element Element IdCapabilityStatement.instantiates Canonical URL of another capability statement this implements DefinitionReference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details. HL7 defines the following Services: Terminology Service. Many Implementation Guides define additional services. canonical(CapabilityStatement) Constraints
|
imports | Σ | 0..* | canonical(CapabilityStatement) | There are no (further) constraints on this element Element IdCapabilityStatement.imports Canonical URL of another capability statement this adds to DefinitionReference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them. the contents of any directly or indirectly imported CapabilityStatements SHALL NOT overlap, i.e. they cannot refer to the same rest/resource, operations/name, searchparam/name, interaction/code, messaging/endpoint, document/mode pair. A capability statement that imports another CapabilityStatement automatically instantiates it too (though this is often not a very useful statement for the kinds of CapabilityStatements that are suitable for importing). canonical(CapabilityStatement) Constraints
|
software | S Σ I | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.software Software that is covered by this capability statement DefinitionSoftware that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.
|
name | Σ | 1..1 | string | There are no (further) constraints on this element Element IdCapabilityStatement.software.name A name the software is known by DefinitionName the software is known by. Note that FHIR strings SHALL NOT exceed 1MB in size
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCapabilityStatement.software.version Version covered by this statement DefinitionThe version identifier for the software covered by this statement. If possible, a version should be specified, as statements are likely to be different for different versions of software.
|
releaseDate | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdCapabilityStatement.software.releaseDate Date this version was released DefinitionDate this version of the software was released.
|
implementation | Σ I | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.implementation If this describes a specific instance DefinitionIdentifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.
|
description | Σ | 1..1 | string | There are no (further) constraints on this element Element IdCapabilityStatement.implementation.description Describes this specific instance DefinitionInformation about the specific installation that this capability statement relates to. Note that FHIR strings SHALL NOT exceed 1MB in size
|
url | Σ | 0..1 | url | There are no (further) constraints on this element Element IdCapabilityStatement.implementation.url Base URL for the installation DefinitionAn absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
|
custodian | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdCapabilityStatement.implementation.custodian Organization that manages the data DefinitionThe organization responsible for the management of the instance and oversight of the data on the server at the specified URL. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
fhirVersion | S Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.fhirVersion FHIR Version the system supports DefinitionThe version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value. Servers may implement multiple versions (see Managing Multiple Versions, and the $versions operation). If they do, and the CapabilityStatement is requested from the server, then this fhirVersion will be either the version requested, or the server's default version. All published FHIR Versions. FHIRVersion (required)Constraints
|
format | Σ | 1..* | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.format formats supported (xml | json | ttl | mime type) DefinitionA list of the formats supported by this implementation using their content types. "xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here. The mime type of an attachment. Any valid mime type is allowed. Mime Types (required)Constraints
|
patchFormat | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.patchFormat Patch formats supported DefinitionA list of the patch formats supported by this implementation using their content types. At present, the patch mime types application/json-patch+json and application/xml-patch+xml are legal. Generally, if a server supports PATCH, it would be expected to support the patch formats and match the formats it supports, but this is not always possible or necessary. The mime type of an attachment. Any valid mime type is allowed. Mime Types (required)Constraints
|
implementationGuide | S Σ | 0..* | canonical(ImplementationGuide) | There are no (further) constraints on this element Element IdCapabilityStatement.implementationGuide Implementation guides supported DefinitionA list of implementation guides that the server does (or should) support in their entirety. canonical(ImplementationGuide) Constraints
|
rest | S Σ I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.rest If the endpoint is a RESTful one DefinitionA definition of the restful capabilities of the solution, if any. Multiple repetitions allow definition of both client and/or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).
|
mode | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.mode client | server DefinitionIdentifies whether this portion of the statement is describing the ability to initiate or receive restful operations. Note that FHIR strings SHALL NOT exceed 1MB in size The mode of a RESTful capability statement. RestfulCapabilityMode (required)Constraints
|
documentation | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.rest.documentation General description of implementation DefinitionInformation about the system's restful capabilities that apply across all applications, such as security. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
security | S Σ | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.rest.security Information about security of implementation DefinitionInformation about security implementation from an interface perspective - what a client needs to know.
|
extension | I | 0..* | Extension | Element IdCapabilityStatement.rest.security.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
oauthUris | S I | 0..1 | Extension(Complex) | Element IdCapabilityStatement.rest.security.extension:oauthUris Automated discovery of OAuth2 endpoints Alternate namesextensions, user content DefinitionSupports automated discovery of OAuth2 endpoints. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Complex) Extension URLhttp://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris Constraints
|
cors | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdCapabilityStatement.rest.security.cors Adds CORS Headers (http://enable-cors.org/) DefinitionServer adds CORS headers when responding to requests - this enables Javascript applications to use the server. The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Method: GET, POST, PUT, DELETE. All servers SHOULD support CORS.
|
service | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.security.service OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates DefinitionTypes of security services that are supported/required by the system. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Types of security services used with FHIR. RestfulSecurityService (extensible)Constraints
|
description | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.rest.security.description General description of how security works DefinitionGeneral description of how security works. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
resource | S Σ I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource Resource served on the REST interface DefinitionA specification of the restful capabilities of the solution for a specific resource type. Max of one repetition per resource type.
|
extension | I | 0..* | Extension | Element IdCapabilityStatement.rest.resource.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
searchParameterCombination | I | 0..* | Extension(Complex) | Element IdCapabilityStatement.rest.resource.extension:searchParameterCombination An allowable parameter combination Alternate namesextensions, user content DefinitionThis extension defines a possible search parameter combination, by listing a set of search parameters and indicating whether they are required or optional. If a search combination is specified, clients should expect that they must submit a search that meets one of the required combinations or the search will be unsuccessful. If multiple search parameter combinations are specified, a client may pick between them, and supply the minimal required parameters for any of the combinations. For example, on the Patient Resource you could use this to state support for searching by Patient.name and Patient.gender is required. Extension(Complex) Extension URLhttp://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination Constraints
|
type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.type A resource type that is supported DefinitionA type of resource exposed via the restful interface. Note that FHIR strings SHALL NOT exceed 1MB in size One of the resource types defined as part of this version of FHIR. ResourceType (required)Constraints
|
profile | Σ | 1..1 | canonical(StructureDefinition) | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.profile Base System profile for all uses of resource DefinitionA specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in Using Profiles. The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system. canonical(StructureDefinition) Constraints
|
supportedProfile | Σ | 0..* | canonical(StructureDefinition) | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.supportedProfile Profiles for use cases supported DefinitionA list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in Using Profiles. Supported profiles are different than the profile that applies to a particular resource in .rest.resource.profile. The resource profile is a general statement of what features of the resource are supported overall by the system - the sum total of the facilities it supports. A supported profile is a deeper statement about the functionality of the data and services provided by the server (or used by the client). A typical case is a laboratory system that produces a set of different reports - this is the list of types of data that it publishes. A key aspect of declaring profiles here is the question of how the client converts knowledge that the server publishes this data into working with the data; the client can inspect individual resources to determine whether they conform to a particular profile, but how does it find the ones that do? It does so by searching using the _profile parameter, so any resources listed here must be valid values for the _profile resource (using the identifier in the target profile). canonical(StructureDefinition) Constraints
|
documentation | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.documentation Additional information about the use of the resource type DefinitionAdditional information about the resource type used by the system. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
interaction | 0..* | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.interaction What operations are supported? DefinitionIdentifies a restful operation supported by the solution. In general, a Resource will only appear in a CapabilityStatement if the server actually has some capabilities - e.g. there is at least one interaction supported. However interactions can be omitted to support summarization (_summary = true).
| |
extension | I | 0..* | Extension | Element IdCapabilityStatement.rest.resource.interaction.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
Examples | I | 0..1 | Extension(Complex) | Element IdCapabilityStatement.rest.resource.interaction.extension:Examples Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Complex) Extension URLhttps://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples Constraints
|
code | 1..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.interaction.code read | vread | update | patch | delete | history-instance | history-type | create | search-type DefinitionCoded identifier of the operation, supported by the system resource. Note that FHIR strings SHALL NOT exceed 1MB in size Operations supported by REST at the type or instance level. TypeRestfulInteraction (required)Constraints
| |
documentation | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.interaction.documentation Anything special about operation behavior DefinitionGuidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'. REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
versioning | 0..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.versioning no-version | versioned | versioned-update DefinitionThis field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API. If a server supports versionIds correctly, it SHOULD support vread too, but is not required to do so. How the system supports versioning for a resource. ResourceVersionPolicy (required)Constraints
| |
readHistory | 0..1 | boolean | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.readHistory Whether vRead can return past versions DefinitionA flag for whether the server is able to return past versions as part of the vRead operation. It is useful to support the vRead operation for current operations, even if past versions aren't available.
| |
updateCreate | 0..1 | boolean | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.updateCreate If update can commit to a new identity DefinitionA flag to indicate that the server allows or needs to allow the client to create new identities on the server (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server. Allowing the clients to create new identities on the server means that the system administrator needs to have confidence that the clients do not create clashing identities between them. Obviously, if there is only one client, this won't happen. While creating identities on the client means that the clients need to be managed, it's much more convenient for many scenarios if such management can be put in place.
| |
conditionalCreate | 0..1 | boolean | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.conditionalCreate If allows/uses conditional create DefinitionA flag that indicates that the server supports conditional create. Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2.
| |
conditionalRead | 0..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.conditionalRead not-supported | modified-since | not-match | full-support DefinitionA code that indicates how the server supports conditional read. Conditional Read is mainly appropriate for interface engine scripts converting from other formats, such as v2. A code that indicates how the server supports conditional read. ConditionalReadStatus (required)Constraints
| |
conditionalUpdate | 0..1 | boolean | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.conditionalUpdate If allows/uses conditional update DefinitionA flag that indicates that the server supports conditional update. Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2.
| |
conditionalDelete | 0..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.conditionalDelete not-supported | single | multiple - how conditional delete is supported DefinitionA code that indicates how the server supports conditional delete. Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2. A code that indicates how the server supports conditional delete. ConditionalDeleteStatus (required)Constraints
| |
referencePolicy | 0..* | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.referencePolicy literal | logical | resolves | enforced | local DefinitionA set of flags that defines how references are supported. Note that FHIR strings SHALL NOT exceed 1MB in size A set of flags that defines how references are supported. ReferenceHandlingPolicy (required)Constraints
| |
searchInclude | 0..* | string | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.searchInclude _include values supported by the server DefinitionA list of _include values supported by the server. If this list is empty, the server does not support includes.
| |
searchRevInclude | 0..* | string | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.searchRevInclude _revinclude values supported by the server DefinitionA list of _revinclude (reverse include) values supported by the server. If this list is empty, the server does not support reverse includes.
| |
searchParam | 0..* | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.searchParam Search parameters supported by implementation DefinitionSearch parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation. The search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at CapabilityStatement.rest.searchParam). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked SearchParameter definitions.
| |
name | 1..1 | string | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.searchParam.name Name of search parameter DefinitionThe name of the search parameter used in the interface. Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined.
| |
definition | 0..1 | canonical(SearchParameter) | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.searchParam.definition Source of definition for parameter DefinitionAn absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to SearchParameter.url). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs. This SHOULD be present, and matches refers to a SearchParameter by its canonical URL. If systems wish to document their support for modifiers, comparators, target resource types, and chained parameters, they should do using a search parameter resource. This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.
| |
type | 1..1 | codeBinding | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.searchParam.type number | date | string | token | reference | composite | quantity | uri | special DefinitionThe type of value a search parameter refers to, and how the content is interpreted. While this can be looked up from the definition, it is included here as a convenience for systems that autogenerate a query interface based on the server capability statement. It SHALL be the same as the type in the search parameter definition. Data types allowed to be used for search parameters. SearchParamType (required)Constraints
| |
documentation | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.searchParam.documentation Server-specific usage DefinitionThis allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
operation | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.operation Definition of a resource operation DefinitionDefinition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters. Operations linked from CapabilityStatement.rest.resource.operation must have OperationDefinition.type = true or OperationDefinition.instance = true. If an operation that is listed in multiple CapabilityStatement.rest.resource.operation (e.g. for different resource types), then clients should understand that the operation is only supported on the specified resource types, and that may be a subset of those listed in OperationDefinition.resource.
|
name | Σ | 1..1 | string | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.operation.name Name by which the operation/query is invoked DefinitionThe name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called. The name here SHOULD be the same as the name in the definition, unless there is a name clash and the name cannot be used. The name does not include the "$" portion that is always included in the URL.
|
definition | Σ | 1..1 | canonical(OperationDefinition) | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.operation.definition The defined operation/query DefinitionWhere the formal definition can be found. If a server references the base definition of an Operation (i.e. from the specification itself such as This can be used to build an HTML form to invoke the operation, for instance. canonical(OperationDefinition) Constraints
|
documentation | 0..1 | markdown | There are no (further) constraints on this element Element IdCapabilityStatement.rest.resource.operation.documentation Specific details about operation behavior DefinitionDocumentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
i |