Endpoint.payloadMimeType FHIR attribute (r4) In the Endpoint resource for FHIR r4 , the payloadMimeType attribute identifies the Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
payloadMimeType (Endpoint) description Attribute Name: payloadMimeType
Description: Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Attribute Type : code
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Endpoint.payloadMimeType Example "payloadMimeType": [
"application/fhir+xml"
]
Endpoint attributes Attribute Field is list Type Description
identifier
true
Identifier
Identifies this endpoint across multiple systems
Description: Identifies this endpoint across multiple systems
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"
}
]
status
false
code
active | suspended | error | off | entered-in-error | test
Description: active | suspended | error | off | entered-in-error | test
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example: "status": "active"
connectionType
false
Coding
Protocol/Profile/Standard to be used with this endpoint connection
Description: Protocol/Profile/Standard to be used with this endpoint connection
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"
}
name
false
string
A name that this endpoint can be identified by
Description: A name that this endpoint can be identified by
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"
managingOrganization
false
Reference
Organization that manages this endpoint (might not be the organization that exposes the endpoint)
Description: Organization that manages this endpoint (might not be the organization that exposes the endpoint)
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"
}
contact
true
ContactPoint
Contact details for source (e.g. troubleshooting)
Description: Contact details for source (e.g. troubleshooting)
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"
}
]
period
false
Period
Interval the endpoint is expected to be operational
Description: Interval the endpoint is expected to be operational
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"
}
payloadType
true
CodeableConcept
The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Description: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
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"
}
]
}
]
payloadMimeType
true
code
Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Description: Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
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"
]
address
false
url
The technical base address for connecting to this endpoint
Description: The technical base address for connecting to this endpoint
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"
header
true
string
Usage depends on the channel type
Description: Usage depends on the channel type
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"
]