Endpoint - FHIR Resource (stu3)
This Endpoint Resource uses the FHIR API standard for access and structure.
Validate an Endpoint FHIR Resource (stu3)
Endpoint Attributes
AttributeField is listTypeDescription
Description: active | suspended | error | off | entered-in-error | test
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "active"Learn more about the (Endpoint) status FHIR attribute
Description: Organization that manages this endpoint (may not be the organization that exposes the endpoint)
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"managingOrganization": {
"reference": "Organization/hl7"
}Learn more about the (Endpoint) managingOrganization FHIR attribute
Description: A name that this endpoint can be identified by
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": "Health Intersections CarePlan Hub"Learn more about the (Endpoint) name FHIR attribute
Description: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"payloadType": [
{
"coding": [
{
"code": "CarePlan",
"system": "http://hl7.org/fhir/resource-types"
}
]
}
]Learn more about the (Endpoint) payloadType FHIR attribute
Description: Interval the endpoint is expected to be operational
FHIR Version: stu3
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"period": {
"start": "2014-09-01"
}Learn more about the (Endpoint) period FHIR attribute
Description: Protocol/Profile/Standard to be used with this endpoint connection
FHIR Version: stu3
Attribute Type : Coding
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"connectionType": {
"code": "hl7-fhir-rest",
"system": "http://hl7.org/fhir/endpoint-connection-type"
}Learn more about the (Endpoint) connectionType FHIR attribute
Description: Usage depends on the channel type
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"header": [
"bearer-code BASGS534s4"
]Learn more about the (Endpoint) header FHIR attribute
Description: Contact details for source (e.g. troubleshooting)
FHIR Version: stu3
Attribute Type : ContactPoint
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": [
{
"use": "work",
"system": "email",
"value": "endpointmanager@example.org"
}
]Learn more about the (Endpoint) contact FHIR attribute
Description: The technical base address for connecting to this endpoint
FHIR Version: stu3
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"address": "http://fhir3.healthintersections.com.au/open/CarePlan"Learn more about the (Endpoint) address FHIR attribute
Description: Identifies this endpoint across multiple systems
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"system": "http://example.org/enpoint-identifier",
"value": "epcp12"
}
]Learn more about the (Endpoint) identifier FHIR attribute
Description: Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"payloadMimeType": [
"application/fhir+xml"
]Learn more about the (Endpoint) payloadMimeType FHIR attribute
Endpoint Example
{
"status": "active",
"managingOrganization": {
"reference": "Organization/hl7"
},
"name": "Health Intersections CarePlan Hub",
"header": [
"bearer-code BASGS534s4"
],
"resourceType": "Endpoint",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\tHealth Intersections CarePlan Hub<br/>\n\t\t\tCarePlans can be uploaded to/from this loccation\n\t\t</div>"
},
"period": {
"start": "2014-09-01"
},
"connectionType": {
"code": "hl7-fhir-rest",
"system": "http://hl7.org/fhir/endpoint-connection-type"
},
"payloadMimeType": [
"application/fhir+xml"
],
"payloadType": [
{
"coding": [
{
"code": "CarePlan",
"system": "http://hl7.org/fhir/resource-types"
}
]
}
],
"contact": [
{
"use": "work",
"system": "email",
"value": "endpointmanager@example.org"
}
],
"address": "http://fhir3.healthintersections.com.au/open/CarePlan",
"identifier": [
{
"system": "http://example.org/enpoint-identifier",
"value": "epcp12"
}
],
"id": "example"
}Endpoint Structure
{
"resourceType" : "Endpoint",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Identifies this endpoint across multiple systems
"status" : "<code>", // R! active | suspended | error | off | entered-in-error | test
"connectionType" : { Coding }, // R! Protocol/Profile/Standard to be used with this endpoint connection
"name" : "<string>", // A name that this endpoint can be identified by
"managingOrganization" : { Reference(Organization) }, // Organization that manages this endpoint (may not be the organization that exposes the endpoint)
"contact" : [{ ContactPoint }], // Contact details for source (e.g. troubleshooting)
"period" : { Period }, // Interval the endpoint is expected to be operational
"payloadType" : [{ CodeableConcept }], // R! The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
"payloadMimeType" : ["<code>"], // Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
"address" : "<uri>", // R! The technical base address for connecting to this endpoint
"header" : ["<string>"] // Usage depends on the channel type
}
Endpoint Search Parameters
The following search parameters can be used to query Endpoint resources. Just submit them like so:
https://api.1up.health/fhir/stu3/Endpoint?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
connection-type | text | connectionType |
identifier | text | identifier |
name | text | name |
organization | reference | managingOrganization |
payload-type | text | payloadType |
status | text | status |
