Validated Healthcare Directory
0.2.0 - CI Build
Validated Healthcare Directory
0.2.0 - CI Build
Validated Healthcare Directory, published by HL7 International - Patient Administration Work Group. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/HL7/VhDir/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-endpoint | Version: 0.2.0 | |||
| Active as of 2017-10-04 | Computable Name: VhdirEndpoint | |||
Copyright/Legal: Used by permission of HL7 International all rights reserved Creative Commons License |
||||
Defines the basic constraints and extensions on the Endpoint resource for use in a Validated Healthcare Directory
This profile sets minimum expectations for searching for and fetching information associated with an electronic endpoint. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the Endpoint resource when using this profile.
Background & Scope
An endpoint describes the technical details of a location that can be connected to for the delivery/retrieval of information.
This profile modifies the base Endpoint resource in the following manner:
Constrains the cardinality of endpoint.contact (0..1), endpoint.contact.system (1..1), and endpoint.contact.value (1..1)
All references SHALL conform to the appropriate Validated Healthcare Directory Implementation Guide profile
Adds extensions:
Examples:
The following are example uses for the vhdir-endpoint profile:
Mandatory Data Elements
The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each endpoint must have:
endpoint.statusendpoint.connectionTypeendpoint.payloadTypeendpoint.addressUsage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Endpoint
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Endpoint | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 restriction | S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction |
| usecase | S | 0..* | (Complex) | Use cases (service descriptions) supported by the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase |
| rank | S | 0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-rank |
| digitalcertificate | S | 0..* | (Complex) | Digital certificate associated with the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate |
 identifier | S | 0..* | Identifier | Identifies this endpoint across multiple systems |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| status | S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
| use | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
| type | S | 0..1 | CodeableConcept | Description of identifier |
| system | S | 0..1 | uri | The namespace for the identifier value |
| value | S | 0..1 | string | The value that is unique |
| period | S | 0..1 | Period | Time period when id is/was valid for use |
  assigner | S | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
