DFT Ballot - 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
Derived from
https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.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
Resource Content
Endpoint | |||
purposeOfUse | Extension(CodeableConcept) | ||
identifier | S | ||
status | S | ||
managingOrganization | S | Reference(Organization) | |
period |
Endpoint | I | ||
extension | I | 0..* | Extension |
purposeOfUse | I | 0..* | Extension(CodeableConcept) |
identifier | S Σ | 0..* | Identifier |
status | S Σ ?! | 1..1 | codeBinding |
connectionType | Σ | 1..1 | CodingBinding |
name | Σ | 0..1 | string |
managingOrganization | S Σ | 1..1 | Reference(Organization) |
contact | 0..* | ContactPoint | |
period | S Σ | 0..1 | Period |
payloadType | Σ | 1..* | CodeableConcept |
payloadMimeType | Σ | 0..* | codeBinding |
address | Σ | 1..1 | url |
header | 0..* | string |
<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 © 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", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "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" } ] } ], "id": "CA-CSD-Endpoint", "url": "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Endpoint", "name": "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.", "status": "draft", "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
Constraints
Obligations
Obligations | Actor | Element |
---|---|---|
SHALL:able-to-populate; SHOULD:populate | http://fhir.infoway-inforoute.ca/io/CA-CSD/ActorDefinition/server | Endpoint.identifier; 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.period; Endpoint.status; Endpoint.managingOrganization |