3.0.0-alpha - ci-build
Publication Build: This will be filled in by the publication tooling
Active as of 2019-05-15 |
Definitions for the no-basis-Endpoint resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. Endpoint | |
Definition | The no-basis profile of the Endpoint resource makes it possible to use the resource for the norwegian service based adressing (tjenestebasert adressering) and other adressing schemes. 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. The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b, a REST endpoint for another FHIR server, or a s/Mime email address. This may include any security context information. |
2. Endpoint.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Comments | no-basis: Adresseregisteret do not provide a identifier for the Endpoints, so any identifier scheme is apropriate. |
3. Endpoint.connectionType | |
Definition | no-basis: the connection type should be coded according to http://hl7.org/fhir/ValueSet/endpoint-connection-type. However specific connection types used in Norway can be coded according to http://hl7.no/fhir/ValueSet/no-basis-endpoint-connection-type (amqp, ebxml etc.) 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). 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). |
Binding | The codes SHALL be taken from no-basis-connection-type.valueset; other codes may be used where these codes are not suitableFor example codes, see EndpointConnectionType |
4. Endpoint.managingOrganization | |
Definition | The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data). no-basis: In Norway this relates to the organization with the responsibility for the data e.g. "dataansvarlig". no-basis recommends the use of logical reference to an organization using ENH or RSH. To describe a top level organization. Departments within an organization could use a different reference scheme defined by the organization. The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data). |
Type | Reference(Organization|NoBasisOrganization) |
Alternate Names | dataansvarlig |
5. Endpoint.payload | |
Control | 0..? |
6. Endpoint.payload.type | |
Definition | no-basis: for ebXML and AMQP messages in Norway one is expected to list all mesage types that the endpoint supports using the CodeSystem Meldingens funksjon (OID=8279) as a minimum. To describe complete version information to determine the type and version of the messages the endpoint supports, a CapabilityStatement can be used to describe the endpoints communication capabilities in detail. REST endpoints are expected to use the code "any" from https://www.hl7.org/fhir/codesystem-endpoint-payload-type.html. Proper FHIR Restful API's are expected to serve a CapabilityStatement from the base uri specified. Other payload types can be given using codes from the ValueSet http://hl7.org/fhir/ValueSet/endpoint-payload-type. The payload type describes the acceptable content that can be communicated on the endpoint. The payload type describes the acceptable content that can be communicated on the endpoint. |
Slicing | This element introduces a set of slices on Endpoint.payload.type. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
7. Endpoint.payload.type:meldingensFunksjon | |
SliceName | meldingensFunksjon |
Definition | no-basis: for ebXML and AMQP messages in Norway one is expected to list all mesage types that the endpoint supports using the CodeSystem Meldingens funksjon (OID=8279). Version information (version of the payload document) shold be given in the coding.version element. The payload type describes the acceptable content that can be communicated on the endpoint. |
Control | 0..* |
Binding | The codes SHALL be taken from urn:oid:2.16.578.1.12.4.1.1.8279 |
8. Endpoint.payload.type:formatCode | |
SliceName | formatCode |
Definition | no-basis: Specific information about payload type and version. Information about the payload type and version for ebxml and amqp messages The payload type describes the acceptable content that can be communicated on the endpoint. |
Control | 0..* |
Binding | The codes SHALL be taken from urn:oid:2.16.578.1.12.4.1.1.0000 |
9. Endpoint.payload.mimeType | |
Definition | no-basis: should we list relevant codes for ebXML messages? List appropriate media types for FHIR REST endpoints? XML: application/fhir+xml JSON: application/fhir+json RDF: application/fhir+turtle ebXML messages: text/xml 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). 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). |
Binding | The codes SHALL be taken from http://www.rfc-editor.org/bcp/bcp13.txtThe codes SHALL be taken from MimeTypes |
10. Endpoint.address | |
Definition | The uri that describes the actual end-point to connect to. no-basis: for ebXML messages in Norway one is expected to use mailto: prefix for the endpoint. For AMQP messages in Norway one is expected to use "ampq://" or "amqps://" prefix. REST endpoints will have "http://" or "https://" prefix. |
Example | amqp endpoint:amqp_endpoint ebxml endpoint:ebxml_endpoint REST endpoint:REST_endpoint |
Guidance on how to interpret the contents of this table can be found here.
1. Endpoint | |
Definition | The no-basis profile of the Endpoint resource makes it possible to use the resource for the norwegian service based adressing (tjenestebasert adressering) and other adressing schemes. 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. The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b, a REST endpoint for another FHIR server, or a s/Mime email address. This may include any security context information. |
Control | 0..* |
Summary | false |
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) |
2. Endpoint.implicitRules | |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Summary | true |
Comments | 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 its narrative along with other profiles, value sets, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
3. Endpoint.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
Type | Resource |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | 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. |
4. Endpoint.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
5. Endpoint.identifier | |
Definition | Identifier for the organization that is used to identify the endpoint across multiple disparate systems. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Summary | true |
Comments | no-basis: Adresseregisteret do not provide a identifier for the Endpoints, so any identifier scheme is apropriate. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
6. Endpoint.status | |
Definition | The endpoint status represents the general expected availability of an endpoint. |
Control | 1..1 |
Binding | The codes SHALL be taken from EndpointStatus The status of the endpoint. |
Type | code |
Is Modifier | true |
Summary | true |
Comments | This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid. Temporary downtimes or other unexpected short-term changes in availability would not be represented in this property. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
7. Endpoint.connectionType | |
Definition | no-basis: the connection type should be coded according to http://hl7.org/fhir/ValueSet/endpoint-connection-type. However specific connection types used in Norway can be coded according to http://hl7.no/fhir/ValueSet/no-basis-endpoint-connection-type (amqp, ebxml etc.) 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). 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). |
Control | 1..* |
Binding | The codes SHALL be taken from no-basis-connection-type.valueset; other codes may be used where these codes are not suitableFor example codes, see EndpointConnectionType |
Type | CodeableConcept |
Summary | true |
Comments | For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example. If there are multiple payload types or mimetypes they are all applicable for all connection types, and all have the same status. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
8. Endpoint.managingOrganization | |
Definition | The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data). no-basis: In Norway this relates to the organization with the responsibility for the data e.g. "dataansvarlig". no-basis recommends the use of logical reference to an organization using ENH or RSH. To describe a top level organization. Departments within an organization could use a different reference scheme defined by the organization. The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data). |
Control | 0..1 |
Type | Reference(Organization|NoBasisOrganization) |
Summary | true |
Alternate Names | dataansvarlig |
Comments | This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an applicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
9. Endpoint.address | |
Definition | The uri that describes the actual end-point to connect to. no-basis: for ebXML messages in Norway one is expected to use mailto: prefix for the endpoint. For AMQP messages in Norway one is expected to use "ampq://" or "amqps://" prefix. REST endpoints will have "http://" or "https://" prefix. |
Control | 1..1 |
Type | url |
Summary | true |
Comments | 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) This address will be to the service base, without any parameters, or sub-services or resources tacked on. E.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs" and 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/...". |
Example | amqp endpoint:amqp_endpoint ebxml endpoint:ebxml_endpoint REST endpoint:REST_endpoint |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here.
1. Endpoint | |
Definition | The no-basis profile of the Endpoint resource makes it possible to use the resource for the norwegian service based adressing (tjenestebasert adressering) and other adressing schemes. 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. |
Control | 0..* |
Summary | false |
2. Endpoint.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Summary | true |
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
3. Endpoint.meta | |
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. |
Control | 0..1 |
Type | Meta |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
4. Endpoint.implicitRules | |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Summary | true |
Comments | 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 its narrative along with other profiles, value sets, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
5. Endpoint.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | The codes SHALL be taken from AllLanguages IETF language tag for a human languag |
Type | code |
Summary | false |
Comments | 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). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
6. Endpoint.text | |
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. |
Control | 0..1 This element is affected by the following invariants: dom-6 |
Type | Narrative |
Summary | false |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have a 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. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
7. Endpoint.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
Type | Resource |
Summary | false |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | 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. |
8. Endpoint.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
9. Endpoint.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
10. Endpoint.identifier | |
Definition | Identifier for the organization that is used to identify the endpoint across multiple disparate systems. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Summary | true |
Comments | no-basis: Adresseregisteret do not provide a identifier for the Endpoints, so any identifier scheme is apropriate. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
11. Endpoint.status | |
Definition | The endpoint status represents the general expected availability of an endpoint. |
Control | 1..1 |
Binding | The codes SHALL be taken from EndpointStatus The status of the endpoint |
Type | code |
Is Modifier | true |
Summary | true |
Comments | This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid. Temporary downtimes or other unexpected short-term changes in availability would not be represented in this property. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
12. Endpoint.connectionType | |
Definition | no-basis: the connection type should be coded according to http://hl7.org/fhir/ValueSet/endpoint-connection-type. However specific connection types used in Norway can be coded according to http://hl7.no/fhir/ValueSet/no-basis-endpoint-connection-type (amqp, ebxml etc.) 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). |
Control | 1..* |
Binding | The codes SHALL be taken from no-basis-connection-type.valueset; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Summary | true |
Comments | For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example. If there are multiple payload types or mimetypes they are all applicable for all connection types, and all have the same status. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
13. Endpoint.name | |
Definition | A friendly name that this endpoint can be referred to with. |
Control | 0..1 |
Type | string |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
14. Endpoint.description | |
Definition | The description of the endpoint and what it is for (typically used as supplemental information in an endpoint directory describing its usage/purpose). |
Control | 0..1 |
Type | string |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
15. Endpoint.environmentType | |
Definition | The type of environment(s) exposed at this endpoint (dev, prod, test, etc.). |
Control | 0..* |
Binding | The codes SHALL be taken from EndpointEnvironment; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
16. Endpoint.managingOrganization | |
Definition | The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data). no-basis: In Norway this relates to the organization with the responsibility for the data e.g. "dataansvarlig". no-basis recommends the use of logical reference to an organization using ENH or RSH. To describe a top level organization. Departments within an organization could use a different reference scheme defined by the organization. |
Control | 0..1 |
Type | Reference(Organization|NoBasisOrganization) |
Summary | true |
Alternate Names | dataansvarlig |
Comments | This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an applicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
17. Endpoint.contact | |
Definition | Contact details for a human to contact about the endpoint. The primary use of this for system administrator troubleshooting. |
Control | 0..* |
Type | ContactPoint |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
18. Endpoint.period | |
Definition | The interval during which the endpoint is expected to be operational. |
Control | 0..1 |
Type | Period |
Summary | true |
Comments | Temporary downtimes or other short-term changes in availability would not be represented in this property. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
19. Endpoint.payload | |
Definition | The set of payloads that are provided/available at this endpoint. |
Control | 0..* |
Type | BackboneElement |
Summary | false |
Comments | Note that not all mimetypes or types will be listed under the one endpoint resource, there may be multiple instances that information for cases where other header data such as the endpoint address, active status/period etc. is different. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
20. Endpoint.payload.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Summary | false |
21. Endpoint.payload.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Summary | false |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
22. Endpoint.payload.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
23. Endpoint.payload.type | |
Definition | no-basis: for ebXML and AMQP messages in Norway one is expected to list all mesage types that the endpoint supports using the CodeSystem Meldingens funksjon (OID=8279) as a minimum. To describe complete version information to determine the type and version of the messages the endpoint supports, a CapabilityStatement can be used to describe the endpoints communication capabilities in detail. REST endpoints are expected to use the code "any" from https://www.hl7.org/fhir/codesystem-endpoint-payload-type.html. Proper FHIR Restful API's are expected to serve a CapabilityStatement from the base uri specified. Other payload types can be given using codes from the ValueSet http://hl7.org/fhir/ValueSet/endpoint-payload-type. The payload type describes the acceptable content that can be communicated on the endpoint. |
Control | 0..* |
Binding | For example codes, see EndpointPayloadType |
Type | CodeableConcept |
Summary | true |
Comments | The mimeType describes the serialization format of the data, where the payload.type indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Endpoint.payload.type. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
24. Endpoint.payload.type:meldingensFunksjon | |
SliceName | meldingensFunksjon |
Definition | no-basis: for ebXML and AMQP messages in Norway one is expected to list all mesage types that the endpoint supports using the CodeSystem Meldingens funksjon (OID=8279). Version information (version of the payload document) shold be given in the coding.version element. The payload type describes the acceptable content that can be communicated on the endpoint. |
Control | 0..* |
Binding | The codes SHALL be taken from urn:oid:2.16.578.1.12.4.1.1.8279 |
Type | CodeableConcept |
Summary | true |
Comments | The mimeType describes the serialization format of the data, where the payload.type indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
25. Endpoint.payload.type:formatCode | |
SliceName | formatCode |
Definition | no-basis: Specific information about payload type and version. Information about the payload type and version for ebxml and amqp messages The payload type describes the acceptable content that can be communicated on the endpoint. |
Control | 0..* |
Binding | The codes SHALL be taken from urn:oid:2.16.578.1.12.4.1.1.0000 |
Type | CodeableConcept |
Summary | true |
Comments | The mimeType describes the serialization format of the data, where the payload.type indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
26. Endpoint.payload.mimeType | |
Definition | no-basis: should we list relevant codes for ebXML messages? List appropriate media types for FHIR REST endpoints? XML: application/fhir+xml JSON: application/fhir+json RDF: application/fhir+turtle ebXML messages: text/xml 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). |
Control | 0..* |
Binding | The codes SHALL be taken from http://www.rfc-editor.org/bcp/bcp13.txt |
Type | code |
Summary | true |
Comments | Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
27. Endpoint.address | |
Definition | The uri that describes the actual end-point to connect to. no-basis: for ebXML messages in Norway one is expected to use mailto: prefix for the endpoint. For AMQP messages in Norway one is expected to use "ampq://" or "amqps://" prefix. REST endpoints will have "http://" or "https://" prefix. |
Control | 1..1 |
Type | url |
Summary | true |
Comments | 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) This address will be to the service base, without any parameters, or sub-services or resources tacked on. E.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs" and 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/...". |
Example | amqp endpoint:amqp_endpoint ebxml endpoint:ebxml_endpoint REST endpoint:REST_endpoint |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
28. Endpoint.header | |
Definition | Additional headers / information to send as part of the notification. |
Control | 0..* |
Type | string |
Summary | false |
Comments | Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |