Visit the HL7 website
Visit the FHIR website

Pan-Canadian Care Service Directory (1.0.0-DFT)

1.0.0-DFT   Canada flag
  • Table-of-Contents
  • Home
  • Business Context
    • Guidance
    • Usage Highlights
    • Use Cases
    • Guide Considerations
  • Technical Context
    • Overview
    • Background
    • Roles Description
    • Model Diagrams
    • Queries
    • Bulk Export
  • FHIR Artifacts
    • Endpoint
    • Extension DeliveryMethod
    • Extension UsageLicense
    • FacilityLocation
    • FacilityOrganization
    • HealthcareService
    • JurisdictionLocation
    • JurisdictionOrganization
    • Location
    • LocationDistance
    • Organization
    • OrganizationAffiliation
    • Practitioner
    • PractitionerRole
    • Capability Statements
    • Operations
    • Example - Queries
    • Example - Resources
  • Change Log
    1. Table-of-Contents
    2. FHIR Artifacts
    3. Endpoint

DFT - The specification is currently in ballot review and subject to change. It is not ready for limited roll-out or production level use. For a full list of available versions, see the Directory of published versions

Endpoint

Links

Profile

CA-CSD-Endpoint

Derived from

https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.Endpoint

Examples

ca-csd-example-endpoint

Description

An Endpoint is used to allow access to an Organization, OrganizationAffilication, Location, HealthcareService, or PractitionerRole. Although recommended, the Endpoint is not required to be a FHIR server, but may be a webservice or another mechanism. The omission of an Endpoint on a resource does not mean it is not accessible, as it may be reachable through another resource relationship.

References to this resource

OrganizationAffiliation

Resource Content

  • Tree view
  • Overview
  • XML
  • JSON
EndpointIMCSDEndpoint
There are no (further) constraints on this element
Element id

Endpoint

Short description

The technical details of an endpoint that can be used for electronic services

Definition

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.

Data type

MCSDEndpoint

Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • 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
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: Entity. Role, or Act
  • rim: n/a
idΣ0..1id
There are no (further) constraints on this element
Element id

Endpoint.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

id

metaΣ0..1Meta
There are no (further) constraints on this element
Element id

Endpoint.meta

Short description

Metadata about the resource

Definition

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.

Data type

Meta

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
implicitRulesΣ ?!0..0uri
There are no (further) constraints on this element
Element id

Endpoint.implicitRules

Short description

A set of rules under which this content was created

Definition

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.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
language0..1codeBinding
There are no (further) constraints on this element
Element id

Endpoint.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
text0..1Narrative
There are no (further) constraints on this element
Element id

Endpoint.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

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.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id

Endpoint.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

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.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings
  • rim: N/A
extensionI0..*Extension
There are no (further) constraints on this element
Element id

Endpoint.extension

Short description

Extension

Definition

An Extension

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
purposeOfUseI0..*Extension(CodeableConcept)
There are no (further) constraints on this element
Element id

Endpoint.extension:purposeOfUse

Short description

Purpose of Use Extension

Definition

Set a purpose of use for an mCSD Endpoint or mCSD Organization.

Data type

Extension(CodeableConcept)

Extension URL

https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
modifierExtension?! I0..0Extension
There are no (further) constraints on this element
Element id

Endpoint.modifierExtension

Short description

Extension

Definition

An Extension

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
identifierS Σ0..*IdentifierElement id

Endpoint.identifier

Short description

Identifies this endpoint across multiple systems

Definition

Identifier for the organization that is used to identify the endpoint across multiple disparate systems.

Comments

mustSupport element identified within the IHE mCSD endpoint profile.

Data type

Identifier

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • rim: n/a
statusS Σ ?!1..1codeBindingElement id

Endpoint.status

Short description

represents the current status of this endpoint.

Definition

active | suspended | error | off | test.

Comments

Represents the current status of this endpoint (i.e. active). Identified as a query requirement through mCSD CapabilityStatement. mustSupport element identified within the IHE mCSD endpoint profile.

Data type

code

Binding

The status of the endpoint.

EndpointStatus (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • rim: n/a
connectionTypeΣ1..1CodingBinding
There are no (further) constraints on this element
Element id

Endpoint.connectionType

Short description

Protocol/Profile/Standard to be used with this endpoint connection

Definition

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).

