3.0.0-alpha - ci-build
3.0.0-alpha - ci-build
Publication Build: This will be filled in by the publication tooling
| Official URL: http://hl7.no/fhir/StructureDefinition/no-basis-Endpoint | Version: 3.0.0-alpha | |||
| 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:
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..* | CodeableConcept | 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) | |
 payload | ||||
  Slices for type | 0..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Slice: Unordered, Open by value:coding.system | |
  type: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) | |
 type:formatCode | 0..* | CodeableConcept | Specific information about payload type and version Binding: urn:oid:2.16.578.1.12.4.1.1.0000 (required) | |
 mimeType | 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 | ||||
| Path | Conformance | ValueSet |
| Endpoint.connectionType | extensible | NoBasisConnectionType |
| Endpoint.payload.type:meldingensFunksjon | required | |
| Endpoint.payload.type:formatCode | required | |
| Endpoint.payload.mimeType | required | http://www.rfc-editor.org/bcp/bcp13.txt |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
 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..* | CodeableConcept | 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) |
| 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 | ||||
| Path | Conformance | ValueSet |
| Endpoint.status | required | EndpointStatus |
| Endpoint.connectionType | extensible | NoBasisConnectionType |
| Id | Grade | Path(s) | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| 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 | id | 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: AllLanguages (required): IETF language tag for 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..* | CodeableConcept | 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 |
| description | Σ | 0..1 | string | Additional details about the endpoint that could be displayed as further information to identify the description beyond its name |
| environmentType | Σ | 0..* | CodeableConcept | The type of environment(s) exposed at this endpoint Binding: EndpointEnvironment (extensible) |
| 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 |
| payload | 0..* | BackboneElement | Set of payloads that are provided by this endpoint | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Slices for type | Σ | 0..* | 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) |
| type: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) |
| type:formatCode | Σ | 0..* | CodeableConcept | Specific information about payload type and version Binding: urn:oid:2.16.578.1.12.4.1.1.0000 (required) |
| mimeType | Σ | 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 | ||||
| Path | Conformance | ValueSet |
| Endpoint.language | required | AllLanguages |
| Endpoint.status | required | EndpointStatus |
| Endpoint.connectionType | extensible | NoBasisConnectionType |
| Endpoint.environmentType | extensible | EndpointEnvironment |
| Endpoint.payload.type | example | EndpointPayloadType |
| Endpoint.payload.type:meldingensFunksjon | required | |
| Endpoint.payload.type:formatCode | required | |
| Endpoint.payload.mimeType | required | http://www.rfc-editor.org/bcp/bcp13.txt |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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..* | CodeableConcept | 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) | |
| payload | ||||
| Slices for type | 0..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Slice: Unordered, Open by value:coding.system | |
| type: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) | |
| type:formatCode | 0..* | CodeableConcept | Specific information about payload type and version Binding: urn:oid:2.16.578.1.12.4.1.1.0000 (required) | |
| mimeType | 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 | ||||
| Path | Conformance | ValueSet |
| Endpoint.connectionType | extensible | NoBasisConnectionType |
| Endpoint.payload.type:meldingensFunksjon | required | |
| Endpoint.payload.type:formatCode | required | |
| Endpoint.payload.mimeType | required | http://www.rfc-editor.org/bcp/bcp13.txt |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | Endpoint | The technical details of an endpoint that can be used for electronic services | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| 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..* | CodeableConcept | 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) |
| 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 | ||||
| Path | Conformance | ValueSet |
| Endpoint.status | required | EndpointStatus |
| Endpoint.connectionType | extensible | NoBasisConnectionType |
| Id | Grade | Path(s) | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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 | id | 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: AllLanguages (required): IETF language tag for 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..* | CodeableConcept | 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 |
| description | Σ | 0..1 | string | Additional details about the endpoint that could be displayed as further information to identify the description beyond its name |
| environmentType | Σ | 0..* | CodeableConcept | The type of environment(s) exposed at this endpoint Binding: EndpointEnvironment (extensible) |
| 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 |
| payload | 0..* | BackboneElement | Set of payloads that are provided by this endpoint | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Slices for type | Σ | 0..* | 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) |
| type: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) |
| type:formatCode | Σ | 0..* | CodeableConcept | Specific information about payload type and version Binding: urn:oid:2.16.578.1.12.4.1.1.0000 (required) |
| mimeType | Σ | 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 | ||||
| Path | Conformance | ValueSet |
| Endpoint.language | required | AllLanguages |
| Endpoint.status | required | EndpointStatus |
| Endpoint.connectionType | extensible | NoBasisConnectionType |
| Endpoint.environmentType | extensible | EndpointEnvironment |
| Endpoint.payload.type | example | EndpointPayloadType |
| Endpoint.payload.type:meldingensFunksjon | required | |
| Endpoint.payload.type:formatCode | required | |
| Endpoint.payload.mimeType | required | http://www.rfc-editor.org/bcp/bcp13.txt |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Other representations of profile: CSV, Excel, Schematron