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:

1. Identifier status (1..1) - indicates the status of an endpoint's identifier
2. Via intermediary (0..1) - a reference to an alternative point of contact for this endpoint
3. Available time (0..*) - indicates when the point of contact for an endpoint is available
4. UseCase (0..*) - an enumeration of the specific use cases (service descriptions) supported by the endpoint
5. Rank (0..1) - an indication of the preferred order for connecting to an endpoint when multiple endpoints capable of transferring the same content are listed
6. DigitalCertificate (0..*) - a digital certificate associated with the endpoint
7. Restriction (0..*) - indicates whether disclosure of any data associated with an endpoint is restricted

Examples:

The following are example uses for the vhdir-endpoint profile:

• A Direct address used by cardiologists at the Founding Fathers Memorial Hospital Heart and Vascular Institute

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:

1. A status code in endpoint.status
2. A connectionType code in endpoint.connectionType
3. At least one indication of the type of content the endpoint supports in endpoint.payloadType
4. One technical address for connecting to the endpoint in endpoint.address

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
Endpoint		0..*	Endpoint	The technical details of an endpoint that can be used for electronic services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
restriction	S	0..*	Reference(VhDir Restriction)	Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
usecase	S	0..*	(Complex)	Use cases (service descriptions) supported by the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
rank	S	0..1	positiveInt	Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-rank ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
digitalcertificate	S	0..*	(Complex)	Digital certificate associated with the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	0..*	Identifier	Identifies this endpoint across multiple systems ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	S	1..1	code	Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
period	SΣ	0..1	Period	Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children
assigner	SΣ	0..1	Reference(VhDir Organization)	Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children
status	?!SΣ	1..1	code	active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. ele-1: All FHIR elements must have a @value or children
connectionType	SΣ	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible) ele-1: All FHIR elements must have a @value or children
name	SΣ	0..1	string	A name that this endpoint can be identified by ele-1: All FHIR elements must have a @value or children
managingOrganization	SΣ	0..1	Reference(VhDir Organization)	Organization that manages this endpoint (might not be the organization that exposes the endpoint) ele-1: All FHIR elements must have a @value or children
contact	S	0..1	ContactPoint	Contact details for source (e.g. troubleshooting) ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
availabletime	S	0..*	(Complex)	Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest) ele-1: All FHIR elements must have a @value or children
period	SΣ	0..1	Period	Time period when the contact point was/is in use ele-1: All FHIR elements must have a @value or children
period	SΣ	0..1	Period	Interval the endpoint is expected to be operational ele-1: All FHIR elements must have a @value or children
payloadType	SΣ	1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
address	SΣ	1..1	url	The technical base address for connecting to this endpoint ele-1: All FHIR elements must have a @value or children
header	S	0..*	string	Usage depends on the channel type ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Endpoint.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Endpoint.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Endpoint.status	required	EndpointStatus http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 from the FHIR Standard
Endpoint.connectionType	extensible	EndpointConnectionType http://hl7.org/fhir/ValueSet/endpoint-connection-type from the FHIR Standard
Endpoint.contact.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Endpoint.contact.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Endpoint.payloadType	example	EndpointPayloadType http://hl7.org/fhir/ValueSet/endpoint-payload-type from the FHIR Standard
Endpoint.payloadMimeType	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard

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		1..*	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
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. Additional Bindings Purpose AllLanguages Max Binding
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		1..*	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

Terminology Bindings

