no-basis-Endpoint
type: StructureDefinition
node role: treeRoot
id:
  v: no-basis-Endpoint
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition no-basis-Endpoint Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> <a href="StructureDefinition-no-basis-Endpoint-definitions.html#Endpoint" title="The no-basis profile of the Endpoint resource makes it possible to use the resource for the norwegian service based adressing (tjenestebasert adressering) and other adressing schemes.#xD;#xA;#xD;#xA;The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.">Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services #xD; identifier 0..* Identifier Identifies this endpoint across multiple systems #xD; <a href="StructureDefinition-no-basis-Endpoint-definitions.html#Endpoint.connectionType" title="no-basis: the connection type should be coded according to http://hl7.org/fhir/ValueSet/endpoint-connection-type. However specific connection types used in Norway can be coded according to http://hl7.no/fhir/ValueSet/no-basis-endpoint-connection-type (amqp, ebxml etc.)#xD;#xA;#xD;#xA;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).">connectionType 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection Binding: no-basis-connection-type.valueset (extensible) #xD; <a href="StructureDefinition-no-basis-Endpoint-definitions.html#Endpoint.managingOrganization" title="The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data).#xD;#xA;#xD;#xA;no-basis: In Norway this relates to the organization with the responsibility for the data e.g. "dataansvarlig".#xD;#xA;no-basis recommends the use of logical referen…
url:
  v: http://hl7.no/fhir/ig/StructureDefinition/no-basis-Endpoint
  l: no-basis-Endpoint
version:
  v: 2.2.4-test
name:
  v: NoBasisEndpoint
title:
  v: no-basis-Endpoint
status:
  v: active
date:
  v: 2019-05-15
description:
  v: Basisprofil for Norwegian Endpoint information. Defined by The Norwegian Directorate of eHealth and HL7 Norway. The profile adds Norwegian specific identification of Endpoing. The basis profile is open, but derived profiles should close down the information elements according to specification relevant to the use-case. Resource profile for definition of electronic endpoints used by healthcare organizations to communicate using different protocols. The norwegian profile use-case is to represent endpoints for electronic communication. Fallback solutions using mail or fax has to be indexed in the norwegian master index for healthcare organizations and are not described using this profile.
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
      l: 3166
    code:
      v: NO
    display:
      v: Norway
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
mapping:
  identity:
    v: w5
  uri:
    v: http://hl7.org/fhir/fivews
    l: fivews
  name:
    v: FiveWs Pattern Mapping
kind:
  v: resource
abstract:
  v: false
