ndh-Endpoint
type: StructureDefinition
node role: treeRoot
id:
  v: ndh-Endpoint
language:
  v: en
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition ndh-Endpoint Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> Endpoint 0..* Endpoint The technical details of an endpoint that can be used for electronic services #xD; meta #xD; lastUpdated 1..1 instant When the resource version last changed #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:implementation-guide 0..* (Complex) Implementation guide supported URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide #xD; extension:secure-exchange-artifacts 0..* (Complex) Secure Exchange Artifacts store information about the type of public certificate, the certificate itself, and its expiration date. Issued by Certificate Authorities, public certificates are meant for sharing and verification in digital communications. Each certificate includes an expiration date, essential for validating its current validity and maintaining security. This extension is used when the exchange standard requires the discovery of the public key. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts #xD; extension:security-details 0..* (Complex) Security details for an endpoint, including trust framework information, signed artifacts, and public certificates. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details #xD; extension:dynamic-registration 0..* (Complex) Dynamic registration within a trust framework refers to a process where clients can register with a server or service provider dynamically and securely at runtime, rather than being pre-registered manually. This approach is often used in environments where scalability, flexibility, and security are crucial. Currently, dynamic registration is used in SMART and UDAP. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration #xD; extension:associated-servers 0..* (Complex) Store in…
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
    l: structuredefinition-wg
  value: Code
    v: pa
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
    l: structuredefinition-fmm
  value: Integer
    v: 4
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom
        l: structuredefinition-conformance-derivedFrom
      value: Canonical
        v: http://hl7.org/fhir/us/ndh/ImplementationGuide/hl7.fhir.us.ndh
        l: hl7.fhir.us.ndh
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: trial-use
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom
        l: structuredefinition-conformance-derivedFrom
      value: Canonical
        v: http://hl7.org/fhir/us/ndh/ImplementationGuide/hl7.fhir.us.ndh
        l: hl7.fhir.us.ndh
url:
  v: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Endpoint
  l: ndh-Endpoint
version:
  v: 2.0.0-current
name:
  v: NdhEndpoint
title:
  v: NDH Endpoint Profile
status:
  v: active
date:
  v: 2026-04-22T21:14:50+00:00
publisher:
  v: HL7 International / Patient Administration
contact:
  name:
    v: HL7 International / Patient Administration
  telecom:
    system:
      v: url
    value:
      v: http://www.hl7.org/Special/committees/pafm
  telecom:
    system:
      v: email
description:
  v: The technical details of an endpoint that can be used for electronic services, such as a portal or FHIR REST services, messaging or operations, or DIRECT messaging.
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
      l: 3166
    code:
      v: US
    display:
      v: United States of America
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: ndh-to-plannet-endpoint
  uri:
    v: http://hl7.org/fhir/us/davinci-pdex-plan-net
    l: davinci-pdex-plan-net
  name:
    v: NDH to Plan-Net Endpoint Mapping
  comment:
    v: Maps NDH Endpoint profile to the Plan-Net Endpoint profile, noting elements not present in Plan-Net.
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 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

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice
    l: elementdefinition-bestpractice
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation
    l: elementdefinition-bestpractice-explanation
  value: 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.
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

v: false

v: false

identity:
  v: ndh-to-plannet-endpoint
map:
  v: Endpoint
comment:
  v: Top-level mapping from NDH to Plan-Net

identity:
  v: rim
map:
  v: Entity. Role, or Act

identity:
  v: rim
map:
  v: n/a

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:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: id
      l: id
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  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.meta.id
path:
  v: Endpoint.meta.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Endpoint.meta.extension
path:
  v: Endpoint.meta.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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 element. 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: Element.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.meta.versionId
path:
  v: Endpoint.meta.versionId
short:
  v: Version specific identifier
definition:
  v: The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
comment:
  v: The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Meta.versionId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: id
    l: id
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.meta.lastUpdated
path:
  v: Endpoint.meta.lastUpdated
short:
  v: When the resource version last changed
definition:
  v: When the resource last changed - e.g. when the version changed.
