Endpoint - FHIR Resource (stu3)

This Endpoint Resource uses the FHIR API standard for access and structure.

Validate an Endpoint FHIR Resource (stu3)

Validate this Endpoint

Resource Attributes

Attribute	Field is list	Type	Description
address	false	uri	# The technical base address for connecting to this endpoint
connectionType	false	Coding	# Protocol/Profile/Standard to be used with this endpoint connection
contact	true	ContactPoint	# Contact details for source (e.g. troubleshooting)
header	true	string	# Usage depends on the channel type
identifier	true	Identifier	# Identifies this endpoint across multiple systems
managingOrganization	false	Reference	# Organization that manages this endpoint (may not be the organization that exposes the endpoint)
name	false	string	# A name that this endpoint can be identified by
payloadMimeType	true	code	# Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
payloadType	true	CodeableConcept	# The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
period	false	Period	# Interval the endpoint is expected to be operational
status	false	code	# active | suspended | error | off | entered-in-error | test

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