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 | I | MCSDEndpoint | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..0 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
purposeOfUse | I | 0..* | Extension(CodeableConcept) |
modifierExtension | ?! I | 0..0 | Extension |
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 |
Endpoint | I | 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 | I | 0..* | Extension |
purposeOfUse | I | 0..* | Extension(CodeableConcept) |
modifierExtension | ?! I | 0..0 | Extension |
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" /> <snapshot> <element id="Endpoint"> <path value="Endpoint" /> <short value="The technical details of an endpoint that can be used for electronic services" /> <definition value="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." /> <min value="0" /> <max value="*" /> <base> <path value="Endpoint" /> <min value="0" /> <max value="*" /> </base> <constraint> <key value="dom-2" /> <severity value="error" /> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources" /> <expression value="contained.contained.empty()" /> <xpath value="not(parent::f:contained and f:contained)" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <key value="dom-3" /> <severity value="error" /> <human value="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" /> <expression value="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()" /> <xpath value="not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <key value="dom-4" /> <severity value="error" /> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated" /> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" /> <xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <key value="dom-5" /> <severity value="error" /> <human value="If a resource is contained in another resource, it SHALL NOT have a security label" /> <expression value="contained.meta.security.empty()" /> <xpath value="not(exists(f:contained/*/f:meta/f:security))" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice"> <valueBoolean value="true" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation"> <valueMarkdown value="When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." /> </extension> <key value="dom-6" /> <severity value="warning" /> <human value="A resource should have narrative for robust management" /> <expression value="text.`div`.exists()" /> <xpath value="exists(f:text/h:div)" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="Entity. Role, or Act" /> </mapping> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Endpoint.id"> <path value="Endpoint.id" /> <short value="Logical id of this artifact" /> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." /> <comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="true" /> </element> <element id="Endpoint.meta"> <path value="Endpoint.meta" /> <short value="Metadata about the resource" /> <definition value="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." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.meta" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Meta" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> </element> <element id="Endpoint.implicitRules"> <path value="Endpoint.implicitRules" /> <short value="A set of rules under which this content was created" /> <definition value="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." /> <comment value="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." /> <min value="0" /> <max value="0" /> <base> <path value="Resource.implicitRules" /> <min value="0" /> <max value="1" /> </base> <type> <code value="uri" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="true" /> <isModifierReason value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation" /> <isSummary value="true" /> </element> <element id="Endpoint.language"> <path value="Endpoint.language" /> <short value="Language of the resource content" /> <definition value="The base language in which the resource is written." /> <comment value="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)." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.language" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true" /> </extension> <strength value="preferred" /> <description value="A human language." /> <valueSet value="http://hl7.org/fhir/ValueSet/languages" /> </binding> </element> <element id="Endpoint.text"> <path value="Endpoint.text" /> <short value="Text summary of the resource, for human interpretation" /> <definition value="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." /> <comment value="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." /> <alias value="narrative" /> <alias value="html" /> <alias value="xhtml" /> <alias value="display" /> <min value="0" /> <max value="1" /> <base> <path value="DomainResource.text" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Narrative" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="Act.text?" /> </mapping> </element> <element id="Endpoint.contained"> <path value="Endpoint.contained" /> <short value="Contained, inline Resources" /> <definition value="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." /> <comment value="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." /> <alias value="inline resources" /> <alias value="anonymous resources" /> <alias value="contained resources" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.contained" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Resource" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Endpoint.extension"> <path value="Endpoint.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <ordered value="false" /> <rules value="open" /> </slicing> <short value="Extension" /> <definition value="An Extension" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> </element> <element id="Endpoint.extension:purposeOfUse"> <path value="Endpoint.extension" /> <sliceName value="purposeOfUse" /> <short value="Purpose of Use Extension" /> <definition value="Set a purpose of use for an mCSD Endpoint or mCSD Organization." /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> <profile value="https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse" /> </type> <condition value="ele-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> </element> <element id="Endpoint.modifierExtension"> <path value="Endpoint.modifierExtension" /> <short value="Extension" /> <definition value="An Extension" /> <min value="0" /> <max value="0" /> <base> <path value="DomainResource.modifierExtension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="true" /> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them" /> <isSummary value="false" /> </element> <element id="Endpoint.identifier"> <path value="Endpoint.identifier" /> <short value="Identifies this endpoint across multiple systems" /> <definition value="Identifier for the organization that is used to identify the endpoint across multiple disparate systems." /> <comment value="mustSupport element identified within the IHE mCSD endpoint profile." /> <min value="0" /> <max value="*" /> <base> <path value="Endpoint.identifier" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Identifier" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mustSupport value="true" /> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="w5" /> <map value="FiveWs.identifier" /> </mapping> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Endpoint.status"> <path value="Endpoint.status" /> <short value="represents the current status of this endpoint." /> <definition value="active | suspended | error | off | test." /> <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." /> <min value="1" /> <max value="1" /> <base> <path value="Endpoint.status" /> <min value="1" /> <max value="1" /> </base> <type> <code value="code" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mustSupport value="true" /> <isModifier value="true" /> <isModifierReason value="This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="EndpointStatus" /> </extension> <strength value="required" /> <description value="The status of the endpoint." /> <valueSet value="http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1" /> </binding> <mapping> <identity value="w5" /> <map value="FiveWs.status" /> </mapping> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Endpoint.connectionType"> <path value="Endpoint.connectionType" /> <short value="Protocol/Profile/Standard to be used with this endpoint connection" /> <definition value="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)." /> <comment value="For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example." /> <min value="1" /> <max value="1" /> <base> <path value="Endpoint.connectionType" /> <min value="1" /> <max value="1" /> </base> <type> <code value="Coding" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="endpoint-contype" /> </extension> <strength value="extensible" /> <valueSet value="http://hl7.org/fhir/ValueSet/endpoint-connection-type" /> </binding> <mapping> <identity value="w5" /> <map value="FiveWs.class" /> </mapping> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Endpoint.name"> <path value="Endpoint.name" /> <short value="A name that this endpoint can be identified by" /> <definition value="A friendly name that this endpoint can be referred to with." /> <min value="0" /> <max value="1" /> <base> <path value="Endpoint.name" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="w5" /> <map value="FiveWs.what[x]" /> </mapping> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Endpoint.managingOrganization"> <path value="Endpoint.managingOrganization" /> <short value="Organization that manages this endpoint." /> <definition value="The organization that manages this endpoint, even if technically another organization is hosting this in the cloud." /> <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." /> <min value="1" /> <max value="1" /> <base> <path value="Endpoint.managingOrganization" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mustSupport value="true" /> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Endpoint.contact"> <path value="Endpoint.contact" /> <short value="Contact details for source (e.g. troubleshooting)" /> <definition value="Contact details for a human to contact about the endpoint. The primary use of this for system administrator troubleshooting." /> <min value="0" /> <max value="*" /> <base> <path value="Endpoint.contact" /> <min value="0" /> <max value="*" /> </base> <type> <code value="ContactPoint" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Endpoint.period"> <path value="Endpoint.period" /> <short value="Overall deployment lifetime for this endpoint." /> <definition value="The interval during which the endpoint is expected to be operational." /> <comment value="This element represents the overall lifetime of this endpoint. mustSupport element identified within the IHE mCSD endpoint profile." /> <min value="0" /> <max value="1" /> <base> <path value="Endpoint.period" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Period" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <mustSupport value="true" /> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="w5" /> <map value="FiveWs.done[x]" /> </mapping> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Endpoint.payloadType"> <path value="Endpoint.payloadType" /> <short value="The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)" /> <definition value="The payload type describes the acceptable content that can be communicated on the endpoint." /> <comment value="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." /> <min value="1" /> <max value="*" /> <base> <path value="Endpoint.payloadType" /> <min value="1" /> <max value="*" /> </base> <type> <code value="CodeableConcept" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="PayloadType" /> </extension> <strength value="example" /> <valueSet value="http://hl7.org/fhir/ValueSet/endpoint-payload-type" /> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Endpoint.payloadMimeType"> <path value="Endpoint.payloadMimeType" /> <short value="Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)" /> <definition value="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)." /> <comment value="Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured." /> <min value="0" /> <max value="*" /> <base> <path value="Endpoint.payloadMimeType" /> <min value="0" /> <max value="*" /> </base> <type> <code value="code" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="MimeType" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true" /> </extension> <strength value="required" /> <description value="The mime type of an attachment. Any valid mime type is allowed." /> <valueSet value="http://hl7.org/fhir/ValueSet/mimetypes|4.0.1" /> </binding> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Endpoint.address"> <path value="Endpoint.address" /> <short value="The technical base address for connecting to this endpoint" /> <definition value="The uri that describes the actual end-point to connect to." /> <comment value="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)\n\nThis address will be to the service base, without any parameters, or sub-services or resources tacked on.\n\nE.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs"\n\nand 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/..."." /> <min value="1" /> <max value="1" /> <base> <path value="Endpoint.address" /> <min value="1" /> <max value="1" /> </base> <type> <code value="url" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Endpoint.header"> <path value="Endpoint.header" /> <short value="Usage depends on the channel type" /> <definition value="Additional headers / information to send as part of the notification." /> <comment value="Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements." /> <min value="0" /> <max value="*" /> <base> <path value="Endpoint.header" /> <min value="0" /> <max value="*" /> </base> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> </element> </snapshot> <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", "snapshot": { "element": [ { "id": "Endpoint", "path": "Endpoint", "short": "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.", "min": 0, "max": "*", "base": { "path": "Endpoint", "min": 0, "max": "*" }, "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-3", "severity": "error", "human": "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", "expression": "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()", "xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-5", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "expression": "contained.meta.security.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:security))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." } ], "key": "dom-6", "severity": "warning", "human": "A resource should have narrative for robust management", "expression": "text.`div`.exists()", "xpath": "exists(f:text/h:div)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "n/a" } ] }, { "id": "Endpoint.id", "path": "Endpoint.id", "short": "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.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": true }, { "id": "Endpoint.meta", "path": "Endpoint.meta", "short": "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.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Endpoint.implicitRules", "path": "Endpoint.implicitRules", "short": "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.", "comment": "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.", "min": 0, "max": "0", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", "isSummary": true }, { "id": "Endpoint.language", "path": "Endpoint.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "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).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "preferred", "description": "A human language.", "valueSet": "http://hl7.org/fhir/ValueSet/languages" } }, { "id": "Endpoint.text", "path": "Endpoint.text", "short": "Text summary of the resource, for human interpretation", "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.", "comment": "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.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "id": "Endpoint.contained", "path": "Endpoint.contained", "short": "Contained, inline 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.", "comment": "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.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Endpoint.extension", "path": "Endpoint.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "ordered": false, "rules": "open" }, "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false }, { "id": "Endpoint.extension:purposeOfUse", "path": "Endpoint.extension", "sliceName": "purposeOfUse", "short": "Purpose of Use Extension", "definition": "Set a purpose of use for an mCSD Endpoint or mCSD Organization.", "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false }, { "id": "Endpoint.modifierExtension", "path": "Endpoint.modifierExtension", "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary": false }, { "id": "Endpoint.identifier", "path": "Endpoint.identifier", "short": "Identifies this endpoint across multiple systems", "definition": "Identifier for the organization that is used to identify the endpoint across multiple disparate systems.", "comment": "mustSupport element identified within the IHE mCSD endpoint profile.", "min": 0, "max": "*", "base": { "path": "Endpoint.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "rim", "map": "n/a" } ] }, { "id": "Endpoint.status", "path": "Endpoint.status", "short": "represents the current status of this endpoint.", "definition": "active | suspended | error | off | test.", "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.", "min": 1, "max": "1", "base": { "path": "Endpoint.status", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": true, "isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "EndpointStatus" } ], "strength": "required", "description": "The status of the endpoint.", "valueSet": "http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1" }, "mapping": [ { "identity": "w5", "map": "FiveWs.status" }, { "identity": "rim", "map": "n/a" } ] }, { "id": "Endpoint.connectionType", "path": "Endpoint.connectionType", "short": "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).", "comment": "For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example.", "min": 1, "max": "1", "base": { "path": "Endpoint.connectionType", "min": 1, "max": "1" }, "type": [ { "code": "Coding" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "endpoint-contype" } ], "strength": "extensible", "valueSet": "http://hl7.org/fhir/ValueSet/endpoint-connection-type" }, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": "n/a" } ] }, { "id": "Endpoint.name", "path": "Endpoint.name", "short": "A name that this endpoint can be identified by", "definition": "A friendly name that this endpoint can be referred to with.", "min": 0, "max": "1", "base": { "path": "Endpoint.name", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "rim", "map": "n/a" } ] }, { "id": "Endpoint.managingOrganization", "path": "Endpoint.managingOrganization", "short": "Organization that manages this endpoint.", "definition": "The organization that manages this endpoint, even if technically another organization is hosting this in the cloud.", "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.", "min": 1, "max": "1", "base": { "path": "Endpoint.managingOrganization", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Endpoint.contact", "path": "Endpoint.contact", "short": "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.", "min": 0, "max": "*", "base": { "path": "Endpoint.contact", "min": 0, "max": "*" }, "type": [ { "code": "ContactPoint" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Endpoint.period", "path": "Endpoint.period", "short": "Overall deployment lifetime for this endpoint.", "definition": "The interval during which the endpoint is expected to be operational.", "comment": "This element represents the overall lifetime of this endpoint. mustSupport element identified within the IHE mCSD endpoint profile.", "min": 0, "max": "1", "base": { "path": "Endpoint.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.done[x]" }, { "identity": "rim", "map": "n/a" } ] }, { "id": "Endpoint.payloadType", "path": "Endpoint.payloadType", "short": "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.", "comment": "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.", "min": 1, "max": "*", "base": { "path": "Endpoint.payloadType", "min": 1, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PayloadType" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/endpoint-payload-type" }, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Endpoint.payloadMimeType", "path": "Endpoint.payloadMimeType", "short": "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).", "comment": "Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.", "min": 0, "max": "*", "base": { "path": "Endpoint.payloadMimeType", "min": 0, "max": "*" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MimeType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "The mime type of an attachment. Any valid mime type is allowed.", "valueSet": "http://hl7.org/fhir/ValueSet/mimetypes|4.0.1" }, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Endpoint.address", "path": "Endpoint.address", "short": "The technical base address for connecting to this endpoint", "definition": "The uri that describes the actual end-point to connect to.", "comment": "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)\n\nThis address will be to the service base, without any parameters, or sub-services or resources tacked on.\n\nE.g. for a WADO-RS endpoint, the url should be \"https://pacs.hospital.org/wado-rs\"\n\nand 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/...\".", "min": 1, "max": "1", "base": { "path": "Endpoint.address", "min": 1, "max": "1" }, "type": [ { "code": "url" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Endpoint.header", "path": "Endpoint.header", "short": "Usage depends on the channel type", "definition": "Additional headers / information to send as part of the notification.", "comment": "Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.", "min": 0, "max": "*", "base": { "path": "Endpoint.header", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false } ] }, "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 |