comment:
  v: This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http://hl7.org/fhir/R4/http.html#read) interaction.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Meta.lastUpdated
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: instant
    l: instant
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: ndh-to-plannet-endpoint
  map:
    v: Endpoint.meta.lastUpdated
  comment:
    v: , is required in NDH

id:
  v: Endpoint.meta.source
path:
  v: Endpoint.meta.source
short:
  v: Identifies where the resource comes from
definition:
  v: A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R4/provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
comment:
  v: In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Meta.source
  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: false
is summary:
  v: true

id:
  v: Endpoint.meta.profile
path:
  v: Endpoint.meta.profile
short:
  v: Profiles this resource claims to conform to
definition:
  v: A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url).
comment:
  v: It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Meta.profile
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: canonical
    l: canonical
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/StructureDefinition|4.0.1
    l: http://hl7.org/fhir/StructureDefinition/StructureDefinition
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.meta.security
path:
  v: Endpoint.meta.security
short:
  v: Security Labels applied to this resource
definition:
  v: Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
comment:
  v: The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Meta.security
  min:
    v: 0
  max:
    v: *
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:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: SecurityLabels
  strength:
    v: extensible
  description:
    v: Security Labels from the Healthcare Privacy and Security Classification System.
  value set:
    v: http://hl7.org/fhir/ValueSet/security-labels|4.0.1
    l: http://hl7.org/fhir/ValueSet/security-labels

id:
  v: Endpoint.meta.tag
path:
  v: Endpoint.meta.tag
short:
  v: Tags applied to this resource
definition:
  v: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
comment:
  v: The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Meta.tag
  min:
    v: 0
  max:
    v: *
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:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: Tags
  strength:
    v: example
  description:
    v: Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
  value set:
    v: http://hl7.org/fhir/ValueSet/common-tags|4.0.1
    l: http://hl7.org/fhir/ValueSet/common-tags

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
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
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

id:
  v: Endpoint.extension:implementation-guide
path:
  v: Endpoint.extension
slice name:
  v: implementation-guide
short:
  v: Implementation guide supported
definition:
  v: Implementation Guide Supported, when the connectionType and EndpointIheSpecificConnectionType can't be used.
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide
    l: base-ext-implementation-guide
condition:
  v: ele-1
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: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.extension:secure-exchange-artifacts
path:
  v: Endpoint.extension
slice name:
  v: secure-exchange-artifacts
short:
  v: Secure Exchange Artifacts store information about the type of public certificate, the certificate itself, and its expiration date. Issued by Certificate Authorities, public certificates are meant for sharing and verification in digital communications. Each certificate includes an expiration date, essential for validating its current validity and maintaining security. This extension is used when the exchange standard requires the discovery of the public key.
definition:
  v: This extension is designed to store information about the type of public certificate, the public certificate itself, and the expiration date of the certificate. Public certificates, issued by Certificate Authorities, are intended for sharing and inspection by others as part of the trust and verification process in digital communications. Each certificate includes an expiration date, which is a crucial piece of information easily accessible to anyone examining the certificate. The expiration date plays a significant role in validating the certificate's current validity and in maintaining security within digital communications. This extension should be used when the standard for exchange requires the discovery of the public key.
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts
    l: base-ext-secureExchangeArtifacts
condition:
  v: ele-1
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: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.extension:security-details
path:
  v: Endpoint.extension
slice name:
  v: security-details
short:
  v: Security details for an endpoint, including trust framework information, signed artifacts, and public certificates.
definition:
  v: This extension holds security details for an endpoint. A trust framework typically requires the use of signed artifacts and public certificates to ensure security, integrity, and trust in digital communications and transactions. For trust frameworks that use private PKI there is no need to use this extension unless the goals is to provide access to endpoints via the endpoint reference on any of the relevant resources (e.g., careteam, healthcareService).
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details
    l: base-ext-security-details
condition:
  v: ele-1
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: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.extension:dynamic-registration
path:
  v: Endpoint.extension
slice name:
  v: dynamic-registration
