Resource Profile: Endpoint

General information

See HL7 Endpoint for more information about the base resource Endpoint.

Scope and Usage

This profile holds information about a technical address to an API. The information can include what protocol it follows, what security method it uses, the URL to the authorization server and what API specifications it adheres to. This is to facilitate the integrating of external systems with the endpoint.

Boundaries and Relationships

The healthcare providers as Organizations that make available patient data at a given Endpoint have references to the Endpoint in the Organization.endpoint element.

To express what API specification the Endpoint implements there is an extension "apiSpecification" on the Endpoint.payload element that references the canonical URL of an API Specification.

The search operation Search Endpoint can be used to query the Endpoints that healthcare providers (Organization) use to make patient data available, given that the supplied patient is registered at the healthcare providers. The result can be filtered by whether the Endpoints have declared to be implementing any given API Specifications in their payloads.

Background and Context

Profile

EndpointEr (Endpoint)	C		Endpoint	There are no (further) constraints on this element Element id Endpoint Short description The technical details of an endpoint that can be used for electronic services Definition The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b, a REST endpoint for another FHIR server, or a s/Mime email address. This may include any security context information. Data type Endpoint Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.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-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-6: A resource should have narrative for robust management text.`div`.exists() dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim: n/a rim: Entity. Role, or Act rim: Entity, Role, or Act w5: infrastructure.exchange
id	Σ	0..1	id	There are no (further) constraints on this element Element id Endpoint.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. 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. Data type id Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Endpoint.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Endpoint.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element id Endpoint.language Short description Language of the resource content Definition The base language in which the resource is written. 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). Data type code Binding IETF language tag for a human language AllLanguages (required) Additional bindings CommonLanguages (starter) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
text	C	0..1	Narrative	There are no (further) constraints on this element Element id Endpoint.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display 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. 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. Data type Narrative Conditions The cardinality or value of this element may be affected by these constraints: dom-6 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A rim: Act.text?
contained	C	0..*	Resource	There are no (further) constraints on this element Element id Endpoint.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources 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. 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. Data type Resource Conditions The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 Mappings rim: n/a rim: Entity. Role, or Act rim: N/A
extension	C	0..*	Extension	There are no (further) constraints on this element Element id Endpoint.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
associatedServer	S C	0..1	Extension(Complex)	Element id Endpoint.extension:associatedServer Short description Endpoint Associated Server (ER) Alternate names extensions, user content Definition Associated server of this endpoint. 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. Data type Extension(Complex) Extension URL EndpointAssociatedServerEr Constraints 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()` Mappings rim: n/a rim: N/A EndpointToAndpunktLogicalEr: urlTillAuktorisationsserver
id		0..1	string	There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	2..*	Extension	There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
associatedServerType	S C	1..1	Extension	There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.extension:associatedServerType Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Constraints 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()` Mappings rim: n/a rim: N/A
id		0..1	string	There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.extension:associatedServerType.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..0	Extension	There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.extension:associatedServerType.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
url	S	1..1	uriFixed Value	There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.extension:associatedServerType.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data type uri Fixed value associatedServerType Mappings rim: N/A
value[x]	S C	1..1	CodingBindingFixed Value	Element id Endpoint.extension:associatedServer.extension:associatedServerType.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Data type Coding Binding er-server-types (required) Conditions The cardinality or value of this element may be affected by these constraints: ext-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value { "system": "http://electronichealth.se/CodeSystem/associated-server-types", "code": "authorization" } Mappings rim: n/a rim: N/A
id		0..1	string	There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.extension:associatedServerType.value[x].id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.extension:associatedServerType.value[x].extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
system	S Σ	1..1	uriFixed Value	There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.extension:associatedServerType.value[x].system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value http://electronichealth.se/CodeSystem/associated-server-types Mappings rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.extension:associatedServerType.value[x].version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	S Σ C	1..1	codeFixed Value	There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.extension:associatedServerType.value[x].code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Comments Note that FHIR strings SHALL NOT exceed 1,048,576 (10241024) characters in size Data type* code Conditions The cardinality or value of this element may be affected by these constraints: cod-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value authorization Mappings rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ C	0..1	string	There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.extension:associatedServerType.value[x].display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Comments Note that FHIR strings SHALL NOT exceed 1,048,576 (10241024) characters in size Data type* string Conditions The cardinality or value of this element may be affected by these constraints: cod-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.extension:associatedServerType.value[x].userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
serverURL	S C	1..1	Extension	There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.extension:serverURL Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Constraints 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()` Mappings rim: n/a rim: N/A
id		0..1	string	There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.extension:serverURL.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..0	Extension	There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.extension:serverURL.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
url	S	1..1	uriFixed Value	There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.extension:serverURL.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data type uri Fixed value serverURL Mappings rim: N/A
value[x]	S C	1..1		Element id Endpoint.extension:associatedServer.extension:serverURL.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Conditions The cardinality or value of this element may be affected by these constraints: ext-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` endpoint-security-url-er-1: The security url of an Endpoint must start with https:// followed by a combination of alphanumerical characters, slashes (/) and/or full stops (.) `$this.matches('^https:\/\/[\/\.A-Öa-ö0-9]+$')` endpoint-security-url-er-2: The security url of an Endpoint must be a maximum of 255 characters `$this.length() <= 255` Mappings rim: n/a rim: N/A
valueUrl			url	There are no (further) constraints on this element Data type url
url		1..1	uriFixed Value	There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data type uri Fixed value http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-associated-server-er Mappings rim: N/A
value[x]	C	0..0		There are no (further) constraints on this element Element id Endpoint.extension:associatedServer.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Conditions The cardinality or value of this element may be affected by these constraints: ext-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! C	0..*	Extension	There are no (further) constraints on this element Element id Endpoint.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content 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). 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. 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. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
identifier	Σ C	0..*	Identifier	There are no (further) constraints on this element Element id Endpoint.identifier Short description Identifies this endpoint across multiple systems Definition Identifier for the organization that is used to identify the endpoint across multiple disparate systems. Comments The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason `value.exists()` Mappings rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier w5: FiveWs.identifier
status	S Σ ?!	1..1	codeBinding	Element id Endpoint.status Short description active \| suspended \| error \| off \| entered-in-error \| test Definition The endpoint status represents the general expected availability of an endpoint. 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. Data type code Binding The status of the endpoint. er-endpoint-statuses (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.status EndpointToAndpunktLogicalEr: status
connectionType	S Σ	1..*	CodeableConcept	Element id Endpoint.connectionType Short description Protocol/Profile/Standard to be used with this endpoint connection Definition A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook). 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. Data type CodeableConcept Slicing Unordered, Open, by $this(Value) Slice on connectionType based on value set binding Binding EndpointConnectionType (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD w5: FiveWs.class
(All Slices)				The requirements in this element apply to all slices
id		0..1	string	There are no (further) constraints on this element Element id Endpoint.connectionType.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id Endpoint.connectionType.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
coding	S Σ C	1..1	Coding	There are no (further) constraints on this element Element id Endpoint.connectionType.coding Short description Code defined by a terminology system Definition A reference to a code defined by a terminology system. Requirements Allows for alternative encodings within a code system, and translations to other code systems. Comments Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Data type Coding Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text `code.exists().not() implies display.exists().not()` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id		0..1	string	There are no (further) constraints on this element Element id Endpoint.connectionType.coding.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id Endpoint.connectionType.coding.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
system	S Σ	1..1	uri	There are no (further) constraints on this element Element id Endpoint.connectionType.coding.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element id Endpoint.connectionType.coding.version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	S Σ C	1..1	code	There are no (further) constraints on this element Element id Endpoint.connectionType.coding.code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Comments Note that FHIR strings SHALL NOT exceed 1,048,576 (10241024) characters in size Data type* code Conditions The cardinality or value of this element may be affected by these constraints: cod-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ C	0..1	string	There are no (further) constraints on this element Element id Endpoint.connectionType.coding.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Comments Note that FHIR strings SHALL NOT exceed 1,048,576 (10241024) characters in size Data type* string Conditions The cardinality or value of this element may be affected by these constraints: cod-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element id Endpoint.connectionType.coding.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
text	Σ	0..1	string	There are no (further) constraints on this element Element id Endpoint.connectionType.text Short description Plain text representation of the concept Definition A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Requirements The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Comments Very often the text is the same as a displayName of one of the codings. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
securityMethod	S Σ	0..1	CodeableConceptBinding	Element id Endpoint.connectionType:securityMethod Short description Protocol/Profile/Standard to be used with this endpoint connection Definition A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook). 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. Data type CodeableConcept Binding RestfulSecurityService (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD w5: FiveWs.class EndpointToAndpunktLogicalEr: sakerhetsmetod
id		0..1	string	There are no (further) constraints on this element Element id Endpoint.connectionType:securityMethod.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id Endpoint.connectionType:securityMethod.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
coding	S Σ C	1..1	Coding	There are no (further) constraints on this element Element id Endpoint.connectionType:securityMethod.coding Short description Code defined by a terminology system Definition A reference to a code defined by a terminology system. Requirements Allows for alternative encodings within a code system, and translations to other code systems. Comments Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Data type Coding Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text `code.exists().not() implies display.exists().not()` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id		0..1	string	There are no (further) constraints on this element Element id Endpoint.connectionType:securityMethod.coding.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id Endpoint.connectionType:securityMethod.coding.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
system	S Σ	1..1	uriFixed Value	Element id Endpoint.connectionType:securityMethod.coding.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value http://hl7.org/fhir/restful-security-service Mappings rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element id Endpoint.connectionType:securityMethod.coding.version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	S Σ C	1..1	code	There are no (further) constraints on this element Element id Endpoint.connectionType:securityMethod.coding.code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Comments Note that FHIR strings SHALL NOT exceed 1,048,576 (10241024) characters in size Data type* code Conditions The cardinality or value of this element may be affected by these constraints: cod-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ C	0..1	string	There are no (further) constraints on this element Element id Endpoint.connectionType:securityMethod.coding.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Comments Note that FHIR strings SHALL NOT exceed 1,048,576 (10241024) characters in size Data type* string Conditions The cardinality or value of this element may be affected by these constraints: cod-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element id Endpoint.connectionType:securityMethod.coding.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
text	Σ	0..1	string	There are no (further) constraints on this element Element id Endpoint.connectionType:securityMethod.text Short description Plain text representation of the concept Definition A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Requirements The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Comments Very often the text is the same as a displayName of one of the codings. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
protocol	S Σ	0..1	CodeableConceptBinding	Element id Endpoint.connectionType:protocol Short description Protocol/Profile/Standard to be used with this endpoint connection Definition A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook). 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. Data type CodeableConcept Binding er-endpoint-connection-types (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD w5: FiveWs.class EndpointToAndpunktLogicalEr: protokoll
id		0..1	string	There are no (further) constraints on this element Element id Endpoint.connectionType:protocol.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id Endpoint.connectionType:protocol.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
coding	S Σ C	1..1	Coding	There are no (further) constraints on this element Element id Endpoint.connectionType:protocol.coding Short description Code defined by a terminology system Definition A reference to a code defined by a terminology system. Requirements Allows for alternative encodings within a code system, and translations to other code systems. Comments Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Data type Coding Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text `code.exists().not() implies display.exists().not()` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id		0..1	string	There are no (further) constraints on this element Element id Endpoint.connectionType:protocol.coding.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id Endpoint.connectionType:protocol.coding.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
system	S Σ	1..1	uri	There are no (further) constraints on this element Element id Endpoint.connectionType:protocol.coding.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element id Endpoint.connectionType:protocol.coding.version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	S Σ C	1..1	code	There are no (further) constraints on this element Element id Endpoint.connectionType:protocol.coding.code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Comments Note that FHIR strings SHALL NOT exceed 1,048,576 (10241024) characters in size Data type* code Conditions The cardinality or value of this element may be affected by these constraints: cod-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ C	0..1	string	There are no (further) constraints on this element Element id Endpoint.connectionType:protocol.coding.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Comments Note that FHIR strings SHALL NOT exceed 1,048,576 (10241024) characters in size Data type* string Conditions The cardinality or value of this element may be affected by these constraints: cod-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element id Endpoint.connectionType:protocol.coding.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
text	Σ	0..1	string	There are no (further) constraints on this element Element id Endpoint.connectionType:protocol.text Short description Plain text representation of the concept Definition A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Requirements The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Comments Very often the text is the same as a displayName of one of the codings. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
name	S Σ C	1..1	string	Element id Endpoint.name Short description A name that this endpoint can be identified by Definition A friendly name that this endpoint can be referred to with. Comments Note that FHIR strings SHALL NOT exceed 1,048,576 (10241024) characters in size Data type* string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` endpoint-name-er-1: The name of an Endpoint must contain alphanumerical characters, spaces and/or one or more of the following special characters: _-.,\'()&/ `$this.matches('^[A-Öa-ö0-9 _-.,\'()&/]+$')` endpoint-name-er-2: The name of an Endpoint must be a maximum of 255 characters `$this.length() <= 255` Mappings rim: n/a w5: FiveWs.what[x] EndpointToAndpunktLogicalEr: namn
description	Σ	0..1	string	There are no (further) constraints on this element Element id Endpoint.description Short description Additional details about the endpoint that could be displayed as further information to identify the description beyond its name Definition The description of the endpoint and what it is for (typically used as supplemental information in an endpoint directory describing its usage/purpose). Comments Note that FHIR strings SHALL NOT exceed 1,048,576 (10241024) characters in size Data type* string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
environmentType	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element id Endpoint.environmentType Short description The type of environment(s) exposed at this endpoint Definition The type of environment(s) exposed at this endpoint (dev, prod, test, etc.). Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data type CodeableConcept Binding EndpointEnvironment (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
managingOrganization	Σ C	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Endpoint.managingOrganization Short description Organization that manages this endpoint (might not be the organization that exposes the endpoint) Definition 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). 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. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))` ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided). `reference.exists() or identifier.exists() or display.exists() or extension.exists()` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
contact	C	0..*	ContactPoint	There are no (further) constraints on this element Element id Endpoint.contact Short description Contact details for source (e.g. troubleshooting) Definition Contact details for a human to contact about the endpoint. The primary use of this for system administrator troubleshooting. Data type ContactPoint Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2: A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim: n/a v2: XTN rim: TEL servd: ContactPoint
period	Σ C	0..1	Period	There are no (further) constraints on this element Element id Endpoint.period Short description Interval the endpoint is expected to be operational Definition The interval during which the endpoint is expected to be operational. Comments Temporary downtimes or other short-term changes in availability would not be represented in this property. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1: If present, start SHALL have a lower or equal value than end `start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())` Mappings rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] w5: FiveWs.done[x]
payload	S	0..*	BackboneElement	Element id Endpoint.payload Short description Set of payloads that are provided by this endpoint Definition The set of payloads that are provided/available at this endpoint. 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. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a EndpointToAndpunktLogicalEr: tillgangliggor(APILogicalEr)
id		0..1	string	There are no (further) constraints on this element Element id Endpoint.payload.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Mappings rim: n/a
extension	C	1..*	Extension	There are no (further) constraints on this element Element id Endpoint.payload.extension Short description Additional content defined by implementations Alternate names extensions, user content 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. 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. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
apiSpecification	S C	1..1	Extension(canonical(APISpecificationEr))	Element id Endpoint.payload.extension:apiSpecification Short description Endpoint Payload Actor Definition (ER) Alternate names extensions, user content Definition ActorDefinition that this payload is implementing. 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. Data type Extension(canonical(APISpecificationEr)) Extension URL EndpointPayloadActorDefinitionEr Constraints 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()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! C	0..*	Extension	There are no (further) constraints on this element Element id Endpoint.payload.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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). 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. 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. Data type Extension Constraints 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()` Mappings rim: n/a rim: N/A
type	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element id Endpoint.payload.type Short description The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Definition The payload type describes the acceptable content that can be communicated on the endpoint. 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. Data type CodeableConcept Binding EndpointPayloadType (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
mimeType	Σ	0..*	codeBinding	There are no (further) constraints on this element Element id Endpoint.payload.mimeType Short description Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Definition The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType). Comments Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured. Data type code Binding BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) MimeTypes (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
address	S Σ	1..1	url	Element id Endpoint.address Short description The technical base address for connecting to this endpoint Definition The uri that describes the actual end-point to connect to. 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/...". Data type url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a EndpointToAndpunktLogicalEr: adress
header		0..*	string	There are no (further) constraints on this element Element id Endpoint.header Short description Usage depends on the channel type Definition Additional headers / information to send as part of the notification. Comments Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a

Endpoint		C
Short	The technical details of an endpoint that can be used for electronic services
Definition	The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b, a REST endpoint for another FHIR server, or a s/Mime email address. This may include any security context information.
Cardinality	0..*
Constraints	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.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-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-6: A resource should have narrative for robust management text.`div`.exists() dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()`
Mappings	rim: n/a rim: Entity. Role, or Act rim: Entity, Role, or Act w5: infrastructure.exchange
Endpoint.id		Σ
Short	Logical id of this artifact
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
Endpoint.meta		Σ
Short	Metadata about the resource
Definition	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality	0..1
Type	Meta
Summary	True
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a rim: N/A
Endpoint.implicitRules		Σ ?!
Short	A set of rules under which this content was created
Definition	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality	0..1
Type	uri
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
Endpoint.language
Short	Language of the resource content
Definition	The base language in which the resource is written.
Cardinality	0..1
Type	code
Binding	IETF language tag for a human language AllLanguages (required) Additional bindings CommonLanguages (starter)
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).
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
Endpoint.text		C
Short	Text summary of the resource, for human interpretation
Definition	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality	0..1
Type	Narrative
Alias	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.
Conditions	The cardinality or value of this element may be affected by these constraints: dom-6
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a rim: N/A rim: Act.text?
Endpoint.contained		C
Short	Contained, inline Resources
Definition	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, 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.
Cardinality	0..*
Type	Resource
Alias	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.
Conditions	The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5
Mappings	rim: n/a rim: Entity. Role, or Act rim: N/A
Endpoint.extension		C
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
Constraints	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()`
Mappings	rim: n/a rim: N/A
Endpoint.extension:associatedServer		S C
Short	Endpoint Associated Server (ER)
Definition	Associated server of this endpoint.
Cardinality	0..1
Type	Extension(Complex)
Must Support	True
Alias	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.
Constraints	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()`
Mappings	rim: n/a rim: N/A EndpointToAndpunktLogicalEr: urlTillAuktorisationsserver
Endpoint.extension:associatedServer.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
Endpoint.extension:associatedServer.extension		C
Short	Additional content defined by implementations
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.
Cardinality	2..*
Type	Extension
Alias	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.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
Constraints	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()`
Mappings	rim: n/a rim: N/A
Endpoint.extension:associatedServer.extension:associatedServerType		S C
Short	Additional content defined by implementations
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.
Cardinality	1..1
Type	Extension
Must Support	True
Alias	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.
Constraints	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()`
Mappings	rim: n/a rim: N/A
Endpoint.extension:associatedServer.extension:associatedServerType.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
Endpoint.extension:associatedServer.extension:associatedServerType.extension		C
Short	Additional content defined by implementations
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.
Cardinality	0..0
Type	Extension
Alias	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.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
Constraints	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()`
Mappings	rim: n/a rim: N/A
Endpoint.extension:associatedServer.extension:associatedServerType.url		S
Short	identifies the meaning of the extension
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1..1
Type	uri
Must Support	True
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	associatedServerType
Mappings	rim: N/A
Endpoint.extension:associatedServer.extension:associatedServerType.value[x]		S C
Short	Value of extension
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Cardinality	1..1
Type	Coding
Binding	er-server-types (required)
Must Support	True
Conditions	The cardinality or value of this element may be affected by these constraints: ext-1
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	{ "system": "http://electronichealth.se/CodeSystem/associated-server-types", "code": "authorization" }
Mappings	rim: n/a rim: N/A
Endpoint.extension:associatedServer.extension:associatedServerType.value[x].id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
Endpoint.extension:associatedServer.extension:associatedServerType.value[x].extension		C
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
Constraints	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()`
Mappings	rim: n/a rim: N/A
Endpoint.extension:associatedServer.extension:associatedServerType.value[x].system		S Σ
Short	Identity of the terminology system
Definition	The identification of the code system that defines the meaning of the symbol in the code.
Cardinality	1..1
Type	uri
Must Support	True
Summary	True
Requirements	Need to be unambiguous about the source of the definition of the symbol.
Comments	The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	http://electronichealth.se/CodeSystem/associated-server-types
Mappings	rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Endpoint.extension:associatedServer.extension:associatedServerType.value[x].version		Σ
Short	Version of the system - if relevant
Definition	The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality	0..1
Type	string
Summary	True
Comments	Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Endpoint.extension:associatedServer.extension:associatedServerType.value[x].code		S Σ C
Short	Symbol in syntax defined by the system
Definition	A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality	1..1
Type	code
Must Support	True
Summary	True
Requirements	Need to refer to a particular code in the system.
Comments	Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
Conditions	The cardinality or value of this element may be affected by these constraints: cod-1
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	authorization
Mappings	rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Endpoint.extension:associatedServer.extension:associatedServerType.value[x].display		Σ C
Short	Representation defined by the system
Definition	A representation of the meaning of the code in the system, following the rules of the system.
Cardinality	0..1
Type	string
Summary	True
Requirements	Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Comments	Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
Conditions	The cardinality or value of this element may be affected by these constraints: cod-1
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Endpoint.extension:associatedServer.extension:associatedServerType.value[x].userSelected		Σ
Short	If this coding was chosen directly by the user
Definition	Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality	0..1
Type	boolean
Summary	True
Requirements	This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Comments	Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Endpoint.extension:associatedServer.extension:serverURL		S C
Short	Additional content defined by implementations
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.
Cardinality	1..1
Type	Extension
Must Support	True
Alias	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.
Constraints	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()`
Mappings	rim: n/a rim: N/A
Endpoint.extension:associatedServer.extension:serverURL.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
Endpoint.extension:associatedServer.extension:serverURL.extension		C
Short	Additional content defined by implementations
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.
Cardinality	0..0
Type	Extension
Alias	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.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
Constraints	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()`
Mappings	rim: n/a rim: N/A
Endpoint.extension:associatedServer.extension:serverURL.url		S
Short	identifies the meaning of the extension
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1..1
Type	uri
Must Support	True
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	serverURL
Mappings	rim: N/A
Endpoint.extension:associatedServer.extension:serverURL.value[x]		S C
Short	Value of extension
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Cardinality	1..1
Type	url
Must Support	True
Conditions	The cardinality or value of this element may be affected by these constraints: ext-1
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` endpoint-security-url-er-1: The security url of an Endpoint must start with https:// followed by a combination of alphanumerical characters, slashes (/) and/or full stops (.) `$this.matches('^https:\/\/[\/\.A-Öa-ö0-9]+$')` endpoint-security-url-er-2: The security url of an Endpoint must be a maximum of 255 characters `$this.length() <= 255`
Mappings	rim: n/a rim: N/A
Endpoint.extension:associatedServer.url
Short	identifies the meaning of the extension
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1..1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-associated-server-er
Mappings	rim: N/A
Endpoint.extension:associatedServer.value[x]		C
Short	Value of extension
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Cardinality	0..0
Type	Address \| Age \| Annotation \| Attachment \| Availability \| base64Binary \| boolean \| canonical \| code \| CodeableConcept \| CodeableReference \| Coding \| ContactDetail \| ContactPoint \| Count \| DataRequirement \| date \| dateTime \| decimal \| Distance \| Dosage \| Duration \| Expression \| ExtendedContactDetail \| HumanName \| id \| Identifier \| instant \| integer \| integer64 \| markdown \| Meta \| Money \| oid \| ParameterDefinition \| Period \| positiveInt \| Quantity \| Range \| Ratio \| RatioRange \| Reference \| RelatedArtifact \| SampledData \| Signature \| string \| time \| Timing \| TriggerDefinition \| unsignedInt \| uri \| url \| UsageContext \| uuid
Conditions	The cardinality or value of this element may be affected by these constraints: ext-1
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a rim: N/A
Endpoint.modifierExtension		Σ ?! C
Short	Extensions that cannot be ignored
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content
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.
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.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
Constraints	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()`
Mappings	rim: n/a rim: N/A
Endpoint.identifier		Σ C
Short	Identifies this endpoint across multiple systems
Definition	Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
Cardinality	0..*
Type	Identifier
Summary	True
Comments	The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason `value.exists()`
Mappings	rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier w5: FiveWs.identifier
Endpoint.status		S Σ ?!
Short	active \| suspended \| error \| off \| entered-in-error \| test
Definition	The endpoint status represents the general expected availability of an endpoint.
Cardinality	1..1
Type	code
Binding	The status of the endpoint. er-endpoint-statuses (required)
Must Support	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a w5: FiveWs.status EndpointToAndpunktLogicalEr: status
Endpoint.connectionType		S Σ
Short	Protocol/Profile/Standard to be used with this endpoint connection
Definition	A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
Cardinality	1..*
Type	CodeableConcept
Binding	EndpointConnectionType (example)
Must Support	True
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.
Slicing	Unordered, Open, by $this(Value) Slice on connectionType based on value set binding
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD w5: FiveWs.class
Endpoint.connectionType.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
Endpoint.connectionType.extension		C
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
Constraints	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()`
Mappings	rim: n/a rim: N/A
Endpoint.connectionType.coding		S Σ C
Short	Code defined by a terminology system
Definition	A reference to a code defined by a terminology system.
Cardinality	1..1
Type	Coding
Must Support	True
Summary	True
Requirements	Allows for alternative encodings within a code system, and translations to other code systems.
Comments	Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text `code.exists().not() implies display.exists().not()`
Mappings	rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Endpoint.connectionType.coding.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
Endpoint.connectionType.coding.extension		C
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
Constraints	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()`
Mappings	rim: n/a rim: N/A
Endpoint.connectionType.coding.system		S Σ
Short	Identity of the terminology system
Definition	The identification of the code system that defines the meaning of the symbol in the code.
Cardinality	1..1
Type	uri
Must Support	True
Summary	True
Requirements	Need to be unambiguous about the source of the definition of the symbol.
Comments	The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Endpoint.connectionType.coding.version		Σ
Short	Version of the system - if relevant
Definition	The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality	0..1
Type	string
Summary	True
Comments	Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Endpoint.connectionType.coding.code		S Σ C
Short	Symbol in syntax defined by the system
Definition	A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality	1..1
Type	code
Must Support	True
Summary	True
Requirements	Need to refer to a particular code in the system.
Comments	Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
Conditions	The cardinality or value of this element may be affected by these constraints: cod-1
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Endpoint.connectionType.coding.display		Σ C
Short	Representation defined by the system
Definition	A representation of the meaning of the code in the system, following the rules of the system.
Cardinality	0..1
Type	string
Summary	True
Requirements	Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Comments	Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
Conditions	The cardinality or value of this element may be affected by these constraints: cod-1
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Endpoint.connectionType.coding.userSelected		Σ
Short	If this coding was chosen directly by the user
Definition	Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality	0..1
Type	boolean
Summary	True
Requirements	This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Comments	Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Endpoint.connectionType.text		Σ
Short	Plain text representation of the concept
Definition	A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality	0..1
Type	string
Summary	True
Requirements	The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Comments	Very often the text is the same as a displayName of one of the codings.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Endpoint.connectionType:securityMethod		S Σ
Short	Protocol/Profile/Standard to be used with this endpoint connection
Definition	A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
Cardinality	0..1
Type	CodeableConcept
Binding	RestfulSecurityService (required)
Must Support	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD w5: FiveWs.class EndpointToAndpunktLogicalEr: sakerhetsmetod
Endpoint.connectionType:securityMethod.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
Endpoint.connectionType:securityMethod.extension		C
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
Constraints	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()`
Mappings	rim: n/a rim: N/A
Endpoint.connectionType:securityMethod.coding		S Σ C
Short	Code defined by a terminology system
Definition	A reference to a code defined by a terminology system.
Cardinality	1..1
Type	Coding
Must Support	True
Summary	True
Requirements	Allows for alternative encodings within a code system, and translations to other code systems.
Comments	Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text `code.exists().not() implies display.exists().not()`
Mappings	rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Endpoint.connectionType:securityMethod.coding.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
Endpoint.connectionType:securityMethod.coding.extension		C
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
Constraints	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()`
Mappings	rim: n/a rim: N/A
Endpoint.connectionType:securityMethod.coding.system		S Σ
Short	Identity of the terminology system
Definition	The identification of the code system that defines the meaning of the symbol in the code.
Cardinality	1..1
Type	uri
Must Support	True
Summary	True
Requirements	Need to be unambiguous about the source of the definition of the symbol.
Comments	The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Fixed Value	http://hl7.org/fhir/restful-security-service
Mappings	rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Endpoint.connectionType:securityMethod.coding.version		Σ
Short	Version of the system - if relevant
Definition	The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality	0..1
Type	string
Summary	True
Comments	Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Endpoint.connectionType:securityMethod.coding.code		S Σ C
Short	Symbol in syntax defined by the system
Definition	A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality	1..1
Type	code
Must Support	True
Summary	True
Requirements	Need to refer to a particular code in the system.
Comments	Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
Conditions	The cardinality or value of this element may be affected by these constraints: cod-1
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Endpoint.connectionType:securityMethod.coding.display		Σ C
Short	Representation defined by the system
Definition	A representation of the meaning of the code in the system, following the rules of the system.
Cardinality	0..1
Type	string
Summary	True
Requirements	Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Comments	Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
Conditions	The cardinality or value of this element may be affected by these constraints: cod-1
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Endpoint.connectionType:securityMethod.coding.userSelected		Σ
Short	If this coding was chosen directly by the user
Definition	Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality	0..1
Type	boolean
Summary	True
Requirements	This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Comments	Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Endpoint.connectionType:securityMethod.text		Σ
Short	Plain text representation of the concept
Definition	A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality	0..1
Type	string
Summary	True
Requirements	The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Comments	Very often the text is the same as a displayName of one of the codings.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Endpoint.connectionType:protocol		S Σ
Short	Protocol/Profile/Standard to be used with this endpoint connection
Definition	A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
Cardinality	0..1
Type	CodeableConcept
Binding	er-endpoint-connection-types (required)
Must Support	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD w5: FiveWs.class EndpointToAndpunktLogicalEr: protokoll
Endpoint.connectionType:protocol.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
Endpoint.connectionType:protocol.extension		C
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
Constraints	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()`
Mappings	rim: n/a rim: N/A
Endpoint.connectionType:protocol.coding		S Σ C
Short	Code defined by a terminology system
Definition	A reference to a code defined by a terminology system.
Cardinality	1..1
Type	Coding
Must Support	True
Summary	True
Requirements	Allows for alternative encodings within a code system, and translations to other code systems.
Comments	Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text `code.exists().not() implies display.exists().not()`
Mappings	rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Endpoint.connectionType:protocol.coding.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
Endpoint.connectionType:protocol.coding.extension		C
Short	Additional content defined by implementations
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.
Cardinality	0..*
Type	Extension
Alias	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.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
Constraints	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()`
Mappings	rim: n/a rim: N/A
Endpoint.connectionType:protocol.coding.system		S Σ
Short	Identity of the terminology system
Definition	The identification of the code system that defines the meaning of the symbol in the code.
Cardinality	1..1
Type	uri
Must Support	True
Summary	True
Requirements	Need to be unambiguous about the source of the definition of the symbol.
Comments	The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Endpoint.connectionType:protocol.coding.version		Σ
Short	Version of the system - if relevant
Definition	The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality	0..1
Type	string
Summary	True
Comments	Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Endpoint.connectionType:protocol.coding.code		S Σ C
Short	Symbol in syntax defined by the system
Definition	A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality	1..1
Type	code
Must Support	True
Summary	True
Requirements	Need to refer to a particular code in the system.
Comments	Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
Conditions	The cardinality or value of this element may be affected by these constraints: cod-1
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Endpoint.connectionType:protocol.coding.display		Σ C
Short	Representation defined by the system
Definition	A representation of the meaning of the code in the system, following the rules of the system.
Cardinality	0..1
Type	string
Summary	True
Requirements	Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Comments	Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
Conditions	The cardinality or value of this element may be affected by these constraints: cod-1
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Endpoint.connectionType:protocol.coding.userSelected		Σ
Short	If this coding was chosen directly by the user
Definition	Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality	0..1
Type	boolean
Summary	True
Requirements	This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Comments	Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Endpoint.connectionType:protocol.text		Σ
Short	Plain text representation of the concept
Definition	A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality	0..1
Type	string
Summary	True
Requirements	The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Comments	Very often the text is the same as a displayName of one of the codings.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Endpoint.name		S Σ C
Short	A name that this endpoint can be identified by
Definition	A friendly name that this endpoint can be referred to with.
Cardinality	1..1
Type	string
Must Support	True
Summary	True
Comments	Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` endpoint-name-er-1: The name of an Endpoint must contain alphanumerical characters, spaces and/or one or more of the following special characters: _-.,\'()&/ `$this.matches('^[A-Öa-ö0-9 _-.,\'()&/]+$')` endpoint-name-er-2: The name of an Endpoint must be a maximum of 255 characters `$this.length() <= 255`
Mappings	rim: n/a w5: FiveWs.what[x] EndpointToAndpunktLogicalEr: namn
Endpoint.description		Σ
Short	Additional details about the endpoint that could be displayed as further information to identify the description beyond its name
Definition	The description of the endpoint and what it is for (typically used as supplemental information in an endpoint directory describing its usage/purpose).
Cardinality	0..1
Type	string
Summary	True
Comments	Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
Endpoint.environmentType		Σ
Short	The type of environment(s) exposed at this endpoint
Definition	The type of environment(s) exposed at this endpoint (dev, prod, test, etc.).
Cardinality	0..*
Type	CodeableConcept
Binding	EndpointEnvironment (extensible)
Summary	True
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
Endpoint.managingOrganization		Σ C
Short	Organization that manages this endpoint (might not be the organization that exposes the endpoint)
Definition	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).
Cardinality	0..1
Type	Reference(Organization)
Summary	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))` ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided). `reference.exists() or identifier.exists() or display.exists() or extension.exists()`
Mappings	rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
Endpoint.contact		C
Short	Contact details for source (e.g. troubleshooting)
Definition	Contact details for a human to contact about the endpoint. The primary use of this for system administrator troubleshooting.
Cardinality	0..*
Type	ContactPoint
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2: A system is required if a value is provided. `value.empty() or system.exists()`
Mappings	rim: n/a v2: XTN rim: TEL servd: ContactPoint
Endpoint.period		Σ C
Short	Interval the endpoint is expected to be operational
Definition	The interval during which the endpoint is expected to be operational.
Cardinality	0..1
Type	Period
Summary	True
Comments	Temporary downtimes or other short-term changes in availability would not be represented in this property.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1: If present, start SHALL have a lower or equal value than end `start.hasValue().not() or end.hasValue().not() or (start.lowBoundary() <= end.highBoundary())`
Mappings	rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] w5: FiveWs.done[x]
Endpoint.payload		S
Short	Set of payloads that are provided by this endpoint
Definition	The set of payloads that are provided/available at this endpoint.
Cardinality	0..*
Type	BackboneElement
Must Support	True
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a EndpointToAndpunktLogicalEr: tillgangliggor(APILogicalEr)
Endpoint.payload.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Mappings	rim: n/a
Endpoint.payload.extension		C
Short	Additional content defined by implementations
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.
Cardinality	1..*
Type	Extension
Alias	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.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
Constraints	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()`
Mappings	rim: n/a rim: N/A
Endpoint.payload.extension:apiSpecification		S C
Short	Endpoint Payload Actor Definition (ER)
Definition	ActorDefinition that this payload is implementing.
Cardinality	1..1
Type	Extension(canonical(APISpecificationEr))
Must Support	True
Alias	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.
Constraints	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()`
Mappings	rim: n/a rim: N/A
Endpoint.payload.modifierExtension		Σ ?! C
Short	Extensions that cannot be ignored even if unrecognized
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).
Cardinality	0..*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
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.
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.
Constraints	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()`
Mappings	rim: n/a rim: N/A
Endpoint.payload.type		Σ
Short	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Definition	The payload type describes the acceptable content that can be communicated on the endpoint.
Cardinality	0..*
Type	CodeableConcept
Binding	EndpointPayloadType (example)
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.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
Endpoint.payload.mimeType		Σ
Short	Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Definition	The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
Cardinality	0..*
Type	code
Binding	BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) MimeTypes (required)
Summary	True
Comments	Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a
Endpoint.address		S Σ
Short	The technical base address for connecting to this endpoint
Definition	The uri that describes the actual end-point to connect to.
Cardinality	1..1
Type	url
Must Support	True
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/...".
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a EndpointToAndpunktLogicalEr: adress
Endpoint.header
Short	Usage depends on the channel type
Definition	Additional headers / information to send as part of the notification.
Cardinality	0..*
Type	string
Comments	Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: n/a

<id value="endpoint-er" />
<url value="http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-er" />
<version value="0.1.0" />
<name value="EndpointEr" />
<title value="Endpoint (ER)" />
<status value="active" />
<description value="This profile holds information about a technical address to an API." />
<fhirVersion value="5.0.0" />
<mapping>
<identity value="EndpointToAndpunktLogicalEr" />
<uri value="AndpunktLogicalEr" />
</mapping>
<kind value="resource" />
<abstract value="false" />
<type value="Endpoint" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Endpoint" />
<derivation value="constraint" />
<differential>
<element id="Endpoint.extension:associatedServer">
<path value="Endpoint.extension" />
<sliceName value="associatedServer" />
<min value="0" />
<max value="1" />
<type>
<code value="Extension" />
<profile value="http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-associated-server-er" />
</type>
<mustSupport value="true" />
<mapping>
<identity value="EndpointToAndpunktLogicalEr" />
<map value="urlTillAuktorisationsserver" />
</mapping>
</element>
<element id="Endpoint.extension:associatedServer.extension:associatedServerType">
<path value="Endpoint.extension.extension" />
<sliceName value="associatedServerType" />
</element>
<element id="Endpoint.extension:associatedServer.extension:associatedServerType.url">
<path value="Endpoint.extension.extension.url" />
<mustSupport value="true" />
</element>
<element id="Endpoint.extension:associatedServer.extension:associatedServerType.value[x]">
<path value="Endpoint.extension.extension.value[x]" />
<min value="1" />
<fixedCoding>
<system value="http://electronichealth.se/CodeSystem/associated-server-types" />
<code value="authorization" />
</fixedCoding>
<mustSupport value="true" />
</element>
<element id="Endpoint.extension:associatedServer.extension:associatedServerType.value[x].system">
<path value="Endpoint.extension.extension.value[x].system" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Endpoint.extension:associatedServer.extension:associatedServerType.value[x].code">
<path value="Endpoint.extension.extension.value[x].code" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Endpoint.extension:associatedServer.extension:serverURL">
<path value="Endpoint.extension.extension" />
<sliceName value="serverURL" />
</element>
<element id="Endpoint.extension:associatedServer.extension:serverURL.url">
<path value="Endpoint.extension.extension.url" />
<mustSupport value="true" />
</element>
<element id="Endpoint.extension:associatedServer.extension:serverURL.value[x]">
<path value="Endpoint.extension.extension.value[x]" />
<min value="1" />
<constraint>
<key value="endpoint-security-url-er-1" />
<severity value="error" />
<human value="The security url of an Endpoint must start with https:// followed by a combination of alphanumerical characters, slashes (/) and/or full stops (.)" />
<expression value="$this.matches('^https:\/\/[\/\.A-Öa-ö0-9]+$')" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-er" />
</constraint>
<constraint>
<key value="endpoint-security-url-er-2" />
<severity value="error" />
<human value="The security url of an Endpoint must be a maximum of 255 characters" />
<expression value="$this.length() <= 255" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-er" />
</constraint>
<mustSupport value="true" />
</element>
<element id="Endpoint.status">
<path value="Endpoint.status" />
<mustSupport value="true" />
<binding>
<strength value="required" />
<valueSet value="http://electronichealth.se/fhir/NDI/ValueSet/er-endpoint-statuses" />
</binding>
<mapping>
<identity value="EndpointToAndpunktLogicalEr" />
<map value="status" />
</mapping>
</element>
<element id="Endpoint.connectionType">
<path value="Endpoint.connectionType" />
<slicing>
<discriminator>
<type value="value" />
<path value="$this" />
</discriminator>
<description value="Slice on connectionType based on value set binding" />
<ordered value="false" />
<rules value="open" />
</slicing>
<mustSupport value="true" />
</element>
<element id="Endpoint.connectionType.coding">
<path value="Endpoint.connectionType.coding" />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Endpoint.connectionType.coding.system">
<path value="Endpoint.connectionType.coding.system" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Endpoint.connectionType.coding.code">
<path value="Endpoint.connectionType.coding.code" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Endpoint.connectionType:securityMethod">
<path value="Endpoint.connectionType" />
<sliceName value="securityMethod" />
<min value="0" />
<max value="1" />
<mustSupport value="true" />
<binding>
<strength value="required" />
<valueSet value="http://hl7.org/fhir/ValueSet/restful-security-service" />
</binding>
<mapping>
<identity value="EndpointToAndpunktLogicalEr" />
<map value="sakerhetsmetod" />
</mapping>
</element>
<element id="Endpoint.connectionType:securityMethod.coding">
<path value="Endpoint.connectionType.coding" />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Endpoint.connectionType:securityMethod.coding.system">
<path value="Endpoint.connectionType.coding.system" />
<min value="1" />
<fixedUri value="http://hl7.org/fhir/restful-security-service" />
<mustSupport value="true" />
</element>
<element id="Endpoint.connectionType:securityMethod.coding.code">
<path value="Endpoint.connectionType.coding.code" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Endpoint.connectionType:protocol">
<path value="Endpoint.connectionType" />
<sliceName value="protocol" />
<min value="0" />
<max value="1" />
<mustSupport value="true" />
<binding>
<strength value="required" />
<valueSet value="http://electronichealth.se/fhir/NDI/ValueSet/er-endpoint-connection-type" />
</binding>
<mapping>
<identity value="EndpointToAndpunktLogicalEr" />
<map value="protokoll" />
</mapping>
</element>
<element id="Endpoint.connectionType:protocol.coding">
<path value="Endpoint.connectionType.coding" />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Endpoint.connectionType:protocol.coding.system">
<path value="Endpoint.connectionType.coding.system" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Endpoint.connectionType:protocol.coding.code">
<path value="Endpoint.connectionType.coding.code" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Endpoint.name">
<path value="Endpoint.name" />
<min value="1" />
<constraint>
<key value="endpoint-name-er-1" />
<severity value="error" />
<human value="The name of an Endpoint must contain alphanumerical characters, spaces and/or one or more of the following special characters: _-.,\'()&/" />
<expression value="$this.matches('^[A-Öa-ö0-9 _-.,\'()&/]+$')" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-er" />
</constraint>
<constraint>
<key value="endpoint-name-er-2" />
<severity value="error" />
<human value="The name of an Endpoint must be a maximum of 255 characters" />
<expression value="$this.length() <= 255" />
<source value="http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-er" />
</constraint>
<mustSupport value="true" />
<mapping>
<identity value="EndpointToAndpunktLogicalEr" />
<map value="namn" />
</mapping>
</element>
<element id="Endpoint.payload">
<path value="Endpoint.payload" />
<mustSupport value="true" />
<mapping>
<identity value="EndpointToAndpunktLogicalEr" />
<map value="tillgangliggor(APILogicalEr)" />
</mapping>
</element>
<element id="Endpoint.payload.extension">
<path value="Endpoint.payload.extension" />
<min value="1" />
</element>
<element id="Endpoint.payload.extension:apiSpecification">
<path value="Endpoint.payload.extension" />
<sliceName value="apiSpecification" />
<min value="1" />
<max value="1" />
<type>
<code value="Extension" />
<profile value="http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-payload-actor-definition-er" />
</type>
<mustSupport value="true" />
</element>
<element id="Endpoint.address">
<path value="Endpoint.address" />
<mustSupport value="true" />
<mapping>
<identity value="EndpointToAndpunktLogicalEr" />
<map value="adress" />
</mapping>
</element>
</differential>

</StructureDefinition>

{

"resourceType": "StructureDefinition",
"id": "endpoint-er",
"url": "http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-er",
"version": "0.1.0",
"name": "EndpointEr",
"title": "Endpoint (ER)",
"status": "active",
"description": "This profile holds information about a technical address to an API.",
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "EndpointToAndpunktLogicalEr",
"uri": "AndpunktLogicalEr"
}
],
"kind": "resource",
"abstract": false,
"type": "Endpoint",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Endpoint",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Endpoint.extension:associatedServer",
"path": "Endpoint.extension",
"sliceName": "associatedServer",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-associated-server-er"
]
}
],
"mustSupport": true,
"mapping": [
{
"identity": "EndpointToAndpunktLogicalEr",
"map": "urlTillAuktorisationsserver"
}
]
},
{
"id": "Endpoint.extension:associatedServer.extension:associatedServerType",
"path": "Endpoint.extension.extension",
"sliceName": "associatedServerType"
},
{
"id": "Endpoint.extension:associatedServer.extension:associatedServerType.url",
"path": "Endpoint.extension.extension.url",
"mustSupport": true
},
{
"id": "Endpoint.extension:associatedServer.extension:associatedServerType.value[x]",
"path": "Endpoint.extension.extension.value[x]",
"min": 1,
"fixedCoding": {
"system": "http://electronichealth.se/CodeSystem/associated-server-types",
"code": "authorization"
},
"mustSupport": true
},
{
"id": "Endpoint.extension:associatedServer.extension:associatedServerType.value[x].system",
"path": "Endpoint.extension.extension.value[x].system",
"min": 1,
"mustSupport": true
},
{
"id": "Endpoint.extension:associatedServer.extension:associatedServerType.value[x].code",
"path": "Endpoint.extension.extension.value[x].code",
"min": 1,
"mustSupport": true
},
{
"id": "Endpoint.extension:associatedServer.extension:serverURL",
"path": "Endpoint.extension.extension",
"sliceName": "serverURL"
},
{
"id": "Endpoint.extension:associatedServer.extension:serverURL.url",
"path": "Endpoint.extension.extension.url",
"mustSupport": true
},
{
"id": "Endpoint.extension:associatedServer.extension:serverURL.value[x]",
"path": "Endpoint.extension.extension.value[x]",
"min": 1,
"constraint": [
{
"key": "endpoint-security-url-er-1",
"severity": "error",
"human": "The security url of an Endpoint must start with https:// followed by a combination of alphanumerical characters, slashes (/) and/or full stops (.)",
"expression": "$this.matches('^https:\\/\\/[\\/\\.A-Öa-ö0-9]+$')",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-er"
},
{
"key": "endpoint-security-url-er-2",
"severity": "error",
"human": "The security url of an Endpoint must be a maximum of 255 characters",
"expression": "$this.length() <= 255",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-er"
}
],
"mustSupport": true
},
{
"id": "Endpoint.status",
"path": "Endpoint.status",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://electronichealth.se/fhir/NDI/ValueSet/er-endpoint-statuses"
},
"mapping": [
{
"identity": "EndpointToAndpunktLogicalEr",
"map": "status"
}
]
},
{
"id": "Endpoint.connectionType",
"path": "Endpoint.connectionType",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "$this"
}
],
"description": "Slice on connectionType based on value set binding",
"ordered": false,
"rules": "open"
},
"mustSupport": true
},
{
"id": "Endpoint.connectionType.coding",
"path": "Endpoint.connectionType.coding",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Endpoint.connectionType.coding.system",
"path": "Endpoint.connectionType.coding.system",
"min": 1,
"mustSupport": true
},
{
"id": "Endpoint.connectionType.coding.code",
"path": "Endpoint.connectionType.coding.code",
"min": 1,
"mustSupport": true
},
{
"id": "Endpoint.connectionType:securityMethod",
"path": "Endpoint.connectionType",
"sliceName": "securityMethod",
"min": 0,
"max": "1",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/restful-security-service"
},
"mapping": [
{
"identity": "EndpointToAndpunktLogicalEr",
"map": "sakerhetsmetod"
}
]
},
{
"id": "Endpoint.connectionType:securityMethod.coding",
"path": "Endpoint.connectionType.coding",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Endpoint.connectionType:securityMethod.coding.system",
"path": "Endpoint.connectionType.coding.system",
"min": 1,
"fixedUri": "http://hl7.org/fhir/restful-security-service",
"mustSupport": true
},
{
"id": "Endpoint.connectionType:securityMethod.coding.code",
"path": "Endpoint.connectionType.coding.code",
"min": 1,
"mustSupport": true
},
{
"id": "Endpoint.connectionType:protocol",
"path": "Endpoint.connectionType",
"sliceName": "protocol",
"min": 0,
"max": "1",
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://electronichealth.se/fhir/NDI/ValueSet/er-endpoint-connection-type"
},
"mapping": [
{
"identity": "EndpointToAndpunktLogicalEr",
"map": "protokoll"
}
]
},
{
"id": "Endpoint.connectionType:protocol.coding",
"path": "Endpoint.connectionType.coding",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Endpoint.connectionType:protocol.coding.system",
"path": "Endpoint.connectionType.coding.system",
"min": 1,
"mustSupport": true
},
{
"id": "Endpoint.connectionType:protocol.coding.code",
"path": "Endpoint.connectionType.coding.code",
"min": 1,
"mustSupport": true
},
{
"id": "Endpoint.name",
"path": "Endpoint.name",
"min": 1,
"constraint": [
{
"key": "endpoint-name-er-1",
"severity": "error",
"human": "The name of an Endpoint must contain alphanumerical characters, spaces and/or one or more of the following special characters: _-.,\\'()&/",
"expression": "$this.matches('^[A-Öa-ö0-9 _-.,\\'()&/]+$')",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-er"
},
{
"key": "endpoint-name-er-2",
"severity": "error",
"human": "The name of an Endpoint must be a maximum of 255 characters",
"expression": "$this.length() <= 255",
"source": "http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-er"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "EndpointToAndpunktLogicalEr",
"map": "namn"
}
]
},
{
"id": "Endpoint.payload",
"path": "Endpoint.payload",
"mustSupport": true,
"mapping": [
{
"identity": "EndpointToAndpunktLogicalEr",
"map": "tillgangliggor(APILogicalEr)"
}
]
},
{
"id": "Endpoint.payload.extension",
"path": "Endpoint.payload.extension",
"min": 1
},
{
"id": "Endpoint.payload.extension:apiSpecification",
"path": "Endpoint.payload.extension",
"sliceName": "apiSpecification",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-payload-actor-definition-er"
]
}
],
"mustSupport": true
},
{
"id": "Endpoint.address",
"path": "Endpoint.address",
"mustSupport": true,
"mapping": [
{
"identity": "EndpointToAndpunktLogicalEr",
"map": "adress"
}
]
}
]
}

}

Details

The red must-support flag ("S") indicates that the element is expected in some use cases, and a missing flag that the element is never used.

Security and authorization

The extension "associatedServer" is used for URLs to associated servers. The extension requires a server type code and a URL. This profile currently only supports using the extension for authorization server URLs by setting the server type code to "authorization".

The security method is supplied in the connectionType element by using a code from the Restful Security Service value set.

Validation rules

The table below contains validation rules for the format of a Endpoint along with corresponding error messages. The error messages are returned in an OperationOutcome. An OperationOutcome contains an array of issues where each issue has a details element containing an error message and when relevant an expression element containing the path to the element which the error pertains to.

Value set bindings

The following table shows the elements in the profile that should be populated with codes as well as what value sets contain the valid codes for the respective elements. The strength indicates whether it is recommended or required to choose a code from the defined value set.

Path	Strength	ValueSet
Endpoint.status	required	http://electronichealth.se/fhir/NDI/ValueSet/er-endpoint-statuses
Endpoint.connectionType	required	http://hl7.org/fhir/ValueSet/restful-security-service
Endpoint.connectionType	required	http://electronichealth.se/fhir/NDI/ValueSet/er-endpoint-connection-type

Extensions

Path	URL
Endpoint.extension	http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-associated-server-er
Endpoint.payload.extension	http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-payload-actor-definition-er

Mapping

AndpunktLogicalEr (andpunkt-logical-er)			Base	Element id andpunkt-logical-er Short description Ändpunkt Definition Klassen ändpunkt håller information om teknisk adress till API implementerat på fysisk enhet. Data type Base Mappings rim: n/a
id	C	1..1	Identifier	Element id andpunkt-logical-er.id Short description id Definition Angivelse av identifierare för en ändpunkt. Comments The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason `value.exists()` Mappings rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier AndpunktToEndpointEr:
status	C	1..1	Coding	Element id andpunkt-logical-er.status Short description status Definition Angivelse av kod som anger status för ändpunkt. Comments Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Data type Coding Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text `code.exists().not() implies display.exists().not()` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding AndpunktToEndpointEr: EndpointEr.status
namn		1..1	string	Element id andpunkt-logical-er.namn Short description namn Definition Angivelse av ändpunktens namn. Namn ska vara utformat så att en användare unikt ska kunna identifiera ändpunkten tillsammans med ändpunktens adress. Comments Note that FHIR strings SHALL NOT exceed 1,048,576 (10241024) characters in size Data type* string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a AndpunktToEndpointEr: EndpointEr.name
adress		1..1	url	Element id andpunkt-logical-er.adress Short description adress Definition Angivelse av adress för en ändpunkt. Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier Data type url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a AndpunktToEndpointEr: EndpointEr.address
giltigFrom		1..1	time	Element id andpunkt-logical-er.giltigFrom Short description giltigFrom Definition Angivelse av den tidpunkt från och med vilken ändpunkt är tillgänglig. Data type time Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a AndpunktToEndpointEr:
giltigTom		0..1	time	Element id andpunkt-logical-er.giltigTom Short description giltigTom Definition Angivelse av den tidpunkt då ändpunkt upphör att vara tillgänglig. Data type time Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a AndpunktToEndpointEr:
protokoll	C	0..*	Coding	Element id andpunkt-logical-er.protokoll Short description protokoll Definition Angivelse av kod för den tekniska standard för kommunikation som ändpunkten implementerar. Comments Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Data type Coding Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text `code.exists().not() implies display.exists().not()` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding AndpunktToEndpointEr: EndpointEr.connectionType[protocol]
sakerhetsmetod	C	1..1	Coding	Element id andpunkt-logical-er.sakerhetsmetod Short description säkerhetsmetod Definition Angivelse av kod för den typ av säkerhetsmekanism som används av för att ge åtkomst till det API som ändpunkten tillgängliggör. Comments Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Data type Coding Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cod-1: A Coding SHOULD NOT have a display unless a code is also present. Computation on Coding.display alone is generally unsafe. Consider using CodeableConcept.text `code.exists().not() implies display.exists().not()` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding AndpunktToEndpointEr: EndpointEr.connectionType[securityMethod]
urlTillAuktorisationsserver		0..1	url	Element id andpunkt-logical-er.urlTillAuktorisationsserver Short description urlTillAuktorisationsserver Definition Angivelse av url till den auktorisationsserver som ska användas för att auktorisera den aktör som vill anropa ändpunkten. Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier Data type url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a AndpunktToEndpointEr: EndpointEr.extension[associatedServer]
forvaltasAv	C	1..1	Reference(Organization)	Element id andpunkt-logical-er.forvaltasAv Short description förvaltas av Definition förvaltas av Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))` ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided). `reference.exists() or identifier.exists() or display.exists() or extension.exists()` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
tillgangliggor	C	0..*	Reference(APILogicalEr)	Element id andpunkt-logical-er.tillgangliggor Short description tillgängliggör Definition tillgängliggör Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(APILogicalEr) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))` ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided). `reference.exists() or identifier.exists() or display.exists() or extension.exists()` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) AndpunktToEndpointEr: EndpointEr.payload

Examples

FHIR based endpoint

The following example shows an endpoint that uses OAuth as security method, as seen in one of the connectionType elements. The other connectionType element contains the connection type of the endpoint, which is "hl7-fhir-rest". To show which API specification the endpoint adheres to, the payload has an extension that points to an API Specification (ActorDefinition) with an url "http://electronichealth.se/ntk/ActorDefinition/HL7Europe/LabReportRepos-1" as canonical identifier. The ActorDefinition contains information about the specification. See the corresponding example of API Specification.

Overview
JSON

Endpoint

id : 93bc44b7-f6e2-4204-a2da-b1454d4f274f

meta

profile : http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-er

status : active

connectionType

coding

system : http://hl7.org/fhir/restful-security-service

code : OAuth

connectionType

coding

system : http://terminology.hl7.org/CodeSystem/endpoint-connection-type

code : hl7-fhir-rest

name : Region Kalmar FHIR-API

payload

extension

url : http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-payload-actor-definition-er

value : http://electronichealth.se/ntk/ActorDefinition/HL7Europe/LabReportRepos-1

address : https://api.regionkalmar.se/fhir

{

"resourceType": "Endpoint",

"id": "93bc44b7-f6e2-4204-a2da-b1454d4f274f",

"meta": {

"profile": [

"http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-er"

]

"status": "active",

"connectionType": [

{

"coding": [

{

"system": "http://hl7.org/fhir/restful-security-service",

"code": "OAuth"

}

]

{

"coding": [

{

"system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",

"code": "hl7-fhir-rest"

}

]

}

"name": "Region Kalmar FHIR-API",

"payload": [

{

"extension": [

{

"url": "http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-payload-actor-definition-er",

"valueCanonical": "http://electronichealth.se/ntk/ActorDefinition/HL7Europe/LabReportRepos-1"

}

]

}

"address": "https://api.regionkalmar.se/fhir"

}

Rivta based endpoint

The following example shows an endpoint that uses certificates as security method, as seen in one of the connectionType elements. The other connectionType element contains the connection type of the endpoint, which is "inera-soap-tk". To show which API specification the endpoint adheres to, the payload has an extension that points to an API Specification (ActorDefinition) with an url "http://electronichealth.se/ntk/ActorDefinition/IneraAB/GetCareContact-3" as canonical identifier. The ActorDefinition contains information about the specification. See the corresponding example of API Specification.

Overview
JSON

Endpoint

id : 4811e99e-12d3-464d-8310-e8707c7b9f34

meta

profile : http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-er

status : active

connectionType

coding

system : http://hl7.org/fhir/restful-security-service

code : Certificates

connectionType

coding

system : http://electronichealth.se/CodeSystem/endpoint-connection-types

code : inera-soap-tk

name : Region Kalmar Inera TK

payload

extension

url : http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-payload-actor-definition-er

value : http://electronichealth.se/ntk/ActorDefinition/IneraAB/GetCareContact-3

address : https://api.regionkalmar.se/inera

{

"resourceType": "Endpoint",

"id": "4811e99e-12d3-464d-8310-e8707c7b9f34",

"meta": {

"profile": [

"http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-er"

]

"status": "active",

"connectionType": [

{

"coding": [

{

"system": "http://hl7.org/fhir/restful-security-service",

"code": "Certificates"

}

]

{

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/endpoint-connection-types",

"code": "inera-soap-tk"

}

]

}

"name": "Region Kalmar Inera TK",

"payload": [

{

"extension": [

{

"url": "http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-payload-actor-definition-er",

"valueCanonical": "http://electronichealth.se/ntk/ActorDefinition/IneraAB/GetCareContact-3"

}

]

}

"address": "https://api.regionkalmar.se/inera"

}

Supported operations

HTTP methods

Operation	Supported	Comment
Search (GET, POST)	yes
Insert (POST)	no
Update (PUT)	no
Delete (DEL)	no
Operation (GET, POST)	yes

Query operations

Supported Queries

GET [base]/Endpoint returns a Bundle with all Endpoints.
GET [base]/Endpoint/[LogicalId] returns a Endpoint if found, otherwise a 404 Not Found.
GET [base]/Endpoint?[parameters] returns a Bundle with Endpoints in the entry element that meet the search criterias. If no Endpoints meet the search criterias the Bundle will be empty.

Search parameters

Parameter	Description	Example
_id	Logical ID of Endpoint	`[base]/Endpoint?_id=625aac66-a744-472c-8496-417fce2ada44`
_revinclude=Organization.endpoint	Includes all Organizations that reference to a Endpoint in the Organization.endpoint element	`[base]/Endpoint?_id=625aac66-a744-472c-8496-417fce2ada44&_revinclude=Organization:endpoint`
actor	Canonical URL of ActorDefinition - API Specification that Endpoint adheres to	`[base]/Endpoint?actor=http://electronichealth.se/ntk/ActorDefinition/HL7Europe/LabReportRepos-1`

Extended operations

Add/Remove Organization

Adds or removes a Organization to a Endpoint, by adding Endpoint to the Organization.endpoint element. Adding a Organization to a Endpoint means that patient data owned by the Organization can be found at the endpoint. One Organization can use zero to many Endpoints. One Endpoint can be used by zero to many Organizations.

Invocations

Add: POST [base]/Endpoint/[id]/$add-organization

Remove: POST [base]/Endpoint/[id]/$remove-organization

Parameters (In)

Name	Cardinality	Type	Documentation
id	1..1	string	Logical ID (UUID) of Endpoint, supply as part of invocation address.
organization	1..1	Identifier (system and value)	Organization identifier. Supply in request body.

Valid organization identifiers:

Personal identity number (sv: personnummer)
- system: http://electronichealth.se/identifier/personnummer
- value format: 12 digits without hyphen, eg 198001032385
Coordination number (sv: samordningsnummer)
- system: http://electronichealth.se/identifier/samordningsnummer
- value format: 12 digits without hyphen, eg 201903682399
Organization identifier (sv: organisationsnummer)
- system: urn:oid:2.5.4.97
- value format: 10 digits without hyphen, eg 5560269986

Return Values (Out)

Name	Cardinality	Type	Documentation
return	1..1	OperationOutcome	OperationOutcome with result of operation

