This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Patient Administration Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
This is a representation of the json schema for Endpoint, which is just a part of the full JSON Schema.
{ "$schema": "http://json-schema.org/draft-06/schema#", "id": "http://hl7.org/fhir/json-schema/Endpoint", "$ref": "#/definitions/Endpoint", "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas", "definitions": { "Endpoint": { "description": "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.", "properties": { "resourceType": { "description": "This is a Endpoint resource", "const": "Endpoint" }, "id": { "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "$ref": "id.schema.json#/definitions/id" }, "meta": { "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "$ref": "Meta.schema.json#/definitions/Meta" }, "implicitRules": { "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "$ref": "#/definitions/uri" }, "_implicitRules": { "description": "Extensions for implicitRules", "$ref": "Element.schema.json#/definitions/Element" }, "language": { "description": "The base language in which the resource is written.", "$ref": "#/definitions/code" }, "_language": { "description": "Extensions for language", "$ref": "Element.schema.json#/definitions/Element" }, "text": { "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "$ref": "Narrative.schema.json#/definitions/Narrative" }, "contained": { "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "items": { "$ref": "ResourceList.schema.json#/definitions/ResourceList" }, "type": "array" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "identifier": { "description": "Identifier for the organization that is used to identify the endpoint across multiple disparate systems.", "items": { "$ref": "Identifier.schema.json#/definitions/Identifier" }, "type": "array" }, "status": { "description": "active | suspended | error | off | test.", "enum": [ "active", "suspended", "error", "off", "entered-in-error", "test" ] }, "_status": { "description": "Extensions for status", "$ref": "Element.schema.json#/definitions/Element" }, "connectionType": { "description": "A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).", "$ref": "Coding.schema.json#/definitions/Coding" }, "name": { "description": "A friendly name that this endpoint can be referred to with.", "$ref": "#/definitions/string" }, "_name": { "description": "Extensions for name", "$ref": "Element.schema.json#/definitions/Element" }, "managingOrganization": { "description": "The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).", "$ref": "Reference.schema.json#/definitions/Reference" }, "contact": { "description": "Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.", "items": { "$ref": "ContactPoint.schema.json#/definitions/ContactPoint" }, "type": "array" }, "period": { "description": "The interval during which the endpoint is expected to be operational.", "$ref": "Period.schema.json#/definitions/Period" }, "payloadType": { "description": "The payload type describes the acceptable content that can be communicated on the endpoint.", "items": { "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "type": "array" }, "payloadMimeType": { "description": "The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).", "items": { "$ref": "#/definitions/code" }, "type": "array" }, "_payloadMimeType": { "description": "Extensions for payloadMimeType", "items": { "$ref": "Element.schema.json#/definitions/Element" }, "type": "array" }, "address": { "description": "The uri that describes the actual end-point to connect to.", "$ref": "#/definitions/url" }, "_address": { "description": "Extensions for address", "$ref": "Element.schema.json#/definitions/Element" }, "header": { "description": "Additional headers / information to send as part of the notification.", "items": { "$ref": "#/definitions/string" }, "type": "array" }, "_header": { "description": "Extensions for header", "items": { "$ref": "Element.schema.json#/definitions/Element" }, "type": "array" } }, "additionalProperties": false, "required": [ "payloadType", "connectionType", "resourceType" ] } } }