short:
  v: Dynamic registration within a trust framework refers to a process where clients can register with a server or service provider dynamically and securely at runtime, rather than being pre-registered manually. This approach is often used in environments where scalability, flexibility, and security are crucial. Currently, dynamic registration is used in SMART and UDAP.
definition:
  v: Dynamic registration within a trust framework refers to a process where clients can register with a server or service provider dynamically and securely at runtime, rather than being pre-registered manually. This approach is often used in environments where scalability, flexibility, and security are crucial. Currently, dynamic registration is used in SMART and UDAP.
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration
    l: base-ext-dynamicRegistration
condition:
  v: ele-1
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: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.extension:associated-servers
path:
  v: Endpoint.extension
slice name:
  v: associated-servers
short:
  v: Store information about servers that may be associated with the current endpoint. It defines a set of servers that could be linked to this endpoint. If a server is associated, its type and URL will be included
definition:
  v: This extension is designed to store information about servers that may be associated with the current endpoint. It defines a set of servers that could be linked to this endpoint. If a server is associated, the server's type and URL will be included. For example, if your system features two types of endpoints: a standard endpoint and a proxy endpoint associated with the server. For example, the proxy endpoint can be configured to interface with AEGIS software, allowing the software to record transactions and ensure compliance with pertinent standards or regulations. Implementing such a configuration in a production environment would offer the flexibility to switch between standard and proxy modes (associated server) as necessary. Consequently, it is essential to have both standard and proxy endpoints readily available for seamless transitions as required.
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers
    l: base-ext-associatedServers
condition:
  v: ele-1
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: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.extension:access-control-mechanism
path:
  v: Endpoint.extension
slice name:
  v: access-control-mechanism
short:
  v: Access control mechanisms are designed to protect and manage access to healthcare endpoints, ensuring that data exchange between systems adheres to specific security protocols when needed.
definition:
  v: Endpoint access control mechanisms protect and manage access to healthcare endpoints, ensuring secure data exchange between systems. They standardize methods to secure endpoints, ensuring interoperability and security. In certain use cases requiring system scalability and flexibility, different profiles may be utilized based on the chosen access control mechanism. For example, the Unified Data Access Profile (UDAP) uses JWT access tokens.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism
    l: base-ext-endpointAccessControlMechanism
condition:
  v: ele-1
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: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.extension:endpoint-rank
path:
  v: Endpoint.extension
slice name:
  v: endpoint-rank
short:
  v: Preferred order for connecting to the endpoint
definition:
  v: Order established by a Role, Organization… for Endpoints capable of transferring the same content
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank
    l: base-ext-endpoint-rank
condition:
  v: ele-1
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: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.extension:ihe-specific-connection-type
path:
  v: Endpoint.extension
slice name:
  v: ihe-specific-connection-type
short:
  v: IHE Specific Connection Type
definition:
  v: Endpoint IHE Specific Connection Type. This is to be used when the connectionType cannot be used. Such as when the endpoint support is more specific than a code in the connectionType ValueSet.
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type
    l: base-ext-endpoint-ihe-specific-connection-type
condition:
  v: ele-1
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: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.extension:verification-status
path:
  v: Endpoint.extension
slice name:
  v: verification-status
short:
  v: Verification Status
definition:
  v: Indicates a resource instance verification status
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
    l: base-ext-verification-status
condition:
  v: ele-1
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: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.extension:testing-certification
path:
  v: Endpoint.extension
slice name:
  v: testing-certification
short:
  v: Endpoint Testing Certification
definition:
  v: An extension for endpoint testing certification
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification
    l: base-ext-endpoint-testing-certification
condition:
  v: ele-1
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: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.extension:environmentType
path:
  v: Endpoint.extension
slice name:
  v: environmentType
short:
  v: The type of environment exposed at this endpoint
definition:
  v: Endpoint Environment Type
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-environment-type
    l: base-ext-endpoint-environment-type
condition:
  v: ele-1
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: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

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.
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
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: ndh-to-plannet-endpoint
  map:
    v: Endpoint.identifier
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.identifier
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Endpoint.identifier.id
path:
  v: Endpoint.identifier.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Endpoint.identifier.extension