Validation messages

Validation messages are error, information or success messages that are returned as a result of an operation. These messages are returned in a OperationOutcome.

Message	Severity	Parameter	Comment
2-38-1: Required parameter missing.	Error	id, organization	Parameters with cardinality 1..N must be supplied
2-38-8: Endpoint not found.	Error	id
2-38-9: Invalid parameter. Valid parameters are id, organization.	Error
2-38-4: Invalid system. Valid systems are http://electronichealth.se/identifier/personnummer, urn:oid:2.5.4.97	Error	organization.valueIdentifier.system	The Identifier.system value of parameter organization must be be from list of valid systems (see section Parameters (In) above)
2-38-2: Invalid format of personal identity number. Submit the personal identity number using 12 digits with or without hyphen, e.g. 198001032385.	Error	organization.valueIdentifier.value
2-44-X: Invalid format of coordination number. Submit the coordination number using 12 digits with or without hyphen, e.g. 201903682399.	Error	organization.valueIdentifier.value
2-38-7: Invalid format of organization identifier. Submit the organization identifier using 10 digits without hyphen, e.g. 5560269986.	Error	organization.valueIdentifier.value
4-38-301: Organization was successfully added to the endpoint.	Success
4-38-302: Organization was successfully removed from the endpoint.	Success
4-38-303: Organization has already been added to the endpoint.	Information
4-38-304: Organization has already been removed from the endpoint.	Information

