End Point

$10 / year

End Point Resource provides technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b (Cross-Enterprise Document Sharing) or a REST (Representational State Transfer) endpoint for another FHIR (Fast Healthcare Interoperability Resources) server. This may include any security context information.

Complexity

An endpoint describes the technical details of a location that can be connected to for the delivery/retrieval of information. Sufficient information is required to ensure that a connection can be made securely, and appropriate data transmitted as defined by the endpoint owner. This is not a description of details of the current system, as found in CapabilityStatement, but of another (potentially external) system.
These may be locally hosted services, regional services, or national service.

These resources are typically used to identify where to locate endpoint details for:

– Questionnaires: Where to send information (currently an SDC extension with just the address)
– ValueSet: Where related Terminology Services can be found (where not local)
– Subscription: The destination to send the subscribed data (or to pull)
– Messaging: (currently defined in the Message Header, but only as the address)
– Referrals: Where to send referral requests
– (linked to the services directory resources – Organization/Location/Practitioner/HealthcareService)
– Referrals – Templates: Where to locate referral templates (Questionnaires)
– (linked to the services directory resources – Organization/Location/Practitioner/HealthcareService)
– CarePlans: Where a shared CarePlan can be found
– Scheduling: Where to lookup to discover schedules/availability information
– (linked to the services directory resources – Organization/Location/Practitioner/HealthcareService)
– Scheduling: Where to lookup to send appointment requests
– (linked to the services directory resources – Organization/Location/Practitioner/HealthcareService)
– Patient/Person: Location of Master Patient/Person Indexes
– Service Provider Directories: Location of related directories (parent/child/federated)
– DICOM (Digital Imaging and Communications in Medicine)/imaging: Location of where to query for imaging content and metadata , e.g., QIDO-RS (Query based on ID for DICOM Objects – Request/Response) , WADO-RS (Retrieve Web Access to DICOM Objects), or WADO-URI (Retrieve Web Access to DICOM Objects – Universal Resource Identifier)

Fast Healthcare Interoperability Resources (FHIR) is a draft standard describing data formats and elements (known as “resources”) and an application programming interface (API) for exchanging electronic health records. The standard was created by the Health Level Seven International (HL7) health-care standards organization.

Its goal is to facilitate interoperation between legacy healthcare systems, to make it easy to provide healthcare information to healthcare providers and individuals on a wide variety of devices from computers to tablets to cell phones, and to allow third-party application developers to provide medical applications which can be easily integrated into existing systems.

FHIR provides an alternative to document-centric approaches by directly exposing discrete data elements as services. For example, basic elements of healthcare like patients, admissions, diagnostic reports and medications can each be retrieved and manipulated via their own resource URLs (Uniform Resource Locators). FHIR was supported at an American Medical Informatics Association meeting by many EHR (Electronic Health Record) vendors which value its open and extensible nature.

Date Created

2018-09-20

Last Modified

2019-11-01

Version

4.0.1

Update Frequency

Annual

Temporal Coverage

N/A

Spatial Coverage

United States

Source

John Snow Labs; Health Level Seven International;

Source License URL

Source License Requirements

N/A

Source Citation

N/A

Keywords

FHIR, HL7, Medical Terminology, Processes Data, Processes Information, Processes Documentation, Health Information Exchange, Electronic Health Records, FHIR Smart, Smart on FHIR

Other Titles

FHIR End Point Resource, Electronic Health Records Exchange Through FHIR

NameDescriptionTypeConstraints
Concept_NameName of the concept in the FHIR structurestringrequired : 1
Computer_Ready_NameA Computer-ready name (e.g. a token) that identifies the structure - suitable for code generation. Note that this name (and other names relevant for code generation, including element & slice names, codes etc) may collide with reserved words in the relevant target language, and code generators will need to handle this.string-
TypeThe type the structure describes.string-
Dollar_RefThe Dollar_Ref ($ref) string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON (JavaScript Object Notation) value being referenced.string-
DescriptionA free text natural language description of the structure and its usestring-
ItemsThe value of the keyword should be an object or an array of objects. If the keyword value is an object, then for the data array to be valid each item of the array should be valid according to the schema in this value.string-
EnumThe enum is used to restrict a value to a fixed set of values. It must be an array with at least one element, where each element is unique.string-
RequiredThe value of the keyword should be an array of unique strings. The data object to be valid should contain all properties with names equal to the elements in the keyword value.string-
ConstThe value of this keyword can be anything. The data is valid if it is deeply equal to the value of the keyword.string-
Concept NameComputer Ready NameTypeDollar RefDescriptionItemsEnumRequiredConst
EndpointresourceTypeThis is a Endpoint resourceEndpoint
Endpointid#/definitions/idThe logical id of the resource as used in the URL for the resource. Once assigned this value never changes.
Endpointmeta#/definitions/MetaThe 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.
EndpointimplicitRules#/definitions/uriA 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.
Endpoint_implicitRules#/definitions/ElementExtensions for implicitRules
Endpointlanguage#/definitions/codeThe base language in which the resource is written.
Endpoint_language#/definitions/ElementExtensions for language
Endpointtext#/definitions/NarrativeA 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.
EndpointcontainedarrayThese 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.{'$ref': '#/definitions/ResourceList'}
EndpointextensionarrayMay 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.{'$ref': '#/definitions/Extension'}
Related Data Packages