path:
  v: Endpoint.identifier.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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 element. 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: Element.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.identifier.extension:identifier-status
path:
  v: Endpoint.identifier.extension
slice name:
  v: identifier-status
short:
  v: NDH Identifier Status
definition:
  v: Describes the status of an identifier
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
    l: base-ext-identifier-status
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: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.identifier.use
path:
  v: Endpoint.identifier.use
short:
  v: usual | official | temp | secondary | old (If known)
definition:
  v: The purpose of this identifier.
comment:
  v: Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
requirements:
  v: Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.use
  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: true
is modifier reason:
  v: This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: IdentifierUse
  strength:
    v: required
  description:
    v: Identifies the purpose for this identifier, if known .
  value set:
    v: http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    l: http://hl7.org/fhir/ValueSet/identifier-use
mapping:
  identity:
    v: v2
  map:
    v: N/A
mapping:
  identity:
    v: rim
  map:
    v: Role.code or implied by context

id:
  v: Endpoint.identifier.type
path:
  v: Endpoint.identifier.type
short:
  v: Description of identifier
definition:
  v: A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
comment:
  v: This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
requirements:
  v: Allows users to make use of identifiers when the identifier system is not known.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.type
  min:
    v: 0
  max:
    v: 1
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: IdentifierType
  strength:
    v: extensible
  description:
    v: A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
  value set:
    v: http://hl7.org/fhir/ValueSet/identifier-type|4.0.1
    l: http://hl7.org/fhir/ValueSet/identifier-type
mapping:
  identity:
    v: v2
  map:
    v: CX.5
mapping:
  identity:
    v: rim
  map:
    v: Role.code or implied by context

id:
  v: Endpoint.identifier.system
path:
  v: Endpoint.identifier.system
short:
  v: The namespace for the identifier value
definition:
  v: Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
comment:
  v: Identifier.system is always case sensitive.
requirements:
  v: There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.system
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
example:
  label:
    v: General
  value: Uri
    v: http://www.acme.com/identifiers/patient
    l: patient
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: v2
  map:
    v: CX.4 / EI-2-4
mapping:
  identity:
    v: rim
  map:
    v: II.root or Role.id.root
mapping:
  identity:
    v: servd
  map:
    v: ./IdentifierType

id:
  v: Endpoint.identifier.value
path:
  v: Endpoint.identifier.value
short:
  v: The value that is unique
definition:
  v: The portion of the identifier typically relevant to the user and which is unique within the context of the system.
comment:
  v: If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: General
  value: String
    v: 123456
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: v2
  map:
    v: CX.1 / EI.1
mapping:
  identity:
    v: rim
  map:
    v: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
mapping:
  identity:
    v: servd
  map:
    v: ./Value

id:
  v: Endpoint.identifier.period
path:
  v: Endpoint.identifier.period
short:
  v: Time period when id is/was valid for use
definition:
  v: Time period during which identifier is/was valid for use.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.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: v2
  map:
    v: CX.7 + CX.8
mapping:
  identity:
    v: rim
  map:
    v: Role.effectiveTime or implied by context
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

id:
  v: Endpoint.identifier.assigner
path:
  v: Endpoint.identifier.assigner
short:
  v: Organization that issued id (may be just text)
definition:
  v: Organization that issued/manages the identifier.
comment:
  v: The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.assigner
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization
    l: ndh-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: ndh-to-plannet-endpoint
  map:
    v: Endpoint.identifier.assigner
  comment:
    v: , using NDH Organization Porfile
mapping:
  identity:
    v: v2
  map:
    v: CX.4 / (CX.4,CX.9,CX.10)
mapping:
  identity:
    v: rim
  map:
    v: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
mapping:
  identity:
    v: servd
  map:
    v: ./IdentifierIssuingAuthority

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
fixed: Code
  v: active
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
must support:
  v: true
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: 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
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
binding:
  strength:
    v: extensible
  value set:
    v: http://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS
    l: EndpointConnectionTypeVS
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
must support:
  v: true
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 organization is hosting this in the cloud, it is the organization associated with the data).
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.
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/us/ndh/StructureDefinition/ndh-Organization
    l: ndh-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
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: ndh-to-plannet-endpoint
  map:
    v: Endpoint.managingOrganization
  comment:
    v: , using NDH Organization Profile
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.contact.id
path:
  v: Endpoint.contact.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Endpoint.contact.extension
