EgdeSTS_IG - Local Development build (v0.1.0). See the Directory of published versions
Resource Profile: no-basis-Endpoint
| Official URL: http://www.egde.no/StructureDefinition/no-basis-Endpoint | Version: 0.1.0 | |||
| Active as of 2019-05-15 | Computable Name: NoBasisEndpoint | |||
Basisprofil for Norwegian Endpoint information. Defined by The Norwegian Directorate of eHealth and HL7 Norway. The profile adds Norwegian specific identification of Endpoing. The basis profile is open, but derived profiles should close down the information elements according to specification relevant to the use-case.
Resource profile for definition of electronic endpoints used by healthcare organizations to communicate using different protocols. The norwegian profile use-case is to represent endpoints for electronic communication. Fallback solutions using mail or fax has to be indexed in the norwegian master index for healthcare organizations and are not described using this profile.
Usage:
- Refer to this Resource Profile:
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Endpoint
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Endpoint | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
  identifier | 0..* | Identifier | Identifies this endpoint across multiple systems | |
| connectionType | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: no-basis-connection-type.valueset (extensible) | |
 managingOrganization | 0..1 | Reference(Organization | no-basis-Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
  Slices for payloadType | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Slice: Unordered, Open by value:coding.system | |
   payloadType:meldingensFunksjon | 0..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: urn:oid:2.16.578.1.12.4.1.1.8279 (required) | |
 payloadType:formatCode | 0..* | CodeableConcept | Specific information about payload type and version Binding: urn:oid:2.16.578.1.12.4.1.1.0000 (required) | |
| payloadMimeType | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: http://www.rfc-editor.org/bcp/bcp13.txt (required) | |
 address | 1..1 | url | The technical base address for connecting to this endpoint Example amqp endpoint: amqp_endpoint Example ebxml endpoint: ebxml_endpoint Example REST endpoint: REST_endpoint | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Identifies this endpoint across multiple systems |
| status | ?!Σ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. |
| connectionType | Σ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: no-basis-connection-type.valueset (extensible) |
| name | Σ | 0..1 | string | A name that this endpoint can be identified by |
| managingOrganization | Σ | 0..1 | Reference(Organization | no-basis-Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
| contact | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | |
| period | Σ | 0..1 | Period | Interval the endpoint is expected to be operational |
| Slices for payloadType | Σ | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Slice: Unordered, Open by value:coding.system Binding: EndpointPayloadType (example) |
| payloadType:meldingensFunksjon | Σ | 0..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: urn:oid:2.16.578.1.12.4.1.1.8279 (required) |
| payloadType:formatCode | Σ | 0..* | CodeableConcept | Specific information about payload type and version Binding: urn:oid:2.16.578.1.12.4.1.1.0000 (required) |
| payloadMimeType | Σ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: http://www.rfc-editor.org/bcp/bcp13.txt (required) |
| address | Σ | 1..1 | url | The technical base address for connecting to this endpoint Example amqp endpoint: amqp_endpoint Example ebxml endpoint: ebxml_endpoint Example REST endpoint: REST_endpoint |
| header | 0..* | string | Usage depends on the channel type | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
| Documentation for this format | ||||
This structure is derived from Endpoint
Summary
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
- The element Endpoint.payloadType is sliced based on the value of value:coding.system
Differential View
This structure is derived from Endpoint
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
| identifier | 0..* | Identifier | Identifies this endpoint across multiple systems | |
| connectionType | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: no-basis-connection-type.valueset (extensible) | |
| managingOrganization | 0..1 | Reference(Organization | no-basis-Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
| Slices for payloadType | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Slice: Unordered, Open by value:coding.system | |
| payloadType:meldingensFunksjon | 0..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: urn:oid:2.16.578.1.12.4.1.1.8279 (required) | |
| payloadType:formatCode | 0..* | CodeableConcept | Specific information about payload type and version Binding: urn:oid:2.16.578.1.12.4.1.1.0000 (required) | |
| payloadMimeType | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: http://www.rfc-editor.org/bcp/bcp13.txt (required) | |
| address | 1..1 | url | The technical base address for connecting to this endpoint Example amqp endpoint: amqp_endpoint Example ebxml endpoint: ebxml_endpoint Example REST endpoint: REST_endpoint | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Identifies this endpoint across multiple systems |
| status | ?!Σ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. |
| connectionType | Σ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: no-basis-connection-type.valueset (extensible) |
| name | Σ | 0..1 | string | A name that this endpoint can be identified by |
| managingOrganization | Σ | 0..1 | Reference(Organization | no-basis-Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
| contact | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | |
| period | Σ | 0..1 | Period | Interval the endpoint is expected to be operational |
| Slices for payloadType | Σ | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Slice: Unordered, Open by value:coding.system Binding: EndpointPayloadType (example) |
| payloadType:meldingensFunksjon | Σ | 0..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: urn:oid:2.16.578.1.12.4.1.1.8279 (required) |
| payloadType:formatCode | Σ | 0..* | CodeableConcept | Specific information about payload type and version Binding: urn:oid:2.16.578.1.12.4.1.1.0000 (required) |
| payloadMimeType | Σ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: http://www.rfc-editor.org/bcp/bcp13.txt (required) |
| address | Σ | 1..1 | url | The technical base address for connecting to this endpoint Example amqp endpoint: amqp_endpoint Example ebxml endpoint: ebxml_endpoint Example REST endpoint: REST_endpoint |
| header | 0..* | string | Usage depends on the channel type | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet |
| Endpoint.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Endpoint.status | required | EndpointStatus |
| Endpoint.connectionType | extensible | NoBasisConnectionType |
| Endpoint.payloadType | example | EndpointPayloadType |
| Endpoint.payloadType:meldingensFunksjon | required | |
| Endpoint.payloadType:formatCode | required | |
| Endpoint.payloadMimeType | required | http://www.rfc-editor.org/bcp/bcp13.txt |
Constraints
| Id | Grade | Path | Details | Requirements |
| dom-2 | error | Endpoint | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Endpoint | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Endpoint | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Endpoint | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Best Practice | Endpoint | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | Endpoint.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Endpoint.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Endpoint.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Endpoint.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Endpoint.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Endpoint.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Endpoint.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Endpoint.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Endpoint.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Endpoint.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Endpoint.connectionType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Endpoint.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Endpoint.managingOrganization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Endpoint.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Endpoint.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Endpoint.payloadType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Endpoint.payloadType:meldingensFunksjon | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Endpoint.payloadType:formatCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Endpoint.payloadMimeType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Endpoint.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Endpoint.header | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |