Pan-Canadian Care Service Directory
DFT-pre-ballot-1.1.1 
DFT-preBallot - The specification is currently in pre-ballot review and subject to change. For a full list of available versions, see the Directory of published versions
Endpoint
Links
Profile
Derived from
https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.Endpoint
Examples
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
Resource Content
| Endpoint | C | MCSDEndpoint | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..0 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| purposeOfUse | C | 0..* | Extension(CodeableConcept) |
| modifierExtension | ?! C | 0..0 | Extension |
| identifier | SO Σ | 0..* | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | SO Σ | 1..1 | uri |
| value | SO Σ | 1..1 | string |
| period | Σ | 0..1 | Period |
| assigner | Σ | 0..1 | Reference(Organization) |
| status | SO Σ ?! | 1..1 | codeBinding |
| connectionType | Σ | 1..1 | CodingBinding |
| name | Σ | 0..1 | string |
| managingOrganization | SO Σ | 1..1 | Reference(Organization) |
| contact | 0..* | ContactPoint | |
| period | SO Σ | 0..1 | Period |
| payloadType | Σ | 1..* | CodeableConcept |
| payloadMimeType | Σ | 0..* | codeBinding |
| address | Σ | 1..1 | url |
| header | 0..* | string |
| Endpoint | MCSDEndpoint | ||
| purposeOfUse | Extension(CodeableConcept) | ||
| identifier | SO | ||
| system | SO | 1..1 | |
| value | SO | 1..1 | |
| status | SO | ||
| managingOrganization | SO | Reference(Organization) | |
| period | O |
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="SHALL:ihe-r2 is expected, even though the modifier in the ValueSet has yet to be applied." />
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="SHALL:ihe-r2 is expected, even though the modifier in the ValueSet has yet to be applied." />
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
<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 © 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)." />
</type>
</element>
</element>
</element>
</element>
<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." />
</element>
<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." />
<targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization" />
</type>
</element>
<comment value="This element represents the overall lifetime of this endpoint. mustSupport element identified within the IHE mCSD endpoint profile." />
</element>
</differential>
</StructureDefinition>
{
{
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
"valueMarkdown": "SHALL:ihe-r2 is expected, even though the modifier in the ValueSet has yet to be applied."
}
]
},
{
{
},
{
},
{
},
{
},
{
"valueMarkdown": "SHALL:ihe-r2 is expected, even though the modifier in the ValueSet has yet to be applied."
}
]
},
{
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
}
]
}
],
"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).",
{
{
"https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse"
]
}
]
},
{
},
{
},
{
},
{
"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.",
},
{
"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.",
{
"http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization"
]
}
],
},
{
"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)
| Path | Conformance | ValueSet |
|---|---|---|
| Endpoint.language | preferred | http://hl7.org/fhir/ValueSet/languages |
| Endpoint.identifier.use | required | http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 |
| Endpoint.identifier.type | extensible | http://hl7.org/fhir/ValueSet/identifier-type |
| Endpoint.status | required | http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 |
| Endpoint.connectionType | extensible | http://hl7.org/fhir/ValueSet/endpoint-connection-type |
| Endpoint.payloadType | example | http://hl7.org/fhir/ValueSet/endpoint-payload-type |
| Endpoint.payloadMimeType | required | http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 |
| Path | Conformance | ValueSet |
|---|---|---|
| Endpoint.language | preferred | http://hl7.org/fhir/ValueSet/languages |
| Endpoint.identifier.use | required | http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 |
| Endpoint.identifier.type | extensible | http://hl7.org/fhir/ValueSet/identifier-type |
| Endpoint.status | required | http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 |
| Endpoint.connectionType | extensible | http://hl7.org/fhir/ValueSet/endpoint-connection-type |
| Endpoint.payloadType | example | http://hl7.org/fhir/ValueSet/endpoint-payload-type |
| Endpoint.payloadMimeType | required | http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 |
Constraints
Obligations
| Obligations | Actor | Element |
|---|---|---|
| SHALL:able-to-populate, SHOULD:populate | http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server | Endpoint.identifier, Endpoint.identifier.system, Endpoint.identifier.value, Endpoint.status, Endpoint.managingOrganization |
| ihe-r2, SHOULD:populate | http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server | Endpoint.period |
| SHALL:no-error | http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/client | Endpoint.identifier, Endpoint.identifier.system, Endpoint.identifier.value, Endpoint.period, Endpoint.status, Endpoint.managingOrganization |