Endpoint
The 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.
Columns
Header row
# |
path |
type |
required |
description |
0 |
resourceType |
string |
* |
Resource type identifier. Must be string "Endpoint" |
1 |
|
integer |
* |
Number of subrows |
2 |
id |
string |
* |
Logical id of this artifact |
3 |
status |
code |
|
active | suspended | error | off | entered-in-error | test |
|
connectionType |
Coding |
|
Protocol/Profile/Standard to be used with this endpoint connection |
4 |
connectionType.system |
uri |
|
Identity of the terminology system |
5 |
connectionType.version |
string |
|
Version of the system - if relevant |
6 |
connectionType.code |
code |
|
Symbol in syntax defined by the system |
7 |
connectionType.display |
string |
|
Representation defined by the system |
8 |
connectionType.userSelected |
boolean |
|
If this coding was chosen directly by the user |
9 |
name |
string |
|
A name that this endpoint can be identified by |
|
managingOrganization |
Reference |
|
Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
10 |
managingOrganization.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
11 |
managingOrganization.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
managingOrganization.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
12 |
managingOrganization.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
managingOrganization.identifier.type |
CodeableConcept |
|
Description of identifier |
|
managingOrganization.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
13 |
managingOrganization.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
14 |
managingOrganization.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
15 |
managingOrganization.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
16 |
managingOrganization.identifier.type.coding.display |
string |
|
Representation defined by the system |
17 |
managingOrganization.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
18 |
managingOrganization.identifier.type.text |
string |
|
Plain text representation of the concept |
19 |
managingOrganization.identifier.system |
uri |
|
The namespace for the identifier value |
20 |
managingOrganization.identifier.value |
string |
|
The value that is unique |
|
managingOrganization.identifier.period |
Period |
|
Time period when id is/was valid for use |
21 |
managingOrganization.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
22 |
managingOrganization.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
23 |
managingOrganization.display |
string |
|
Text alternative for the resource |
|
period |
Period |
|
Interval the endpoint is expected to be operational |
24 |
period.start |
dateTime |
|
Starting time with inclusive boundary |
25 |
period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
26 |
address |
url |
|
The technical base address for connecting to this endpoint |
Row identifier
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "identifier" |
|
identifier |
Identifier |
|
Identifies this endpoint across multiple systems |
1 |
identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
identifier.type |
CodeableConcept |
|
Description of identifier |
|
identifier.type.coding |
Coding |
|
Code defined by a terminology system |
2 |
identifier.type.coding.system |
uri |
|
Identity of the terminology system |
3 |
identifier.type.coding.version |
string |
|
Version of the system - if relevant |
4 |
identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
5 |
identifier.type.coding.display |
string |
|
Representation defined by the system |
6 |
identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
7 |
identifier.type.text |
string |
|
Plain text representation of the concept |
8 |
identifier.system |
uri |
|
The namespace for the identifier value |
9 |
identifier.value |
string |
|
The value that is unique |
|
identifier.period |
Period |
|
Time period when id is/was valid for use |
10 |
identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
11 |
identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
Row contact
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "contact" |
|
contact |
ContactPoint |
|
Contact details for source (e.g. troubleshooting) |
1 |
contact.system |
code |
|
phone | fax | email | pager | url | sms | other |
2 |
contact.value |
string |
|
The actual contact point details |
3 |
contact.use |
code |
|
home | work | temp | old | mobile - purpose of this contact point |
4 |
contact.rank |
positiveInt |
|
Specify preferred order of use (1 = highest) |
|
contact.period |
Period |
|
Time period when the contact point was/is in use |
5 |
contact.period.start |
dateTime |
|
Starting time with inclusive boundary |
6 |
contact.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
Row payloadType
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "payloadType" |
|
payloadType |
CodeableConcept |
|
The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) |
|
payloadType.coding |
Coding |
|
Code defined by a terminology system |
1 |
payloadType.coding.system |
uri |
|
Identity of the terminology system |
2 |
payloadType.coding.version |
string |
|
Version of the system - if relevant |
3 |
payloadType.coding.code |
code |
|
Symbol in syntax defined by the system |
4 |
payloadType.coding.display |
string |
|
Representation defined by the system |
5 |
payloadType.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
6 |
payloadType.text |
string |
|
Plain text representation of the concept |
Row payloadMimeType
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "payloadMimeType" |
1 |
payloadMimeType |
code |
|
Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) |
Row header
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "header" |
1 |
header |
string |
|
Usage depends on the channel type |
Examples
Example #1
Input CSV
Endpoint,1,"direct-endpoint","active",,,"direct-project",,,"MARTIN SMIETANKA","Organization/299",,,,,,,,,,,,,,,,"mailto:MARTIN.SMIETANKA@directnppes.com"
payloadType,"urn:oid:1.3.6.1.4.1.19376.1.2.3",,"urn:hl7-org:sdwg:ccda-structuredBody:1.1",,,
Resulting resource
{
"resourceType": "Endpoint",
"id": "direct-endpoint",
"status": "active",
"connectionType": {
"code": "direct-project"
},
"name": "MARTIN SMIETANKA",
"managingOrganization": {
"reference": "Organization/299"
},
"payloadType": [
{
"coding": [
{
"system": "urn:oid:1.3.6.1.4.1.19376.1.2.3",
"code": "urn:hl7-org:sdwg:ccda-structuredBody:1.1"
}
]
}
],
"address": "mailto:MARTIN.SMIETANKA@directnppes.com"
}
Example #2
Input CSV
Endpoint,1,"example-iid","active","http://terminology.hl7.org/CodeSystem/endpoint-connection-type",,"ihe-iid",,,"PACS Hospital Invoke Image Display endpoint",,,,,,,,,,,,,,,,,"https://pacs.hospital.org/IHEInvokeImageDisplay"
payloadType,,,,,,"DICOM IID"
Resulting resource
{
"resourceType": "Endpoint",
"id": "example-iid",
"status": "active",
"connectionType": {
"system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
"code": "ihe-iid"
},
"name": "PACS Hospital Invoke Image Display endpoint",
"payloadType": [
{
"text": "DICOM IID"
}
],
"address": "https://pacs.hospital.org/IHEInvokeImageDisplay"
}
Example #3
Input CSV
Endpoint,5,"example","active","http://terminology.hl7.org/CodeSystem/endpoint-connection-type",,"hl7-fhir-rest",,,"Health Intersections CarePlan Hub","Organization/hl7",,,,,,,,,,,,,,"2014-09-01",,"http://fhir3.healthintersections.com.au/open/CarePlan"
identifier,,,,,,,,"http://example.org/enpoint-identifier","epcp12",,
contact,"email","endpointmanager@example.org","work",,,
payloadType,"http://hl7.org/fhir/resource-types",,"CarePlan",,,
payloadMimeType,"application/fhir+xml"
header,"bearer-code BASGS534s4"
Resulting resource
{
"resourceType": "Endpoint",
"id": "example",
"identifier": [
{
"system": "http://example.org/enpoint-identifier",
"value": "epcp12"
}
],
"status": "active",
"connectionType": {
"system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
"code": "hl7-fhir-rest"
},
"name": "Health Intersections CarePlan Hub",
"managingOrganization": {
"reference": "Organization/hl7"
},
"contact": [
{
"system": "email",
"value": "endpointmanager@example.org",
"use": "work"
}
],
"period": {
"start": "2014-09-01"
},
"payloadType": [
{
"coding": [
{
"system": "http://hl7.org/fhir/resource-types",
"code": "CarePlan"
}
]
}
],
"payloadMimeType": [
"application/fhir+xml"
],
"address": "http://fhir3.healthintersections.com.au/open/CarePlan",
"header": [
"bearer-code BASGS534s4"
]
}
Example #4
Input CSV
Endpoint,2,"71","active","http://terminology.hl7.org/CodeSystem/endpoint-connection-type",,"hl7-fhir-rest",,,"CarePlan repository",,,,,,,,,,,,,,"Telstra Health",,,"https://sqlonfhir-dstu2.azurewebsites.net/fhir"
payloadType,,,"CarePlan",,,
payloadMimeType,"application/fhir+xml"
Resulting resource
{
"resourceType": "Endpoint",
"id": "71",
"status": "active",
"connectionType": {
"system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
"code": "hl7-fhir-rest"
},
"name": "CarePlan repository",
"managingOrganization": {
"display": "Telstra Health"
},
"payloadType": [
{
"coding": [
{
"code": "CarePlan"
}
]
}
],
"payloadMimeType": [
"application/fhir+xml"
],
"address": "https://sqlonfhir-dstu2.azurewebsites.net/fhir"
}
Example #5
Input CSV
Endpoint,2,"72","active","http://terminology.hl7.org/CodeSystem/endpoint-connection-type",,"hl7-fhir-rest",,,"Questionnaire Destination",,,,,,,,,,,,,,"Telstra Health",,,"https://sqlonfhir-dstu2.azurewebsites.net/fhir"
payloadType,,,"QuestionnaireResponse",,,
payloadMimeType,"application/fhir+xml"
Resulting resource
{
"resourceType": "Endpoint",
"id": "72",
"status": "active",
"connectionType": {
"system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
"code": "hl7-fhir-rest"
},
"name": "Questionnaire Destination",
"managingOrganization": {
"display": "Telstra Health"
},
"payloadType": [
{
"coding": [
{
"code": "QuestionnaireResponse"
}
]
}
],
"payloadMimeType": [
"application/fhir+xml"
],
"address": "https://sqlonfhir-dstu2.azurewebsites.net/fhir"
}