Endpoint.status

FHIR attribute (r4)

status (Endpoint) description

Resource Type: Endpoint

Attribute Name: status

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Endpoint.status Example

"status": "active"

Endpoint attributes

AttributeField is listTypeDescription

Description: Identifies this endpoint across multiple systems

FHIR Version: r4

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

FHIR Version: r4

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: Protocol/Profile/Standard to be used with this endpoint connection

FHIR Version: r4

Attribute Type : Coding

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"connectionType": {
  "system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
  "code": "hl7-fhir-rest"
}

Learn more about the (Endpoint) connectionType FHIR attribute

Description: A name that this endpoint can be identified by

FHIR Version: r4

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: Organization that manages this endpoint (might not be the organization that exposes the endpoint)

FHIR Version: r4

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: Contact details for source (e.g. troubleshooting)

FHIR Version: r4

Attribute Type : ContactPoint

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"contact": [
  {
    "system": "email",
    "value": "endpointmanager@example.org",
    "use": "work"
  }
]

Learn more about the (Endpoint) contact FHIR attribute

Description: Interval the endpoint is expected to be operational

FHIR Version: r4

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: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"payloadType": [
  {
    "coding": [
      {
        "system": "http://hl7.org/fhir/resource-types",
        "code": "CarePlan"
      }
    ]
  }
]

Learn more about the (Endpoint) payloadType FHIR attribute

Description: Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)

FHIR Version: r4

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

Description: The technical base address for connecting to this endpoint

FHIR Version: r4

Attribute Type : url

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: Usage depends on the channel type

FHIR Version: r4

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