Comments

For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example.

Data type

Coding

Binding

EndpointConnectionType (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • rim: n/a
nameΣ0..1string
There are no (further) constraints on this element
Element id

Endpoint.name

Short description

A name that this endpoint can be identified by

Definition

A friendly name that this endpoint can be referred to with.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.what[x]
  • rim: n/a
managingOrganizationS Σ1..1Reference(Organization)Element id

Endpoint.managingOrganization

Short description

Organization that manages this endpoint.

Definition

The organization that manages this endpoint, even if technically another organization is hosting this in the cloud.

Comments

Organization that manages this endpoint. Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated. Allows the search to return the organization without having to go through the practitionerRole resource.

Data type

Reference(Organization)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
contact0..*ContactPoint
There are no (further) constraints on this element
Element id

Endpoint.contact

Short description

Contact details for source (e.g. troubleshooting)

Definition

Contact details for a human to contact about the endpoint. The primary use of this for system administrator troubleshooting.

Data type

ContactPoint

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
periodS Σ0..1PeriodElement id

Endpoint.period

Short description

Overall deployment lifetime for this endpoint.

Definition

The interval during which the endpoint is expected to be operational.

Comments

This element represents the overall lifetime of this endpoint. mustSupport element identified within the IHE mCSD endpoint profile.

Data type

Period

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.done[x]
  • rim: n/a
payloadTypeΣ1..*CodeableConcept
There are no (further) constraints on this element
Element id

Endpoint.payloadType

Short description

The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)

Definition

The payload type describes the acceptable content that can be communicated on the endpoint.

Comments

The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan.

Data type

CodeableConcept

Binding

EndpointPayloadType (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
payloadMimeTypeΣ0..*codeBinding
There are no (further) constraints on this element
Element id

Endpoint.payloadMimeType

Short description

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

Definition

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).

Comments

Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.

Data type

code

Binding

The mime type of an attachment. Any valid mime type is allowed.

Mime Types (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
addressΣ1..1url
There are no (further) constraints on this element
Element id

Endpoint.address

Short description

The technical base address for connecting to this endpoint

Definition

The uri that describes the actual end-point to connect to.

Comments

For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs)

This address will be to the service base, without any parameters, or sub-services or resources tacked on.

E.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs"

and not "https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...".

Data type

url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
header0..*string
There are no (further) constraints on this element
Element id

Endpoint.header

Short description

Usage depends on the channel type

Definition

Additional headers / information to send as part of the notification.

Comments

Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
EndpointMCSDEndpoint
There are no (further) constraints on this element
Data type

MCSDEndpoint

purposeOfUseExtension(CodeableConcept)
There are no (further) constraints on this element
Element id

Endpoint.extension:purposeOfUse

Data type

Extension(CodeableConcept)

Extension URL

https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse

identifierS
There are no (further) constraints on this element
Element id

Endpoint.identifier

Comments

mustSupport element identified within the IHE mCSD endpoint profile.

statusS
There are no (further) constraints on this element
Element id

Endpoint.status

Comments

Represents the current status of this endpoint (i.e. active). Identified as a query requirement through mCSD CapabilityStatement. mustSupport element identified within the IHE mCSD endpoint profile.

managingOrganizationSReference(Organization)
There are no (further) constraints on this element
Element id

Endpoint.managingOrganization

Comments

Organization that manages this endpoint. Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated. Allows the search to return the organization without having to go through the practitionerRole resource.

Data type

Reference(Organization)

period
There are no (further) constraints on this element
Element id

Endpoint.period

Comments