Path	Conformance	ValueSet	URI
Endpoint.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Endpoint.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Endpoint.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Endpoint.status	required	EndpointStatus http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 from the FHIR Standard
Endpoint.connectionType	extensible	EndpointConnectionType http://hl7.org/fhir/ValueSet/endpoint-connection-type from the FHIR Standard
Endpoint.contact.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Endpoint.contact.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Endpoint.payloadType	example	EndpointPayloadType http://hl7.org/fhir/ValueSet/endpoint-payload-type from the FHIR Standard
Endpoint.payloadMimeType	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard

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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
restriction	S	0..*	Reference(VhDir Restriction)	Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
usecase	S	0..*	(Complex)	Use cases (service descriptions) supported by the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
rank	S	0..1	positiveInt	Preferred order for connecting to the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-rank ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
digitalcertificate	S	0..*	(Complex)	Digital certificate associated with the endpoint URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	0..*	Identifier	Identifies this endpoint across multiple systems ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	S	1..1	code	Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
period	SΣ	0..1	Period	Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children
assigner	SΣ	0..1	Reference(VhDir Organization)	Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children
status	?!SΣ	1..1	code	active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. ele-1: All FHIR elements must have a @value or children
connectionType	SΣ	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connection Binding: EndpointConnectionType (extensible) ele-1: All FHIR elements must have a @value or children
name	SΣ	0..1	string	A name that this endpoint can be identified by ele-1: All FHIR elements must have a @value or children
managingOrganization	SΣ	0..1	Reference(VhDir Organization)	Organization that manages this endpoint (might not be the organization that exposes the endpoint) ele-1: All FHIR elements must have a @value or children
contact	S	0..1	ContactPoint	Contact details for source (e.g. troubleshooting) ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
availabletime	S	0..*	(Complex)	Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
rank	SΣ	0..1	positiveInt	Specify preferred order of use (1 = highest) ele-1: All FHIR elements must have a @value or children
period	SΣ	0..1	Period	Time period when the contact point was/is in use ele-1: All FHIR elements must have a @value or children
period	SΣ	0..1	Period	Interval the endpoint is expected to be operational ele-1: All FHIR elements must have a @value or children
payloadType	SΣ	1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: EndpointPayloadType (example) ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
address	SΣ	1..1	url	The technical base address for connecting to this endpoint ele-1: All FHIR elements must have a @value or children
header	S	0..*	string	Usage depends on the channel type ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Endpoint.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Endpoint.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Endpoint.status	required	EndpointStatus http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 from the FHIR Standard
Endpoint.connectionType	extensible	EndpointConnectionType http://hl7.org/fhir/ValueSet/endpoint-connection-type from the FHIR Standard
Endpoint.contact.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Endpoint.contact.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Endpoint.payloadType	example	EndpointPayloadType http://hl7.org/fhir/ValueSet/endpoint-payload-type from the FHIR Standard
Endpoint.payloadMimeType	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard

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		1..*	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

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. Additional Bindings Purpose AllLanguages Max Binding
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		1..*	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

Terminology Bindings

Path	Conformance	ValueSet	URI
Endpoint.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Endpoint.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Endpoint.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Endpoint.status	required	EndpointStatus http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 from the FHIR Standard
Endpoint.connectionType	extensible	EndpointConnectionType http://hl7.org/fhir/ValueSet/endpoint-connection-type from the FHIR Standard
Endpoint.contact.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Endpoint.contact.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Endpoint.payloadType	example	EndpointPayloadType http://hl7.org/fhir/ValueSet/endpoint-payload-type from the FHIR Standard
Endpoint.payloadMimeType	required	Mime Types (a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard

This structure is derived from Endpoint

Summary

Mandatory: 0 element(4 nested mandatory elements)
Must-Support: 29 elements

Structures

This structure refers to these other structures:

• VhDir Organization (http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-organization)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-usecase
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-rank
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
• http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary

Maturity: 2

Supported Searches

1. GET [base]/Endpoint?connection-type=[code]

   Support: SHALL support search by the connection-type parameter

   • including the modifiers: text

1. GET [base]/Endpoint?identifier=[code]

   Support: SHALL support search by the identifier parameter

   • including the modifiers: text, ofType

1. GET [base]/Endpoint?identifier-assigner=[id]

   Support: MAY support search by the identifier-assigner parameter

   • with a target type: Organization
   • including the modifiers: below
   • including these search paramaters which may be chained: organization-identifier, organization-name

1. GET [base]/Endpoint?mime-type=[code]

   Support: MAY support search by the mime-type parameter

1. GET [base]/Endpoint?organization=[id]

   Support: SHALL support search by the organization parameter

   • with a target type: Organization
   • including the modifiers: above, below
   • including these search paramaters which may be chained: organization.identifier, organization.name, organization.address, organization.partof, organization-type

1. GET [base]/Endpoint?payload-type=[code]

   Support: SHOULD support search by the payload-type parameter

   • including the modifiers: text

1. GET [base]/Endpoint?status=[code]

   Support: SHALL support search by the status parameter

1. GET [base]/Endpoint?usecase-standard=[uri]

   Support: SHOULD support search by the usecase-standard parameter

   • including the modifiers: below

1. GET [base]/Endpoint?usecase-type=[code]

   Support: SHOULD support search by the usecase-type parameter

   • including the modifiers: text

1. GET [base]/Endpoint?via-intermediary=[id]

   Support: MAY support search by the via-intermediary parameter

   • with a target type: PractitionerRole, Organization, OrganizationAffiliation, Location