path:
  v: Endpoint.contact.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
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 element. 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: Element.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.contact.extension:contactpoint-availabletime
path:
  v: Endpoint.contact.extension
slice name:
  v: contactpoint-availabletime
short:
  v: NDH Contact Point Available Time
definition:
  v: An extension representing the days and times a contact point is available
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
    l: base-ext-contactpoint-availabletime
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: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.contact.extension:via-intermediary
path:
  v: Endpoint.contact.extension
slice name:
  v: via-intermediary
short:
  v: Via Intermediary
definition:
  v: A reference to an alternative point of contact (NdhPractitionerRole, NdhOrganization, NdhOrganizationAffiliation, or NdhLocation) for this organization
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
    l: base-ext-via-intermediary
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: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.contact.system
path:
  v: Endpoint.contact.system
short:
  v: phone | fax | email | pager | url | sms | other
definition:
  v: Telecommunications form for contact point - what communications system is required to make use of the contact.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ContactPoint.system
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
condition:
  v: cpt-2
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: ContactPointSystem
  strength:
    v: required
  description:
    v: Telecommunications form for contact point.
  value set:
    v: http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
    l: http://hl7.org/fhir/ValueSet/contact-point-system
mapping:
  identity:
    v: ndh-to-plannet-endpoint
  map:
    v: Endpoint.contact.system
mapping:
  identity:
    v: v2
  map:
    v: XTN.3
mapping:
  identity:
    v: rim
  map:
    v: ./scheme
mapping:
  identity:
    v: servd
  map:
    v: ./ContactPointType

id:
  v: Endpoint.contact.value
path:
  v: Endpoint.contact.value
short:
  v: The actual contact point details
definition:
  v: The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
comment:
  v: Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
requirements:
  v: Need to support legacy numbers that are not in a tightly controlled format.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ContactPoint.value
  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: ndh-to-plannet-endpoint
  map:
    v: Endpoint.contact.value
mapping:
  identity:
    v: v2
  map:
    v: XTN.1 (or XTN.12)
mapping:
  identity:
    v: rim
  map:
    v: ./url
mapping:
  identity:
    v: servd
  map:
    v: ./Value

id:
  v: Endpoint.contact.use
path:
  v: Endpoint.contact.use
short:
  v: home | work | temp | old | mobile - purpose of this contact point
definition:
  v: Identifies the purpose for the contact point.
comment:
  v: Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
requirements:
  v: Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ContactPoint.use
  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: true
is modifier reason:
  v: This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ContactPointUse
  strength:
    v: required
  description:
    v: Use of contact point.
  value set:
    v: http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
    l: http://hl7.org/fhir/ValueSet/contact-point-use
mapping:
  identity:
    v: v2
  map:
    v: XTN.2 - but often indicated by field
mapping:
  identity:
    v: rim
  map:
    v: unique(./use)
mapping:
  identity:
    v: servd
  map:
    v: ./ContactPointPurpose

id:
  v: Endpoint.contact.rank
path:
  v: Endpoint.contact.rank
short:
  v: Specify preferred order of use (1 = highest)
definition:
  v: Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
comment:
  v: Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ContactPoint.rank
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: positiveInt
    l: positiveInt
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: v2
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Endpoint.contact.period
path:
  v: Endpoint.contact.period
short:
  v: Time period when the contact point was/is in use
definition:
  v: Time period when the contact point was/is in use.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ContactPoint.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: v2
  map:
    v: N/A
mapping:
  identity:
    v: rim
  map:
    v: ./usablePeriod[type="IVL<TS>"]
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

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
short:
  v: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
definition:
  v: 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: 1
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: extensible
  value set:
    v: http://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS
    l: EndpointPayloadTypeVS
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: 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
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS
    l: EndpointFhirMimeTypeVS
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.
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
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
  mapping:
    identity:
      v: ndh-to-plannet-endpoint
    map:
      v: Endpoint
    comment:
      v: Top-level mapping from NDH to Plan-Net