This element represents the overall lifetime of this endpoint. mustSupport element identified within the IHE mCSD endpoint profile.

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="CA-CSD-Endpoint" />
    <extension url="http://hl7.org/fhir/StructureDefinition/obligation">
        <extension url="code">
            <valueCode value="SHALL:able-to-populate" />
        </extension>
        <extension url="code">
            <valueCode value="SHOULD:populate" />
        </extension>
        <extension url="elementId">
            <valueString value="Endpoint.identifier" />
        </extension>
        <extension url="elementId">
            <valueString value="Endpoint.status" />
        </extension>
        <extension url="elementId">
            <valueString value="Endpoint.managingOrganization" />
        </extension>
        <extension url="actor">
            <valueCanonical value="http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server" />
        </extension>
        <extension url="documentation">
            <valueMarkdown value="SHALL:ihe-r2 is expected, even though the modifier in the ValueSet has yet to be applied." />
        </extension>
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/obligation">
        <extension url="code">
            <valueCode value="ihe-r2" />
        </extension>
        <extension url="code">
            <valueCode value="SHOULD:populate" />
        </extension>
        <extension url="elementId">
            <valueString value="Endpoint.period" />
        </extension>
        <extension url="actor">
            <valueCanonical value="http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server" />
        </extension>
        <extension url="documentation">
            <valueMarkdown value="SHALL:ihe-r2 is expected, even though the modifier in the ValueSet has yet to be applied." />
        </extension>
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/obligation">
        <extension url="code">
            <valueCode value="SHALL:no-error" />
        </extension>
        <extension url="elementId">
            <valueString value="Endpoint.identifier" />
        </extension>
        <extension url="elementId">
            <valueString value="Endpoint.period" />
        </extension>
        <extension url="elementId">
            <valueString value="Endpoint.status" />
        </extension>
        <extension url="elementId">
            <valueString value="Endpoint.managingOrganization" />
        </extension>
        <extension url="actor">
            <valueCanonical value="http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client" />
        </extension>
    </extension>
    <url value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Endpoint" />
    <name value="Endpoint" />
    <status value="draft" />
    <description value="An Endpoint is used to allow access to an Organization, OrganizationAffilication, Location, HealthcareService, or PractitionerRole.  Although recommended, the Endpoint is not required to be a FHIR server, but may be a webservice or another mechanism.   The omission of an Endpoint on a resource does not mean it is not accessible, as it may be reachable through another resource relationship." />
    <copyright value="Copyright &#169; 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy)." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Endpoint" />
    <baseDefinition value="https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.Endpoint" />
    <derivation value="constraint" />
    <differential>
        <element id="Endpoint.extension:purposeOfUse">
            <path value="Endpoint.extension" />
            <sliceName value="purposeOfUse" />
            <type>
                <code value="Extension" />
                <profile value="https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse" />
            </type>
        </element>
        <element id="Endpoint.identifier">
            <path value="Endpoint.identifier" />
            <comment value="mustSupport element identified within the IHE mCSD endpoint profile." />
            <mustSupport value="true" />
        </element>
        <element id="Endpoint.status">
            <path value="Endpoint.status" />
            <comment value="Represents the current status of this endpoint (i.e. active). Identified as a query requirement through mCSD CapabilityStatement. mustSupport element identified within the IHE mCSD endpoint profile." />
            <mustSupport value="true" />
        </element>
        <element id="Endpoint.managingOrganization">
            <path value="Endpoint.managingOrganization" />
            <comment value="Organization that manages this endpoint. Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated. Allows the search to return the organization without having to go through the practitionerRole resource." />
            <type>
                <code value="Reference" />
                <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Endpoint.period">
            <path value="Endpoint.period" />
            <comment value="This element represents the overall lifetime of this endpoint. mustSupport element identified within the IHE mCSD endpoint profile." />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "CA-CSD-Endpoint",
    "extension":  [
        {
            "extension":  [
                {
                    "url": "code",
                    "valueCode": "SHALL:able-to-populate"
                },
                {
                    "url": "code",
                    "valueCode": "SHOULD:populate"
                },
                {
                    "url": "elementId",
                    "valueString": "Endpoint.identifier"
                },
                {
                    "url": "elementId",
                    "valueString": "Endpoint.status"
                },
                {
                    "url": "elementId",
                    "valueString": "Endpoint.managingOrganization"
                },
                {
                    "url": "actor",
                    "valueCanonical": "http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server"
                },
                {
                    "url": "documentation",
                    "valueMarkdown": "SHALL:ihe-r2 is expected, even though the modifier in the ValueSet has yet to be applied."
                }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
        },
        {
            "extension":  [
                {
                    "url": "code",
                    "valueCode": "ihe-r2"
                },
                {
                    "url": "code",
                    "valueCode": "SHOULD:populate"
                },
                {
                    "url": "elementId",
                    "valueString": "Endpoint.period"
                },
                {
                    "url": "actor",
                    "valueCanonical": "http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server"
                },
                {
                    "url": "documentation",
                    "valueMarkdown": "SHALL:ihe-r2 is expected, even though the modifier in the ValueSet has yet to be applied."
                }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
        },
        {
            "extension":  [
                {
                    "url": "code",
                    "valueCode": "SHALL:no-error"
                },
                {
                    "url": "elementId",
                    "valueString": "Endpoint.identifier"
                },
                {
                    "url": "elementId",
                    "valueString": "Endpoint.period"
                },
                {
                    "url": "elementId",
                    "valueString": "Endpoint.status"
                },
                {
                    "url": "elementId",
                    "valueString": "Endpoint.managingOrganization"
                },
                {
                    "url": "actor",
                    "valueCanonical": "http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client"
                }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
        }
    ],
    "url": "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Endpoint",
    "name": "Endpoint",
    "status": "draft",
    "description": "An Endpoint is used to allow access to an Organization, OrganizationAffilication, Location, HealthcareService, or PractitionerRole.  Although recommended, the Endpoint is not required to be a FHIR server, but may be a webservice or another mechanism.   The omission of an Endpoint on a resource does not mean it is not accessible, as it may be reachable through another resource relationship.",
    "copyright": "Copyright © 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Endpoint",
    "baseDefinition": "https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.Endpoint",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Endpoint.extension:purposeOfUse",
                "path": "Endpoint.extension",
                "sliceName": "purposeOfUse",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse"
                        ]
                    }
                ]
            },
            {
                "id": "Endpoint.identifier",
                "path": "Endpoint.identifier",
                "comment": "mustSupport element identified within the IHE mCSD endpoint profile.",
                "mustSupport": true
            },
            {
                "id": "Endpoint.status",
                "path": "Endpoint.status",
                "comment": "Represents the current status of this endpoint (i.e. active). Identified as a query requirement through mCSD CapabilityStatement. mustSupport element identified within the IHE mCSD endpoint profile.",
                "mustSupport": true
            },
            {
                "id": "Endpoint.managingOrganization",
                "path": "Endpoint.managingOrganization",
                "comment": "Organization that manages this endpoint. Identified as a query requirement through mCSD CapabilityStatement. Elements with a modified minimum cardinality of 1 will have a mustSupport element to ensure that it is populated. Allows the search to return the organization without having to go through the practitionerRole resource.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Endpoint.period",
                "path": "Endpoint.period",
                "comment": "This element represents the overall lifetime of this endpoint. mustSupport element identified within the IHE mCSD endpoint profile."
            }
        ]
    }
}