Examples

Request body

The following example shows the request body for adding or removing an organization with organization identifier 5560269986 to an endpoint. The parameter "organization" is supplied inside a Parameters resource together with the value of the parameter in the valueIdentifier element.

{

"resourceType": "Parameters",

"id": "AddOrganizationToEndpoint-OrganizationIdentifier-RequestBody",

"parameter": [

{

"name": "organization",

"valueIdentifier": {

"system": "urn:oid:2.5.4.97",

"value": "5563813962"

}

]

}

Successful operation response

If the operation succeeds, the response will be an OperationOutcome where the issue element is populated with a "success" code and severity. The details element contains a validation code and message, in this case explaining that the organization got added to the endpoint successfully.

{

"resourceType": "OperationOutcome",

"id": "6a9789ae-f2f7-4d48-bc24-d977f1534ac3",

"issue": [

{

"severity": "success",

"code": "success",

"details": {

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/error-codes",
"code": "4-38-301",
"display": "Organization was successfully added to the endpoint."

}

]

}

]

}

Organization already added/removed response

If the organization was already added when calling $add-organization, the response will be an OperationOutcome where the issue elment is populated with severity set to "information" and code to "duplicate".

{

"resourceType": "OperationOutcome",

"id": "82dc7332-7b0f-4eb0-b045-924b5fd15d22",

"issue": [

{

"severity": "information",

"code": "duplicate",

"details": {

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/error-codes",
"code": "4-38-303",
"display": "Organization has already been added to the endpoint."

}

]

}

]

}