element:
  id:
    v: Endpoint.meta.lastUpdated
  path:
    v: Endpoint.meta.lastUpdated
  min:
    v: 1
  mapping:
    identity:
      v: ndh-to-plannet-endpoint
    map:
      v: Endpoint.meta.lastUpdated
    comment:
      v: , is required in NDH
element:
  id:
    v: Endpoint.extension
  path:
    v: Endpoint.extension
  slicing:
    discriminator:
      type:
        v: value
      path:
        v: url
    ordered:
      v: false
    rules:
      v: open
element:
  id:
    v: Endpoint.extension:implementation-guide
  path:
    v: Endpoint.extension
  slice name:
    v: implementation-guide
  short:
    v: Implementation guide supported
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide
      l: base-ext-implementation-guide
  mapping:
    identity:
      v: ndh-to-plannet-endpoint
    map:
      v: Not in Plan-Net
    comment:
      v: , NDH-specific
element:
  id:
    v: Endpoint.extension:secure-exchange-artifacts
  path:
    v: Endpoint.extension
  slice name:
    v: secure-exchange-artifacts
  short:
    v: Secure Exchange Artifacts store information about the type of public certificate, the certificate itself, and its expiration date. Issued by Certificate Authorities, public certificates are meant for sharing and verification in digital communications. Each certificate includes an expiration date, essential for validating its current validity and maintaining security. This extension is used when the exchange standard requires the discovery of the public key.
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts
      l: base-ext-secureExchangeArtifacts
  mapping:
    identity:
      v: ndh-to-plannet-endpoint
    map:
      v: Not in Plan-Net
    comment:
      v: , NDH-specific
element:
  id:
    v: Endpoint.extension:security-details
  path:
    v: Endpoint.extension
  slice name:
    v: security-details
  short:
    v: Security details for an endpoint, including trust framework information, signed artifacts, and public certificates.
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details
      l: base-ext-security-details
  mapping:
    identity:
      v: ndh-to-plannet-endpoint
    map:
      v: Not in Plan-Net
    comment:
      v: , NDH-specific
element:
  id:
    v: Endpoint.extension:dynamic-registration
  path:
    v: Endpoint.extension
  slice name:
    v: dynamic-registration
  short:
    v: Dynamic registration within a trust framework refers to a process where clients can register with a server or service provider dynamically and securely at runtime, rather than being pre-registered manually. This approach is often used in environments where scalability, flexibility, and security are crucial. Currently, dynamic registration is used in SMART and UDAP.
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration
      l: base-ext-dynamicRegistration
  mapping:
    identity:
      v: ndh-to-plannet-endpoint
    map:
      v: Not in Plan-Net
    comment:
      v: , NDH-specific
element:
  id:
    v: Endpoint.extension:associated-servers
  path:
    v: Endpoint.extension
  slice name:
    v: associated-servers
  short:
    v: Store information about servers that may be associated with the current endpoint. It defines a set of servers that could be linked to this endpoint. If a server is associated, its type and URL will be included
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers
      l: base-ext-associatedServers
  mapping:
    identity:
      v: ndh-to-plannet-endpoint
    map:
      v: Not in Plan-Net
    comment:
      v: , NDH-specific
element:
  id:
    v: Endpoint.extension:access-control-mechanism
  path:
    v: Endpoint.extension
  slice name:
    v: access-control-mechanism
  short:
    v: Access control mechanisms are designed to protect and manage access to healthcare endpoints, ensuring that data exchange between systems adheres to specific security protocols when needed.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism
      l: base-ext-endpointAccessControlMechanism
  mapping:
    identity:
      v: ndh-to-plannet-endpoint
    map:
      v: Not in Plan-Net
    comment:
      v: , NDH-specific

id:
  v: Endpoint.extension:endpoint-rank
path:
  v: Endpoint.extension
slice name:
  v: endpoint-rank