type:
  v: Endpoint
  l: Endpoint
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Endpoint
  l: Endpoint
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 4.0.1
  element:
    id:
      v: Endpoint
    path:
      v: Endpoint
    short:
      v: The technical details of an endpoint that can be used for electronic services
    definition:
      v: The no-basis profile of the Endpoint resource makes it possible to use the resource for the norwegian service based adressing (tjenestebasert adressering) and other adressing schemes. The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Endpoint
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: dom-2
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL NOT contain nested Resources
      expression:
        v: contained.contained.empty()
      xpath:
        v: not(parent::f:contained and f:contained)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource
    constraint:
      key:
        v: dom-3
      severity:
        v: error
      human:
        v: 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
      expression:
        v: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
      xpath:
        v: not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource
    constraint:
      key:
        v: dom-4
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
      expression:
        v: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
      xpath:
        v: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource
    constraint:
      key:
        v: dom-5
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a security label
      expression:
        v: contained.meta.security.empty()
      xpath:
        v: not(exists(f:contained/*/f:meta/f:security))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource
    constraint:
      extension:
        value: Boolean
      extension:
        value: Markdown
      key:
        v: dom-6
      severity:
        v: warning
      human:
        v: A resource should have narrative for robust management
      expression:
        v: text.`div`.exists()
      xpath:
        v: exists(f:text/h:div)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: Entity. Role, or Act
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: Endpoint.id
    path:
      v: Endpoint.id
    short:
      v: Logical id of this artifact
    definition:
      v: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
    comment:
      v: The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Resource.id
      min:
        v: 0
      max:
        v: 1
    type:
      extension:
        value: Url

Boolean
v: true

Markdown
v: When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.

Url
v: id
l: id

v: false

v: true

id:
  v: Endpoint.meta
path:
  v: Endpoint.meta
short:
  v: Metadata about the resource
definition:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.meta
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Meta
    l: Meta
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: Endpoint.implicitRules
path:
  v: Endpoint.implicitRules
short:
  v: A set of rules under which this content was created
definition:
  v: 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.
comment:
  v: Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.implicitRules
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: true
is modifier reason:
  v: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
is summary:
  v: true

id:
  v: Endpoint.language
path:
  v: Endpoint.language
short:
  v: Language of the resource content
definition:
  v: The base language in which the resource is written.
comment:
  v: 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).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
      l: elementdefinition-maxValueSet
    value: Canonical
      v: http://hl7.org/fhir/ValueSet/all-languages
      l: all-languages
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: Language
  strength:
    v: preferred
  description:
    v: A human language.
  value set:
    v: http://hl7.org/fhir/ValueSet/languages|4.0.1
    l: http://hl7.org/fhir/ValueSet/languages

id:
  v: Endpoint.text
path:
  v: Endpoint.text
short:
  v: Text summary of the resource, for human interpretation
definition:
  v: 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.
comment:
  v: Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
alias:
  v: narrative
alias:
  v: html
alias:
  v: xhtml
alias:
  v: display
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Narrative
    l: Narrative
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: Act.text?

id:
  v: Endpoint.contained
path:
  v: Endpoint.contained
short:
  v: Contained, inline Resources
definition:
  v: These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
comment:
  v: 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.
alias:
  v: inline resources
alias:
  v: anonymous resources
alias:
  v: contained resources
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.contained
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Resource
    l: Resource
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Endpoint.extension
path:
  v: Endpoint.extension
short:
  v: Additional content defined by implementations
definition:
  v: 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 manageable, 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.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Endpoint.modifierExtension
path:
  v: Endpoint.modifierExtension
short:
  v: Extensions that cannot be ignored
definition:
  v: 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 manageable, 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).
comment:
  v: 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.
requirements:
  v: 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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Endpoint.identifier
path:
  v: Endpoint.identifier
short:
  v: Identifies this endpoint across multiple systems
definition:
  v: Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
comment:
  v: no-basis: Adresseregisteret do not provide a identifier for the Endpoints, so any identifier scheme is apropriate.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Endpoint.identifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
    l: Identifier
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.identifier
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Endpoint.status
path:
  v: Endpoint.status
short:
  v: active | suspended | error | off | entered-in-error | test
definition:
  v: active | suspended | error | off | test.
comment:
  v: This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Endpoint.status
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: true
is modifier reason:
  v: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: EndpointStatus
  strength:
    v: required
  description:
    v: The status of the endpoint.
  value set:
    v: http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
    l: http://hl7.org/fhir/ValueSet/endpoint-status
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.status
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Endpoint.connectionType
path:
  v: Endpoint.connectionType
short:
  v: Protocol/Profile/Standard to be used with this endpoint connection
definition:
  v: no-basis: the connection type should be coded according to http://hl7.org/fhir/ValueSet/endpoint-connection-type. However specific connection types used in Norway can be coded according to http://hl7.no/fhir/ValueSet/no-basis-endpoint-connection-type (amqp, ebxml etc.) A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
comment:
  v: For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Endpoint.connectionType
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Coding
    l: Coding
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
binding:
  strength:
    v: extensible
  value set:
    v: http://hl7.no/fhir/ValueSet/no-basis-connection-type
    l: no-basis-connection-type
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.class
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Endpoint.name
path:
  v: Endpoint.name
short:
  v: A name that this endpoint can be identified by
definition:
  v: A friendly name that this endpoint can be referred to with.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Endpoint.name
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.what[x]
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Endpoint.managingOrganization
path:
  v: Endpoint.managingOrganization
short:
  v: Organization that manages this endpoint (might not be the organization that exposes the endpoint)
definition:
  v: The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data). no-basis: In Norway this relates to the organization with the responsibility for the data e.g. "dataansvarlig". no-basis recommends the use of logical reference to an organization using ENH or RSH. To describe a top level organization. Departments within an organization could use a different reference scheme defined by the organization.
comment:
  v: 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.
alias:
  v: dataansvarlig
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Endpoint.managingOrganization
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    l: Organization
  target profile:
    v: http://hl7.no/fhir/ig/StructureDefinition/no-basis-Organization
    l: no-basis-Organization
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Endpoint.contact
path:
  v: Endpoint.contact
short:
  v: Contact details for source (e.g. troubleshooting)
definition:
  v: Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Endpoint.contact
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: ContactPoint
    l: ContactPoint
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Endpoint.period
path:
  v: Endpoint.period
short:
  v: Interval the endpoint is expected to be operational
definition:
  v: The interval during which the endpoint is expected to be operational.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Endpoint.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.done[x]
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Endpoint.payloadType
path:
  v: Endpoint.payloadType
slicing:
  discriminator:
    type:
      v: value
    path:
      v: coding.system
  rules:
    v: open
short:
  v: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
definition:
  v: no-basis: for ebXML and AMQP messages in Norway one is expected to list all mesage types that the endpoint supports using the CodeSystem Meldingens funksjon (OID=8279) as a minimum. To describe complete version information to determine the type and version of the messages the endpoint supports, a CapabilityStatement can be used to describe the endpoints communication capabilities in detail. REST endpoints are expected to use the code "any" from https://www.hl7.org/fhir/codesystem-endpoint-payload-type.html. Proper FHIR Restful API's are expected to serve a CapabilityStatement from the base uri specified. Other payload types can be given using codes from the ValueSet http://hl7.org/fhir/ValueSet/endpoint-payload-type. The payload type describes the acceptable content that can be communicated on the endpoint.
comment:
  v: The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan.
min:
  v: 1
max:
  v: *
base:
  path:
    v: Endpoint.payloadType
  min:
    v: 1
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: PayloadType
  strength:
    v: example
  value set:
    v: http://hl7.org/fhir/ValueSet/endpoint-payload-type|4.0.1
    l: http://hl7.org/fhir/ValueSet/endpoint-payload-type
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Endpoint.payloadType:meldingensFunksjon
path:
  v: Endpoint.payloadType
slice name:
  v: meldingensFunksjon
short:
  v: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
definition:
  v: no-basis: for ebXML and AMQP messages in Norway one is expected to list all mesage types that the endpoint supports using the CodeSystem Meldingens funksjon (OID=8279). Version information (version of the payload document) shold be given in the coding.version element. The payload type describes the acceptable content that can be communicated on the endpoint.
comment:
  v: The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Endpoint.payloadType
  min:
    v: 1
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
binding:
  strength:
    v: required
  value set:
    v: urn:oid:2.16.578.1.12.4.1.1.8279
    l: 2.16.578.1.12.4.1.1.8279
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Endpoint.payloadType:formatCode
path:
  v: Endpoint.payloadType
slice name:
  v: formatCode
short:
  v: Specific information about payload type and version
definition:
  v: no-basis: Specific information about payload type and version. Information about the payload type and version for ebxml and amqp messages The payload type describes the acceptable content that can be communicated on the endpoint.
comment:
  v: The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Endpoint.payloadType
  min:
    v: 1
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
binding:
  strength:
    v: required
  value set:
    v: urn:oid:2.16.578.1.12.4.1.1.0000
    l: 2.16.578.1.12.4.1.1.0000
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Endpoint.payloadMimeType
path:
  v: Endpoint.payloadMimeType
short:
  v: Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
definition:
  v: no-basis: should we list relevant codes for ebXML messages? List appropriate media types for FHIR REST endpoints? XML: application/fhir+xml JSON: application/fhir+json RDF: application/fhir+turtle ebXML messages: text/xml The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
comment:
  v: Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Endpoint.payloadMimeType
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: code
    l: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
binding:
  strength:
    v: required
  value set:
    v: http://www.rfc-editor.org/bcp/bcp13.txt
    l: bcp13.txt
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Endpoint.address
path:
  v: Endpoint.address
short:
  v: The technical base address for connecting to this endpoint
definition:
  v: The uri that describes the actual end-point to connect to. no-basis: for ebXML messages in Norway one is expected to use mailto: prefix for the endpoint. For AMQP messages in Norway one is expected to use "ampq://" or "amqps://" prefix. REST endpoints will have "http://" or "https://" prefix.
comment:
  v: 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/...".
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Endpoint.address
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: url
    l: url
example:
  label:
    v: amqp endpoint
  value: Url
    v: amqp_endpoint
    l: amqp endpoint
example:
  label:
    v: ebxml endpoint
  value: Url
    v: ebxml_endpoint
    l: ebxml endpoint
example:
  label:
    v: REST endpoint
  value: Url
    v: REST_endpoint
    l: REST endpoint
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Endpoint.header
path:
  v: Endpoint.header
short:
  v: Usage depends on the channel type
definition:
  v: Additional headers / information to send as part of the notification.
comment:
  v: Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Endpoint.header
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
    l: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false

element:
  id:
    v: Endpoint
  path:
    v: Endpoint
  definition:
    v: The no-basis profile of the Endpoint resource makes it possible to use the resource for the norwegian service based adressing (tjenestebasert adressering) and other adressing schemes. The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.
element:
  id:
    v: Endpoint.identifier
  path:
    v: Endpoint.identifier
  comment:
    v: no-basis: Adresseregisteret do not provide a identifier for the Endpoints, so any identifier scheme is apropriate.
element:
  id:
    v: Endpoint.connectionType
  path:
    v: Endpoint.connectionType
  definition:
    v: no-basis: the connection type should be coded according to http://hl7.org/fhir/ValueSet/endpoint-connection-type. However specific connection types used in Norway can be coded according to http://hl7.no/fhir/ValueSet/no-basis-endpoint-connection-type (amqp, ebxml etc.) A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
  binding:
    strength:
      v: extensible
    value set:
      v: http://hl7.no/fhir/ValueSet/no-basis-connection-type
      l: no-basis-connection-type
element:
  id:
    v: Endpoint.managingOrganization
  path:
    v: Endpoint.managingOrganization
  definition:
    v: The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data). no-basis: In Norway this relates to the organization with the responsibility for the data e.g. "dataansvarlig". no-basis recommends the use of logical reference to an organization using ENH or RSH. To describe a top level organization. Departments within an organization could use a different reference scheme defined by the organization.
  alias:
    v: dataansvarlig
  type:
    code:
      v: Reference
      l: Reference
    target profile:
      v: http://hl7.org/fhir/StructureDefinition/Organization
      l: Organization
    target profile:
      v: http://hl7.no/fhir/ig/StructureDefinition/no-basis-Organization
      l: no-basis-Organization
element:
  id:
    v: Endpoint.payloadType
  path:
    v: Endpoint.payloadType
  slicing:
    discriminator:
      type:
        v: value
      path:
        v: coding.system
    rules:
      v: open
  definition:
    v: no-basis: for ebXML and AMQP messages in Norway one is expected to list all mesage types that the endpoint supports using the CodeSystem Meldingens funksjon (OID=8279) as a minimum. To describe complete version information to determine the type and version of the messages the endpoint supports, a CapabilityStatement can be used to describe the endpoints communication capabilities in detail. REST endpoints are expected to use the code "any" from https://www.hl7.org/fhir/codesystem-endpoint-payload-type.html. Proper FHIR Restful API's are expected to serve a CapabilityStatement from the base uri specified. Other payload types can be given using codes from the ValueSet http://hl7.org/fhir/ValueSet/endpoint-payload-type. The payload type describes the acceptable content that can be communicated on the endpoint.
element:
  id:
    v: Endpoint.payloadType:meldingensFunksjon
  path:
    v: Endpoint.payloadType
  slice name:
    v: meldingensFunksjon
  definition:
    v: no-basis: for ebXML and AMQP messages in Norway one is expected to list all mesage types that the endpoint supports using the CodeSystem Meldingens funksjon (OID=8279). Version information (version of the payload document) shold be given in the coding.version element. The payload type describes the acceptable content that can be communicated on the endpoint.
  min:
    v: 0
  max:
    v: *
  binding:
    strength:
      v: required
    value set:
      v: urn:oid:2.16.578.1.12.4.1.1.8279
      l: 2.16.578.1.12.4.1.1.8279
element:
  id:
    v: Endpoint.payloadType:formatCode
  path:
    v: Endpoint.payloadType
  slice name:
    v: formatCode
  short:
    v: Specific information about payload type and version
  definition:
    v: no-basis: Specific information about payload type and version. Information about the payload type and version for ebxml and amqp messages The payload type describes the acceptable content that can be communicated on the endpoint.
  min:
    v: 0
  max:
    v: *
  binding:
    strength:
      v: required
    value set:
      v: urn:oid:2.16.578.1.12.4.1.1.0000
      l: 2.16.578.1.12.4.1.1.0000
element:
  id:
    v: Endpoint.payloadMimeType
  path:
    v: Endpoint.payloadMimeType
  definition:
    v: no-basis: should we list relevant codes for ebXML messages? List appropriate media types for FHIR REST endpoints? XML: application/fhir+xml JSON: application/fhir+json RDF: application/fhir+turtle ebXML messages: text/xml The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
  binding:
    strength:
      v: required
    value set:
      v: http://www.rfc-editor.org/bcp/bcp13.txt
      l: bcp13.txt
element:
  id:
    v: Endpoint.address
  path:
    v: Endpoint.address
  definition:
    v: The uri that describes the actual end-point to connect to. no-basis: for ebXML messages in Norway one is expected to use mailto: prefix for the endpoint. For AMQP messages in Norway one is expected to use "ampq://" or "amqps://" prefix. REST endpoints will have "http://" or "https://" prefix.
  example:
    label:
      v: amqp endpoint
    value: Url
      v: amqp_endpoint
      l: amqp endpoint
  example:
    label:
      v: ebxml endpoint
    value: Url
      v: ebxml_endpoint
      l: ebxml endpoint
  example:
    label:
      v: REST endpoint
    value: Url
      v: REST_endpoint
      l: REST endpoint