{
"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.",
"_filename": "profiles/Endpoint.StructureDefinition.json",
"package_name": "ca.infoway.io.ca-csd",
"date": null,
"derivation": "constraint",
"publisher": null,
"fhirVersion": "4.0.1",
"name": "Endpoint",
"abstract": false,
"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).",
"type": "Endpoint",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "1.0.0-dft-ballot",
"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"
} ]
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"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",
"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",
"severity": "error",
"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()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"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",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"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."
} ],
"expression": "text.`div`.exists()"
} ],
"path": "Endpoint",
"min": 0,
"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.",
"isModifier": false,
"short": "The technical details of an endpoint that can be used for electronic services",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "n/a",
"identity": "rim"
} ],
"max": "*",
"id": "Endpoint",
"base": {
"max": "*",
"min": 0,
"path": "Endpoint"
},
"isSummary": false
}, {
"path": "Endpoint.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"max": "1",
"id": "Endpoint.id",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Endpoint.meta",
"min": 0,
"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.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Endpoint.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Endpoint.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "0",
"id": "Endpoint.implicitRules",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Endpoint.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"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
} ],
"description": "A human language."
},
"max": "1",
"id": "Endpoint.language",
"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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Endpoint.text",
"min": 0,
"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.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Endpoint.text",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "Endpoint.contained",
"min": 0,
"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.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Endpoint.contained",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Endpoint.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Endpoint.extension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Endpoint.extension",
"min": 0,
"definition": "Set a purpose of use for an mCSD Endpoint or mCSD Organization.",
"isModifier": false,
"short": "Purpose of Use Extension",
"type": [ {
"code": "Extension",
"profile": [ "https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse" ]
} ],
"sliceName": "purposeOfUse",
"max": "*",
"id": "Endpoint.extension:purposeOfUse",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Endpoint.modifierExtension",
"min": 0,
"definition": "An Extension",
"isModifier": true,
"short": "Extension",
"type": [ {
"code": "Extension"
} ],
"max": "0",
"id": "Endpoint.modifierExtension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Endpoint.identifier",
"min": 0,
"definition": "Identifier for the organization that is used to identify the endpoint across multiple disparate systems.",
"isModifier": false,
"short": "Identifies this endpoint across multiple systems",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "*",
"id": "Endpoint.identifier",
"comment": "mustSupport element identified within the IHE mCSD endpoint profile.",
"base": {
"max": "*",
"min": 0,
"path": "Endpoint.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Endpoint.status",
"min": 1,
"definition": "active | suspended | error | off | test.",
"isModifier": true,
"short": "represents the current status of this endpoint.",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EndpointStatus"
} ],
"description": "The status of the endpoint."
},
"max": "1",
"id": "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.",
"base": {
"max": "1",
"min": 1,
"path": "Endpoint.status"
},
"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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Endpoint.connectionType",
"min": 1,
"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).",
"isModifier": false,
"short": "Protocol/Profile/Standard to be used with this endpoint connection",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/endpoint-connection-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "endpoint-contype"
} ]
},
"max": "1",
"id": "Endpoint.connectionType",
"comment": "For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example.",
"base": {
"max": "1",
"min": 1,
"path": "Endpoint.connectionType"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Endpoint.name",
"min": 0,
"definition": "A friendly name that this endpoint can be referred to with.",
"isModifier": false,
"short": "A name that this endpoint can be identified by",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Endpoint.name",
"base": {
"max": "1",
"min": 0,
"path": "Endpoint.name"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Endpoint.managingOrganization",
"min": 1,
"definition": "The organization that manages this endpoint, even if technically another organization is hosting this in the cloud.",
"isModifier": false,
"short": "Organization that manages this endpoint.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization" ]
} ],
"mustSupport": true,
"max": "1",
"id": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Endpoint.managingOrganization"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Endpoint.contact",
"min": 0,
"definition": "Contact details for a human to contact about the endpoint. The primary use of this for system administrator troubleshooting.",
"isModifier": false,
"short": "Contact details for source (e.g. troubleshooting)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"max": "*",
"id": "Endpoint.contact",
"base": {
"max": "*",
"min": 0,
"path": "Endpoint.contact"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Endpoint.period",
"min": 0,
"definition": "The interval during which the endpoint is expected to be operational.",
"isModifier": false,
"short": "Overall deployment lifetime for this endpoint.",
"mapping": [ {
"map": "FiveWs.done[x]",
"identity": "w5"
}, {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Period"
} ],
"mustSupport": true,
"max": "1",
"id": "Endpoint.period",
"comment": "This element represents the overall lifetime of this endpoint. mustSupport element identified within the IHE mCSD endpoint profile.",
"base": {
"max": "1",
"min": 0,
"path": "Endpoint.period"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Endpoint.payloadType",
"min": 1,
"definition": "The payload type describes the acceptable content that can be communicated on the endpoint.",
"isModifier": false,
"short": "The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/endpoint-payload-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PayloadType"
} ]
},
"max": "*",
"id": "Endpoint.payloadType",
"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.",
"base": {
"max": "*",
"min": 1,
"path": "Endpoint.payloadType"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Endpoint.payloadMimeType",
"min": 0,
"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).",
"isModifier": false,
"short": "Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The mime type of an attachment. Any valid mime type is allowed."
},
"max": "*",
"id": "Endpoint.payloadMimeType",
"comment": "Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.",
"base": {
"max": "*",
"min": 0,
"path": "Endpoint.payloadMimeType"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Endpoint.address",
"min": 1,
"definition": "The uri that describes the actual end-point to connect to.",
"isModifier": false,
"short": "The technical base address for connecting to this endpoint",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "url"
} ],
"max": "1",
"id": "Endpoint.address",
"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/...\".",
"base": {
"max": "1",
"min": 1,
"path": "Endpoint.address"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Endpoint.header",
"min": 0,
"definition": "Additional headers / information to send as part of the notification.",
"isModifier": false,
"short": "Usage depends on the channel type",
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "Endpoint.header",
"comment": "Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.",
"base": {
"max": "*",
"min": 0,
"path": "Endpoint.header"
},
"isSummary": false
} ]
},
"status": "draft",
"id": "8e809f07-4bcc-41d7-b8bb-5c893143eb5e",
"kind": "resource",
"url": "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Endpoint",
"version": null,
"differential": {
"element": [ {
"id": "Endpoint.extension:purposeOfUse",
"path": "Endpoint.extension",
"type": [ {
"code": "Extension",
"profile": [ "https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.PurposeOfUse" ]
} ],
"sliceName": "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",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.infoway-inforoute.ca/io/CA-CSD/StructureDefinition/CA-CSD-Organization" ]
} ],
"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.",
"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."
} ]
},
"baseDefinition": "https://profiles.ihe.net/ITI/mCSD/StructureDefinition/IHE.mCSD.Endpoint"
}