| status | S | 1..1 | code | active | suspended | error | off | entered-in-error | test |
| connectionType | S | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection |
| name | S | 0..1 | string | A name that this endpoint can be identified by |
| managingOrganization | S | 0..1 | Reference(VhDir Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
| contact | S | 0..1 | ContactPoint | Contact details for source (e.g. troubleshooting) |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| availabletime | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
| viaintermediary | S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary |
| system | S | 1..1 | code | phone | fax | email | pager | url | sms | other |
| value | S | 1..1 | string | The actual contact point details |
| use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
| rank | S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period | S | 0..1 | Period | Time period when the contact point was/is in use |
| period | S | 0..1 | Period | Interval the endpoint is expected to be operational |
| payloadType | S | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) |
| payloadMimeType | S | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) |
| address | S | 1..1 | url | The technical base address for connecting to this endpoint |
| header | S | 0..* | string | Usage depends on the channel type |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| restriction | S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction |
| usecase | S | 0..* | (Complex) | Use cases (service descriptions) supported by the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase |
| rank | S | 0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-rank |
| digitalcertificate | S | 0..* | (Complex) | Digital certificate associated with the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| status | S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
| use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
| period | SΣ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
| status | ?!SΣ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. |
| connectionType | SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible) |
| name | SΣ | 0..1 | string | A name that this endpoint can be identified by |
| managingOrganization | SΣ | 0..1 | Reference(VhDir Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
| contact | S | 0..1 | ContactPoint | Contact details for source (e.g. troubleshooting) |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| availabletime | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
| viaintermediary | S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary |
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | SΣ | 1..1 | string | The actual contact point details |
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period | SΣ | 0..1 | Period | Time period when the contact point was/is in use |
| period | SΣ | 0..1 | Period | Interval the endpoint is expected to be operational |
| payloadType | SΣ | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) |
| payloadMimeType | SΣ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. |
| address | SΣ | 1..1 | url | The technical base address for connecting to this endpoint |
| header | S | 0..* | string | Usage depends on the channel type |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Endpoint.identifier.use | required | IdentifierUse |
| Endpoint.identifier.type | extensible | Identifier Type Codes |
| Endpoint.status | required | EndpointStatus |
| Endpoint.connectionType | extensible | EndpointConnectionType |
| Endpoint.contact.system | required | ContactPointSystem |
| Endpoint.contact.use | required | ContactPointUse |
| Endpoint.payloadType | example | EndpointPayloadType |
| Endpoint.payloadMimeType | required | Mime Types (a valid code from urn:ietf:bcp:13) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Endpoint | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| restriction | S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction | ||||
| usecase | S | 0..* | (Complex) | Use cases (service descriptions) supported by the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase | ||||
| rank | S | 0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-rank | ||||
| digitalcertificate | S | 0..* | (Complex) | Digital certificate associated with the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| status | S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) | ||||
| use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | SΣ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) | ||||
| status | ?!SΣ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. | ||||
| connectionType | SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible) | ||||
| name | SΣ | 0..1 | string | A name that this endpoint can be identified by | ||||
| managingOrganization | SΣ | 0..1 | Reference(VhDir Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | ||||
| contact | S | 0..1 | ContactPoint | Contact details for source (e.g. troubleshooting) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| availabletime | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime | ||||
| viaintermediary | S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary | ||||
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | SΣ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| period | SΣ | 0..1 | Period | Interval the endpoint is expected to be operational | ||||
| payloadType | SΣ | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) | ||||
| payloadMimeType | SΣ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | ||||
| address | SΣ | 1..1 | url | The technical base address for connecting to this endpoint | ||||
| header | S | 0..* | string | Usage depends on the channel type | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Endpoint.language | preferred | CommonLanguages
| ||||
| Endpoint.identifier.use | required | IdentifierUse | ||||
| Endpoint.identifier.type | extensible | Identifier Type Codes | ||||
| Endpoint.status | required | EndpointStatus | ||||
| Endpoint.connectionType | extensible | EndpointConnectionType | ||||
| Endpoint.contact.system | required | ContactPointSystem | ||||
| Endpoint.contact.use | required | ContactPointUse | ||||
| Endpoint.payloadType | example | EndpointPayloadType | ||||
| Endpoint.payloadMimeType | required | Mime Types (a valid code from urn:ietf:bcp:13) |
This structure is derived from Endpoint
Summary
Mandatory: 0 element (3 nested mandatory elements)
Must-Support: 29 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Endpoint
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| restriction | S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction |
| usecase | S | 0..* | (Complex) | Use cases (service descriptions) supported by the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase |
| rank | S | 0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-rank |
| digitalcertificate | S | 0..* | (Complex) | Digital certificate associated with the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate |
| identifier | S | 0..* | Identifier | Identifies this endpoint across multiple systems |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| status | S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
| use | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
| type | S | 0..1 | CodeableConcept | Description of identifier |
| system | S | 0..1 | uri | The namespace for the identifier value |
| value | S | 0..1 | string | The value that is unique |
| period | S | 0..1 | Period | Time period when id is/was valid for use |
| assigner | S | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
| status | S | 1..1 | code | active | suspended | error | off | entered-in-error | test |
| connectionType | S | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection |
| name | S | 0..1 | string | A name that this endpoint can be identified by |
| managingOrganization | S | 0..1 | Reference(VhDir Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
| contact | S | 0..1 | ContactPoint | Contact details for source (e.g. troubleshooting) |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| availabletime | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
| viaintermediary | S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary |
| system | S | 1..1 | code | phone | fax | email | pager | url | sms | other |
| value | S | 1..1 | string | The actual contact point details |
| use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
| rank | S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period | S | 0..1 | Period | Time period when the contact point was/is in use |
| period | S | 0..1 | Period | Interval the endpoint is expected to be operational |
| payloadType | S | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) |
| payloadMimeType | S | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) |
| address | S | 1..1 | url | The technical base address for connecting to this endpoint |
| header | S | 0..* | string | Usage depends on the channel type |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| restriction | S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction |
| usecase | S | 0..* | (Complex) | Use cases (service descriptions) supported by the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase |
| rank | S | 0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-rank |
| digitalcertificate | S | 0..* | (Complex) | Digital certificate associated with the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| status | S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
| use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
| period | SΣ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
| status | ?!SΣ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. |
| connectionType | SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible) |
| name | SΣ | 0..1 | string | A name that this endpoint can be identified by |
| managingOrganization | SΣ | 0..1 | Reference(VhDir Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
| contact | S | 0..1 | ContactPoint | Contact details for source (e.g. troubleshooting) |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| availabletime | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
| viaintermediary | S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary |
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | SΣ | 1..1 | string | The actual contact point details |
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period | SΣ | 0..1 | Period | Time period when the contact point was/is in use |
| period | SΣ | 0..1 | Period | Interval the endpoint is expected to be operational |
| payloadType | SΣ | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) |
| payloadMimeType | SΣ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. |
| address | SΣ | 1..1 | url | The technical base address for connecting to this endpoint |
| header | S | 0..* | string | Usage depends on the channel type |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Endpoint.identifier.use | required | IdentifierUse |
| Endpoint.identifier.type | extensible | Identifier Type Codes |
| Endpoint.status | required | EndpointStatus |
| Endpoint.connectionType | extensible | EndpointConnectionType |
| Endpoint.contact.system | required | ContactPointSystem |
| Endpoint.contact.use | required | ContactPointUse |
| Endpoint.payloadType | example | EndpointPayloadType |
| Endpoint.payloadMimeType | required | Mime Types (a valid code from urn:ietf:bcp:13) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Endpoint | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| restriction | S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction | ||||
| usecase | S | 0..* | (Complex) | Use cases (service descriptions) supported by the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase | ||||
| rank | S | 0..1 | positiveInt | Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-rank | ||||
| digitalcertificate | S | 0..* | (Complex) | Digital certificate associated with the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| status | S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) | ||||
| use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | SΣ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) | ||||
| status | ?!SΣ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. | ||||
| connectionType | SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible) | ||||
| name | SΣ | 0..1 | string | A name that this endpoint can be identified by | ||||
| managingOrganization | SΣ | 0..1 | Reference(VhDir Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | ||||
| contact | S | 0..1 | ContactPoint | Contact details for source (e.g. troubleshooting) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| availabletime | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime | ||||
| viaintermediary | S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary | ||||
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | SΣ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| period | SΣ | 0..1 | Period | Interval the endpoint is expected to be operational | ||||
| payloadType | SΣ | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) | ||||
| payloadMimeType | SΣ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | ||||
| address | SΣ | 1..1 | url | The technical base address for connecting to this endpoint | ||||
| header | S | 0..* | string | Usage depends on the channel type | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Endpoint.language | preferred | CommonLanguages
| ||||
| Endpoint.identifier.use | required | IdentifierUse | ||||
| Endpoint.identifier.type | extensible | Identifier Type Codes | ||||
| Endpoint.status | required | EndpointStatus | ||||
| Endpoint.connectionType | extensible | EndpointConnectionType | ||||
| Endpoint.contact.system | required | ContactPointSystem | ||||
| Endpoint.contact.use | required | ContactPointUse | ||||
| Endpoint.payloadType | example | EndpointPayloadType | ||||
| Endpoint.payloadMimeType | required | Mime Types (a valid code from urn:ietf:bcp:13) |
This structure is derived from Endpoint
Summary
Mandatory: 0 element (3 nested mandatory elements)
Must-Support: 29 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
GET [base]/Endpoint?connection-type=[code]
Support: SHALL support search by the connection-type parameter
textGET [base]/Endpoint?identifier=[code]
Support: SHALL support search by the identifier parameter
text, ofTypeGET [base]/Endpoint?identifier-assigner=[id]
Support: MAY support search by the identifier-assigner parameter
Organizationbeloworganization-identifier, organization-nameGET [base]/Endpoint?mime-type=[code]
Support: MAY support search by the mime-type parameter
GET [base]/Endpoint?organization=[id]
Support: SHALL support search by the organization parameter
Organizationabove, beloworganization.identifier, organization.name, organization.address, organization.partof, organization-typeGET [base]/Endpoint?payload-type=[code]
Support: SHOULD support search by the payload-type parameter
textGET [base]/Endpoint?status=[code]
Support: SHALL support search by the status parameter
GET [base]/Endpoint?usecase-standard=[uri]
Support: SHOULD support search by the usecase-standard parameter
belowGET [base]/Endpoint?usecase-type=[code]
Support: SHOULD support search by the usecase-type parameter
textGET [base]/Endpoint?via-intermediary=[id]
Support: MAY support search by the via-intermediary parameter
PractitionerRole, Organization, OrganizationAffiliation, Location
IG © 2022+ HL7 International - Patient Administration Work Group. Package hl7.fhir.uv.vhdir#0.2.0 based on FHIR 4.0.1. Generated 2023-09-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change