Da Vinci Payer Data Exchange
2.1.0 - STU2 United States of America flag

Da Vinci Payer Data Exchange, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-epdx/ and changes regularly. See the Directory of published versions

Resource Profile: MtlsEndpoint - Detailed Descriptions

Active as of 2024-04-12

Definitions for the mtls-endpoint resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Endpoint
2. Endpoint.extension
Control1..?
SlicingThis element introduces a set of slices on Endpoint.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Endpoint.extension:endpoint-usecase
    Slice Nameendpoint-usecase
    ShortEndpoint Usecase
    Control0..*
    TypeExtension(NDH Endpoint Usecase) (Complex Extension)
    6. Endpoint.extension:fhir-ig
    Slice Namefhir-ig
    ShortIGs supported
    Control0..*
    TypeExtension(NDH FHIR IG) (Complex Extension)
    8. Endpoint.extension:secure-exchange-artifacts
    Slice Namesecure-exchange-artifacts
    ShortSecure Exchange Artifacts
    Control0..*
    TypeExtension(NDH Secure Exchange Artifacts) (Complex Extension)
    10. Endpoint.extension:trust-framework
    Slice Nametrust-framework
    ShortTrust Framework
    Control0..*
    TypeExtension(NDH Trust Framework) (Complex Extension)
    12. Endpoint.extension:dynamic-registration
    Slice Namedynamic-registration
    ShortDynamic Registration
    Control0..*
    TypeExtension(NDH Dynamic Registration) (Complex Extension)
    14. Endpoint.extension:associated-servers
    Slice Nameassociated-servers
    ShortAssociated Servers
    Control0..*
    TypeExtension(NDH Associated Servers) (Complex Extension)
    16. Endpoint.extension:access-control-mechanism
    Slice Nameaccess-control-mechanism
    ShortAccess Control Mechanism
    Control0..1
    TypeExtension(NDH Endpoint Access Control Mechanism) (Extension Type: CodeableConcept)
    18. Endpoint.extension:connection-type-version
    Slice Nameconnection-type-version
    ShortConnection Type Version
    Control0..*
    TypeExtension(NDH Endpoint Connection Type Version) (Extension Type: CodeableConcept)
    20. Endpoint.extension:endpoint-rank
    Slice Nameendpoint-rank
    ShortPreferred order for connecting to the endpoint
    Control0..1
    TypeExtension(NDH Endpoint Rank) (Extension Type: positiveInt)
    22. Endpoint.extension:verification-status
    Slice Nameverification-status
    ShortVerification Status
    Control0..1
    TypeExtension(NDH Verification Status) (Extension Type: CodeableConcept)
    24. Endpoint.extension:pdex-mtls-signedobject-extension
    Slice Namepdex-mtls-signedobject-extension
    Control1..*
    TypeExtension(mTLS Signed Object) (Complex Extension)
    Must Supporttrue
    26. Endpoint.identifier
    ShortUnique identifier for Payer
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Must Supporttrue
    28. Endpoint.identifier.extension:identifier-status
    Slice Nameidentifier-status
    Control0..1
    TypeExtension(NDH Identifier Status) (Extension Type: code)
    30. Endpoint.identifier.assigner
    TypeReference(mTLS Organization)
    32. Endpoint.status
    Must Supporttrue
    Fixed Valueactive
    34. Endpoint.connectionType
    BindingUnless not suitable, these codes SHALL be taken from Endpoint Connection Types Value Set
    (extensible to http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointConnectionTypeVS)
    Must Supporttrue
    36. Endpoint.name
    ShortPayer-Payer Exchange
    Must Supporttrue
    38. Endpoint.managingOrganization
    TypeReference(mTLS Organization)
    Must Supporttrue
    40. Endpoint.contact
    42. Endpoint.contact.extension:contactpoint-availabletime
    Slice Namecontactpoint-availabletime
    Control0..*
    TypeExtension(NDH Contactpoint Availabletime) (Complex Extension)
    44. Endpoint.payloadType
    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from Endpoint Payload Type Value Set
    (extensible to http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointPayloadTypeVS)
    46. Endpoint.payloadMimeType
    BindingThe codes SHALL be taken from Endpoint FHIR Mimetype Value Set
    (required to http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointFhirMimeTypeVS)
    Must Supporttrue

    Guidance on how to interpret the contents of this table can be found here

    0. Endpoint
    Definition

    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.

    ShortThe technical details of an endpoint that can be used for electronic services
    Control0..*
    Is Modifierfalse
    Summaryfalse
    Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
    dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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())
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
    dom-6: A resource should have narrative for robust management (text.`div`.exists())
    2. Endpoint.implicitRules
    Definition

    A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

    ShortA set of rules under which this content was created
    Comments

    Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

    Control0..1
    Typeuri
    Is Modifiertrue because 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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    4. Endpoint.extension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortExtensionAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control10..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on Endpoint.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 6. Endpoint.extension:endpoint-usecase
      Slice Nameendpoint-usecase
      Definition

      EndpointUseCase is an enumeration of the specific use cases (service descriptions) supported by the endpoint

      ShortEndpoint Usecase
      Control0..*
      This element is affected by the following invariants: ele-1
      TypeExtension(NDH Endpoint Usecase) (Complex Extension)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      8. Endpoint.extension:fhir-ig
      Slice Namefhir-ig
      Definition

      FHIR IG

      ShortIGs supported
      Control0..*
      This element is affected by the following invariants: ele-1
      TypeExtension(NDH FHIR IG) (Complex Extension)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      10. Endpoint.extension:secure-exchange-artifacts
      Slice Namesecure-exchange-artifacts
      Definition

      Secure Exchange Artifacts

      ShortSecure Exchange Artifacts
      Control0..*
      This element is affected by the following invariants: ele-1
      TypeExtension(NDH Secure Exchange Artifacts) (Complex Extension)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      12. Endpoint.extension:trust-framework
      Slice Nametrust-framework
      Definition

      Trust Framework

      ShortTrust Framework
      Control0..*
      This element is affected by the following invariants: ele-1
      TypeExtension(NDH Trust Framework) (Complex Extension)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      14. Endpoint.extension:dynamic-registration
      Slice Namedynamic-registration
      Definition

      Dynamic Registration

      ShortDynamic Registration
      Control0..*
      This element is affected by the following invariants: ele-1
      TypeExtension(NDH Dynamic Registration) (Complex Extension)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      16. Endpoint.extension:associated-servers
      Slice Nameassociated-servers
      Definition

      Associated Servers

      ShortAssociated Servers
      Control0..*
      This element is affected by the following invariants: ele-1
      TypeExtension(NDH Associated Servers) (Complex Extension)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      18. Endpoint.extension:access-control-mechanism
      Slice Nameaccess-control-mechanism
      Definition

      Endpoint Access Control Mechanism

      ShortAccess Control Mechanism
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(NDH Endpoint Access Control Mechanism) (Extension Type: CodeableConcept)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      20. Endpoint.extension:connection-type-version
      Slice Nameconnection-type-version
      Definition

      An extension for endpoint connection type version

      ShortConnection Type Version
      Control0..*
      This element is affected by the following invariants: ele-1
      TypeExtension(NDH Endpoint Connection Type Version) (Extension Type: CodeableConcept)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      22. Endpoint.extension:endpoint-rank
      Slice Nameendpoint-rank
      Definition

      Order established by a Role, Organization… for Endpoints capable of transferring the same content

      ShortPreferred order for connecting to the endpoint
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(NDH Endpoint Rank) (Extension Type: positiveInt)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      24. Endpoint.extension:verification-status
      Slice Nameverification-status
      Definition

      Indicates a resource instance verification status

      ShortVerification Status
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(NDH Verification Status) (Extension Type: CodeableConcept)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      26. Endpoint.extension:pdex-mtls-signedobject-extension
      Slice Namepdex-mtls-signedobject-extension
      Definition

      mTLS Endpoint Signed Object Extension

      ShortmTLS Signed Object
      Control1..*
      This element is affected by the following invariants: ele-1
      TypeExtension(mTLS Signed Object) (Complex Extension)
      Is Modifierfalse
      Must Supporttrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      28. Endpoint.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).

      ShortExtensions that cannot be ignored
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
      Summaryfalse
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      30. Endpoint.identifier
      Definition

      Identifier for the organization that is used to identify the endpoint across multiple disparate systems.

      ShortUnique identifier for PayerIdentifies this endpoint across multiple systems
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      TypeIdentifier
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      32. Endpoint.identifier.extension:identifier-status
      Slice Nameidentifier-status
      Definition

      Describes the status of an identifier

      ShortNDH Identifier Status
      Control0..1
      TypeExtension(NDH Identifier Status) (Extension Type: code)
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      34. Endpoint.identifier.use
      Definition

      The purpose of this identifier.

      Shortusual | official | temp | secondary | old (If known)
      Comments

      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

      Control0..1
      BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

      Identifies the purpose for this identifier, if known .

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      36. Endpoint.identifier.assigner
      Definition

      Organization that issued/manages the identifier.

      ShortOrganization that issued id (may be just text)
      Comments

      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.

      Control0..1
      TypeReference(mTLS Organization, Organization)
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      38. Endpoint.status
      Definition

      active | suspended | error | off | test.

      Shortactive | suspended | error | off | entered-in-error | test
      Comments

      This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid.

      Control1..1
      BindingThe codes SHALL be taken from EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1
      (required to http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1)

      The status of the endpoint.

      Typecode
      Is Modifiertrue because 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
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Fixed Valueactive
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      40. Endpoint.connectionType
      Definition

      A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).

      ShortProtocol/Profile/Standard to be used with this endpoint connection
      Comments

      For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example.

      Control1..1
      BindingUnless not suitable, these codes SHALL be taken from Endpoint Connection Types Value Sethttp://hl7.org/fhir/ValueSet/endpoint-connection-type
      (extensible to http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointConnectionTypeVS)
      TypeCoding
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      42. Endpoint.name
      Definition

      A friendly name that this endpoint can be referred to with.

      ShortPayer-Payer ExchangeA name that this endpoint can be identified by
      Control0..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      44. Endpoint.managingOrganization
      Definition

      The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).

      ShortOrganization that manages this endpoint (might not be the organization that exposes the endpoint)
      Comments

      This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an applicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy.

      Control0..1
      TypeReference(mTLS Organization, Organization)
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      46. Endpoint.payloadType
      Definition

      The payload type describes the acceptable content that can be communicated on the endpoint.

      ShortThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
      Comments

      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.

      Control1..1*
      BindingUnless not suitable, these codes SHALL be taken from For example codes, see Endpoint Payload Type Value Sethttp://hl7.org/fhir/ValueSet/endpoint-payload-type
      (extensible to http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointPayloadTypeVS)
      TypeCodeableConcept
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      48. Endpoint.payloadMimeType
      Definition

      The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).

      ShortMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
      Comments

      Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.

      Control0..*
      BindingThe codes SHALL be taken from Endpoint FHIR Mimetype Value Sethttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1
      (required to http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointFhirMimeTypeVS)
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      50. Endpoint.address
      Definition

      The uri that describes the actual end-point to connect to.

      ShortThe technical base address for connecting to this endpoint
      Comments

      For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs)

      This address will be to the service base, without any parameters, or sub-services or resources tacked on.

      E.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs"

      and not "https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...".

      Control1..1
      Typeurl
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

      Guidance on how to interpret the contents of this table can be found here

      0. Endpoint
      Definition

      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.

      ShortThe technical details of an endpoint that can be used for electronic services
      Control0..*
      Is Modifierfalse
      Summaryfalse
      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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())
      dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
      dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
      dom-6: A resource should have narrative for robust management (text.`div`.exists())
      2. Endpoint.id
      Definition

      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      ShortLogical id of this artifact
      Comments

      The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

      Control0..1
      Typeid
      Is Modifierfalse
      Summarytrue
      4. Endpoint.meta
      Definition

      The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

      ShortMetadata about the resource
      Control0..1
      TypeMeta
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. Endpoint.implicitRules
      Definition

      A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

      ShortA set of rules under which this content was created
      Comments

      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

      Control0..1
      Typeuri
      Is Modifiertrue because 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
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. Endpoint.language
      Definition

      The base language in which the resource is written.

      ShortLanguage of the resource content
      Comments

      Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

      Control0..1
      BindingThe codes SHOULD be taken from CommonLanguages
      (preferred to http://hl7.org/fhir/ValueSet/languages)

      A human language.

      Additional BindingsPurpose
      AllLanguagesMax Binding
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. Endpoint.text
      Definition

      A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

      ShortText summary of the resource, for human interpretation
      Comments

      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.

      Control0..1
      TypeNarrative
      Is Modifierfalse
      Summaryfalse
      Alternate Namesnarrative, html, xhtml, display
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      12. Endpoint.contained
      Definition

      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.

      ShortContained, inline Resources
      Comments

      This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

      Control0..*
      TypeResource
      Is Modifierfalse
      Summaryfalse
      Alternate Namesinline resources, anonymous resources, contained resources
      14. Endpoint.extension
      Definition

      An Extension

      ShortExtension
      Control1..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on Endpoint.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 16. Endpoint.extension:endpoint-usecase
        Slice Nameendpoint-usecase
        Definition

        EndpointUseCase is an enumeration of the specific use cases (service descriptions) supported by the endpoint

        ShortEndpoint Usecase
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH Endpoint Usecase) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        18. Endpoint.extension:fhir-ig
        Slice Namefhir-ig
        Definition

        FHIR IG

        ShortIGs supported
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH FHIR IG) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        20. Endpoint.extension:secure-exchange-artifacts
        Slice Namesecure-exchange-artifacts
        Definition

        Secure Exchange Artifacts

        ShortSecure Exchange Artifacts
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH Secure Exchange Artifacts) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        22. Endpoint.extension:trust-framework
        Slice Nametrust-framework
        Definition

        Trust Framework

        ShortTrust Framework
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH Trust Framework) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        24. Endpoint.extension:dynamic-registration
        Slice Namedynamic-registration
        Definition

        Dynamic Registration

        ShortDynamic Registration
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH Dynamic Registration) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        26. Endpoint.extension:associated-servers
        Slice Nameassociated-servers
        Definition

        Associated Servers

        ShortAssociated Servers
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH Associated Servers) (Complex Extension)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        28. Endpoint.extension:access-control-mechanism
        Slice Nameaccess-control-mechanism
        Definition

        Endpoint Access Control Mechanism

        ShortAccess Control Mechanism
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH Endpoint Access Control Mechanism) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        30. Endpoint.extension:connection-type-version
        Slice Nameconnection-type-version
        Definition

        An extension for endpoint connection type version

        ShortConnection Type Version
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH Endpoint Connection Type Version) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        32. Endpoint.extension:endpoint-rank
        Slice Nameendpoint-rank
        Definition

        Order established by a Role, Organization… for Endpoints capable of transferring the same content

        ShortPreferred order for connecting to the endpoint
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH Endpoint Rank) (Extension Type: positiveInt)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        34. Endpoint.extension:verification-status
        Slice Nameverification-status
        Definition

        Indicates a resource instance verification status

        ShortVerification Status
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(NDH Verification Status) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        36. Endpoint.extension:pdex-mtls-signedobject-extension
        Slice Namepdex-mtls-signedobject-extension
        Definition

        mTLS Endpoint Signed Object Extension

        ShortmTLS Signed Object
        Control1..*
        This element is affected by the following invariants: ele-1
        TypeExtension(mTLS Signed Object) (Complex Extension)
        Is Modifierfalse
        Must Supporttrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        38. Endpoint.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).

        ShortExtensions that cannot be ignored
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
        Summaryfalse
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        40. Endpoint.identifier
        Definition

        Identifier for the organization that is used to identify the endpoint across multiple disparate systems.

        ShortUnique identifier for Payer
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..*
        TypeIdentifier
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        42. Endpoint.identifier.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        44. Endpoint.identifier.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.

        ShortAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on Endpoint.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 46. Endpoint.identifier.extension:identifier-status
          Slice Nameidentifier-status
          Definition

          Describes the status of an identifier

          ShortNDH Identifier Status
          Control0..1
          TypeExtension(NDH Identifier Status) (Extension Type: code)
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          48. Endpoint.identifier.use
          Definition

          The purpose of this identifier.

          Shortusual | official | temp | secondary | old (If known)
          Comments

          Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

          Control0..1
          BindingThe codes SHALL be taken from IdentifierUse
          (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

          Identifies the purpose for this identifier, if known .

          Typecode
          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          50. Endpoint.identifier.type
          Definition

          A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

          ShortDescription of identifier
          Comments

          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.

          Control0..1
          BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
          (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

          A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

          TypeCodeableConcept
          Is Modifierfalse
          Summarytrue
          Requirements

          Allows users to make use of identifiers when the identifier system is not known.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          52. Endpoint.identifier.system
          Definition

          Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

          ShortThe namespace for the identifier value
          Comments

          Identifier.system is always case sensitive.

          Control0..1
          Typeuri
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          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.

          Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          54. Endpoint.identifier.value
          Definition

          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

          ShortThe value that is unique
          Comments

          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. 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.

          Control0..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Example<br/><b>General</b>:123456
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          56. Endpoint.identifier.period
          Definition

          Time period during which identifier is/was valid for use.

          ShortTime period when id is/was valid for use
          Control0..1
          TypePeriod
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          58. Endpoint.identifier.assigner
          Definition

          Organization that issued/manages the identifier.

          ShortOrganization that issued id (may be just text)
          Comments

          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.

          Control0..1
          TypeReference(mTLS Organization)
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          60. Endpoint.status
          Definition

          active | suspended | error | off | test.

          Shortactive | suspended | error | off | entered-in-error | test
          Comments

          This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid.

          Control1..1
          BindingThe codes SHALL be taken from EndpointStatus
          (required to http://hl7.org/fhir/ValueSet/endpoint-status|4.0.1)

          The status of the endpoint.

          Typecode
          Is Modifiertrue because 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
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Fixed Valueactive
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          62. Endpoint.connectionType
          Definition

          A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).

          ShortProtocol/Profile/Standard to be used with this endpoint connection
          Comments

          For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example.

          Control1..1
          BindingUnless not suitable, these codes SHALL be taken from Endpoint Connection Types Value Set
          (extensible to http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointConnectionTypeVS)
          TypeCoding
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          64. Endpoint.name
          Definition

          A friendly name that this endpoint can be referred to with.

          ShortPayer-Payer Exchange
          Control0..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          66. Endpoint.managingOrganization
          Definition

          The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).

          ShortOrganization that manages this endpoint (might not be the organization that exposes the endpoint)
          Comments

          This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an applicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy.

          Control0..1
          TypeReference(mTLS Organization)
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          68. Endpoint.contact
          Definition

          Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.

          ShortContact details for source (e.g. troubleshooting)
          Control0..*
          TypeContactPoint
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          70. Endpoint.contact.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          72. Endpoint.contact.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on Endpoint.contact.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 74. Endpoint.contact.extension:contactpoint-availabletime
            Slice Namecontactpoint-availabletime
            Definition

            An extension representing the days and times a contact point is available

            ShortNDH Contactpoint Availabletime
            Control0..*
            TypeExtension(NDH Contactpoint Availabletime) (Complex Extension)
            Is Modifierfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            76. Endpoint.contact.system
            Definition

            Telecommunications form for contact point - what communications system is required to make use of the contact.

            Shortphone | fax | email | pager | url | sms | other
            Control0..1
            This element is affected by the following invariants: cpt-2
            BindingThe codes SHALL be taken from ContactPointSystem
            (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

            Telecommunications form for contact point.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            78. Endpoint.contact.value
            Definition

            The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

            ShortThe actual contact point details
            Comments

            Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Need to support legacy numbers that are not in a tightly controlled format.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            80. Endpoint.contact.use
            Definition

            Identifies the purpose for the contact point.

            Shorthome | work | temp | old | mobile - purpose of this contact point
            Comments

            Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

            Control0..1
            BindingThe codes SHALL be taken from ContactPointUse
            (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

            Use of contact point.

            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            82. Endpoint.contact.rank
            Definition

            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.

            ShortSpecify preferred order of use (1 = highest)
            Comments

            Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

            Control0..1
            TypepositiveInt
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            84. Endpoint.contact.period
            Definition

            Time period when the contact point was/is in use.

            ShortTime period when the contact point was/is in use
            Control0..1
            TypePeriod
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            86. Endpoint.period
            Definition

            The interval during which the endpoint is expected to be operational.

            ShortInterval the endpoint is expected to be operational
            Control0..1
            TypePeriod
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            88. Endpoint.payloadType
            Definition

            The payload type describes the acceptable content that can be communicated on the endpoint.

            ShortThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
            Comments

            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.

            Control1..1
            BindingUnless not suitable, these codes SHALL be taken from Endpoint Payload Type Value Set
            (extensible to http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointPayloadTypeVS)
            TypeCodeableConcept
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            90. Endpoint.payloadMimeType
            Definition

            The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).

            ShortMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
            Comments

            Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.

            Control0..*
            BindingThe codes SHALL be taken from Endpoint FHIR Mimetype Value Set
            (required to http://hl7.org/fhir/us/davinci-pdex/ValueSet/EndpointFhirMimeTypeVS)
            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            92. Endpoint.address
            Definition

            The uri that describes the actual end-point to connect to.

            ShortThe technical base address for connecting to this endpoint
            Comments

            For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs)

            This address will be to the service base, without any parameters, or sub-services or resources tacked on.

            E.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs"

            and not "https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...".

            Control1..1
            Typeurl
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            94. Endpoint.header
            Definition

            Additional headers / information to send as part of the notification.

            ShortUsage depends on the channel type
            Comments

            Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.

            Control0..*
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))