Terminology bindings (Differential)

Terminology bindings (Snapshot)

PathConformanceValueSet
Endpoint.languagepreferredhttp://hl7.org/fhir/ValueSet/languages
Endpoint.statusrequiredhttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
Endpoint.connectionTypeextensiblehttp://hl7.org/fhir/ValueSet/endpoint-connection-type
Endpoint.payloadTypeexamplehttp://hl7.org/fhir/ValueSet/endpoint-payload-type
Endpoint.payloadMimeTyperequiredhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1
PathConformanceValueSet
Endpoint.languagepreferredhttp://hl7.org/fhir/ValueSet/languages
Endpoint.statusrequiredhttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
Endpoint.connectionTypeextensiblehttp://hl7.org/fhir/ValueSet/endpoint-connection-type
Endpoint.payloadTypeexamplehttp://hl7.org/fhir/ValueSet/endpoint-payload-type
Endpoint.payloadMimeTyperequiredhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1

Constraints

Obligations

ObligationsActorElement
SHALL:able-to-populate; SHOULD:populatehttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/serverEndpoint.identifier; Endpoint.status; Endpoint.managingOrganization
ihe-r2; SHOULD:populatehttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/serverEndpoint.period
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/clientEndpoint.identifier; Endpoint.period; Endpoint.status; Endpoint.managingOrganization

Table of Contents | IG © based on FHIR R4 | Package package:ca.infoway.io.ca-csd@1.0.3-DFT | Version History
HL7® and FHIR® are the registered trademarks of Health Level Seven International