short:
  v: Preferred order for connecting to the endpoint
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank
    l: base-ext-endpoint-rank
mapping:
  identity:
    v: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.extension:ihe-specific-connection-type
path:
  v: Endpoint.extension
slice name:
  v: ihe-specific-connection-type
short:
  v: IHE Specific Connection Type
min:
  v: 0
max:
  v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type
    l: base-ext-endpoint-ihe-specific-connection-type
mapping:
  identity:
    v: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.extension:verification-status
path:
  v: Endpoint.extension
slice name:
  v: verification-status
short:
  v: Verification Status
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
    l: base-ext-verification-status
mapping:
  identity:
    v: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.extension:testing-certification
path:
  v: Endpoint.extension
slice name:
  v: testing-certification
short:
  v: Endpoint Testing Certification
min:
  v: 0
max:
  v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification
    l: base-ext-endpoint-testing-certification
mapping:
  identity:
    v: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.extension:environmentType
path:
  v: Endpoint.extension
slice name:
  v: environmentType
short:
  v: The type of environment exposed at this endpoint
min:
  v: 0
max:
  v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-environment-type
    l: base-ext-endpoint-environment-type
mapping:
  identity:
    v: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.identifier
path:
  v: Endpoint.identifier
must support:
  v: true
mapping:
  identity:
    v: ndh-to-plannet-endpoint
  map:
    v: Endpoint.identifier

id:
  v: Endpoint.identifier.extension:identifier-status
path:
  v: Endpoint.identifier.extension
slice name:
  v: identifier-status
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
    l: base-ext-identifier-status
mapping:
  identity:
    v: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.identifier.assigner
path:
  v: Endpoint.identifier.assigner
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization
    l: ndh-Organization
mapping:
  identity:
    v: ndh-to-plannet-endpoint
  map:
    v: Endpoint.identifier.assigner
  comment:
    v: , using NDH Organization Porfile

id:
  v: Endpoint.status
path:
  v: Endpoint.status
fixed: Code
  v: active
must support:
  v: true

id:
  v: Endpoint.connectionType
path:
  v: Endpoint.connectionType
must support:
  v: true
binding:
  strength:
    v: extensible
  value set:
    v: http://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS
    l: EndpointConnectionTypeVS

id:
  v: Endpoint.name
path:
  v: Endpoint.name
must support:
  v: true

id:
  v: Endpoint.managingOrganization
path:
  v: Endpoint.managingOrganization
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization
    l: ndh-Organization
must support:
  v: true
mapping:
  identity:
    v: ndh-to-plannet-endpoint
  map:
    v: Endpoint.managingOrganization
  comment:
    v: , using NDH Organization Profile

id:
  v: Endpoint.contact.extension:contactpoint-availabletime
path:
  v: Endpoint.contact.extension
slice name:
  v: contactpoint-availabletime
min:
  v: 0
max:
  v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
    l: base-ext-contactpoint-availabletime
mapping:
  identity:
    v: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.contact.extension:via-intermediary
path:
  v: Endpoint.contact.extension
slice name:
  v: via-intermediary
short:
  v: Via Intermediary
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
    l: base-ext-via-intermediary
mapping:
  identity:
    v: ndh-to-plannet-endpoint
  map:
    v: Not in Plan-Net
  comment:
    v: , NDH-specific

id:
  v: Endpoint.contact.system
path:
  v: Endpoint.contact.system
mapping:
  identity:
    v: ndh-to-plannet-endpoint
  map:
    v: Endpoint.contact.system

id:
  v: Endpoint.contact.value
path:
  v: Endpoint.contact.value
mapping:
  identity:
    v: ndh-to-plannet-endpoint
  map:
    v: Endpoint.contact.value

id:
  v: Endpoint.payloadType
path:
  v: Endpoint.payloadType
max:
  v: 1
binding:
  strength:
    v: extensible
  value set:
    v: http://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS
    l: EndpointPayloadTypeVS

id:
  v: Endpoint.payloadMimeType
path:
  v: Endpoint.payloadMimeType
must support:
  v: true
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS
    l: EndpointFhirMimeTypeVS