If the organization already did not exist on the endpoint when calling $remove-organization, the response will be an OperationOutcome where the issue element is populated with severity set to "information" and code to "not-found".

{

"resourceType": "OperationOutcome",

"id": "50f1a372-47a4-4b41-aacf-e7ad3fb81e8e",

"issue": [

{

"severity": "information",

"code": "not-found",

"details": {

"coding": [

{

"system": "http://electronichealth.se/CodeSystem/error-codes",
"code": "4-38-304",
"display": "Organization has already been removed from the endpoint."

}

]

}

]

}

Failed operation response

If the operation fails, the response will be an OperationOutcome where the issue element is populated with severity set to "error". The code element details what kind of issue caused the error, for example "value" if the error was caused by invalid value format. The details element contains an error code and message, in this case explaining that the operation failed because of invalid format of organization identifier value.

{

"resourceType": "OperationOutcome",

"id": "b5e62914-fff8-46c8-b3fc-ed562d7d9688",

"issue": [

{

"severity": "error",
"code": "value",
"details": {
"coding": [
{
"system": "http://electronichealth.se/CodeSystem/error-codes",
"code": "2-38-7",
"display": "Invalid format of organization identifier. Submit the organization identifier using 10 digits without hyphen, e.g. 5560269986."
}
]
},
"diagnostics": "organization.valueIdentifier.value"

}

]

}