Profiles & Operations Index > Profile: Endpoint
Profile: Endpoint
Canonical URL:http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-endpoint
Simplifier project page: Endpoint EHR
Derived from: Endpoint (R4)
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work
Differential View
| EndpointEHR (Endpoint) | C | Endpoint | There are no (further) constraints on this element Element idEndpointShort description 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.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idEndpoint.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idEndpoint.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idEndpoint.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idEndpoint.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idEndpoint.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idEndpoint.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEndpoint.extensionShort description 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) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEndpoint.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | S Σ | 0..* | Identifier | There are no (further) constraints on this element Element idEndpoint.identifierShort description Identifies this endpoint across multiple systems DefinitionIdentifier for the organization that is used to identify the endpoint across multiple disparate systems. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idEndpoint.statusShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| connectionType | S Σ | 1..1 | CodingBinding | Element idEndpoint.connectionTypeShort description 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. A coded value that represents the technical details of the usage of this endpoint. EndpointConnectionTypeEHR (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idEndpoint.connectionType.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEndpoint.connectionType.extensionShort description 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) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idEndpoint.connectionType.systemShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idEndpoint.connectionType.versionShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | S Σ | 1..1 | code | There are no (further) constraints on this element Element idEndpoint.connectionType.codeShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | S Σ | 1..1 | string | There are no (further) constraints on this element Element idEndpoint.connectionType.displayShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idEndpoint.connectionType.userSelectedShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ | 0..1 | string | There are no (further) constraints on this element Element idEndpoint.nameShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| managingOrganization | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idEndpoint.managingOrganizationShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contact | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idEndpoint.contactShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idEndpoint.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| payloadType | S Σ | 1..* | CodeableConcept | There are no (further) constraints on this element Element idEndpoint.payloadTypeShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| payloadMimeType | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element idEndpoint.payloadMimeTypeShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| address | S Σ | 1..1 | url | There are no (further) constraints on this element Element idEndpoint.addressShort description The technical base address for connecting to this endpoint DefinitionThe uri that describes the actual end-point to connect to. 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/...". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| header | 0..* | string | There are no (further) constraints on this element Element idEndpoint.headerShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Hybrid View
| EndpointEHR (Endpoint) | C | Endpoint | There are no (further) constraints on this element Element idEndpointShort description 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.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idEndpoint.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idEndpoint.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idEndpoint.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idEndpoint.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idEndpoint.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idEndpoint.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEndpoint.extensionShort description 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) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEndpoint.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | S Σ | 0..* | Identifier | There are no (further) constraints on this element Element idEndpoint.identifierShort description Identifies this endpoint across multiple systems DefinitionIdentifier for the organization that is used to identify the endpoint across multiple disparate systems. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idEndpoint.statusShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| connectionType | S Σ | 1..1 | CodingBinding | Element idEndpoint.connectionTypeShort description 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. A coded value that represents the technical details of the usage of this endpoint. EndpointConnectionTypeEHR (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idEndpoint.connectionType.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEndpoint.connectionType.extensionShort description 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) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idEndpoint.connectionType.systemShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idEndpoint.connectionType.versionShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | S Σ | 1..1 | code | There are no (further) constraints on this element Element idEndpoint.connectionType.codeShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | S Σ | 1..1 | string | There are no (further) constraints on this element Element idEndpoint.connectionType.displayShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idEndpoint.connectionType.userSelectedShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ | 0..1 | string | There are no (further) constraints on this element Element idEndpoint.nameShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| managingOrganization | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idEndpoint.managingOrganizationShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contact | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idEndpoint.contactShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idEndpoint.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| payloadType | S Σ | 1..* | CodeableConcept | There are no (further) constraints on this element Element idEndpoint.payloadTypeShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| payloadMimeType | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element idEndpoint.payloadMimeTypeShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| address | S Σ | 1..1 | url | There are no (further) constraints on this element Element idEndpoint.addressShort description The technical base address for connecting to this endpoint DefinitionThe uri that describes the actual end-point to connect to. 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/...". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| header | 0..* | string | There are no (further) constraints on this element Element idEndpoint.headerShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Snapshot View
| EndpointEHR (Endpoint) | C | Endpoint | There are no (further) constraints on this element Element idEndpointShort description 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.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idEndpoint.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idEndpoint.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idEndpoint.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idEndpoint.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idEndpoint.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idEndpoint.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEndpoint.extensionShort description 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) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idEndpoint.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | S Σ | 0..* | Identifier | There are no (further) constraints on this element Element idEndpoint.identifierShort description Identifies this endpoint across multiple systems DefinitionIdentifier for the organization that is used to identify the endpoint across multiple disparate systems. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idEndpoint.statusShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| connectionType | S Σ | 1..1 | CodingBinding | Element idEndpoint.connectionTypeShort description 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. A coded value that represents the technical details of the usage of this endpoint. EndpointConnectionTypeEHR (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idEndpoint.connectionType.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idEndpoint.connectionType.extensionShort description 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) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idEndpoint.connectionType.systemShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idEndpoint.connectionType.versionShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | S Σ | 1..1 | code | There are no (further) constraints on this element Element idEndpoint.connectionType.codeShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | S Σ | 1..1 | string | There are no (further) constraints on this element Element idEndpoint.connectionType.displayShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idEndpoint.connectionType.userSelectedShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ | 0..1 | string | There are no (further) constraints on this element Element idEndpoint.nameShort description 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 The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| managingOrganization | Σ C | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idEndpoint.managingOrganizationShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contact | C | 0..* | ContactPoint | There are no (further) constraints on this element Element idEndpoint.contactShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idEndpoint.periodShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| payloadType | S Σ | 1..* | CodeableConcept | There are no (further) constraints on this element Element idEndpoint.payloadTypeShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| payloadMimeType | Σ | 0..* | codeBinding | There are no (further) constraints on this element Element idEndpoint.payloadMimeTypeShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| address | S Σ | 1..1 | url | There are no (further) constraints on this element Element idEndpoint.addressShort description The technical base address for connecting to this endpoint DefinitionThe uri that describes the actual end-point to connect to. 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/...". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| header | 0..* | string | There are no (further) constraints on this element Element idEndpoint.headerShort description 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Table View
| Endpoint | .. | |
| Endpoint.identifier | .. | |
| Endpoint.status | .. | |
| Endpoint.connectionType | .. | |
| Endpoint.connectionType.system | 1.. | |
| Endpoint.connectionType.code | 1.. | |
| Endpoint.connectionType.display | 1.. | |
| Endpoint.payloadType | .. | |
| Endpoint.address | .. |
JSON View
Usage
The Endpoint resource supports the submission and retrieval of an endpoint that provides access to the imaging study.
Notes
.identifier
- MUST contain the AE title with the protocol, such as "AEtitle:qido/wado/dimse".
.status
- MUST be present to indicate the status of the endpoint such as "active".
.connectionType
- MUST be present to indicate the protocol/profile/standard to be used with this endpoint connection. For this implementation, the value should be one of the DICOM protocols defined in the value set.
.payloadType
- MUST be present to indicate the type of content that may be used at this endpoint
.address
- MUST contain the url of the technical base address for connecting to this endpoint