National Directory of Healthcare Providers & Services (NDH) Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 2.0.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ndh/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details | Version: 2.0.0-current | ||||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: SecurityDetails | |||
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).
Context of Use
This extension may be used on the following element(s)
Endpoint
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Extension | NDH Security Details | |
![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 1..1 | Extension | Trust Framework Type |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "trustFrameworkType" | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: Trust Framework Type Value Set (extensible) | |
![]() ![]() ![]() |
S | 0..1 | Extension | A qualifier associates with an endpoint to provide additional context or information about that endpoint in a trust framework community. Qualifiers are used to help other members of the community understand the capabilities, compliance status, or other relevant characteristics of an endpoint. |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "qualifier" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | By utilizing a signed artifact, you can identify which Certificate Authority has issued the certificate for the entity that signed the artifact. Verifying the issuing Certificate Authority is crucial because it adds an additional layer of trust and security, ensuring that the entity involved in the data exchange is legitimate and that their digital identity has been properly validated. | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "signedArtifact" | |
![]() ![]() ![]() ![]() |
1..1 | base64Binary | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Public certificates help in affirming that an entity is indeed who they claim to be. These certificates are used to establish secure connections via the Mutual TLS (Transport Layer Security) protocol. Public certificates issued by Certificate Authorities are fundamental in establishing a secure and trustworthy digital environment. They enable secure communication, ensure data integrity, and facilitate authentication and trust across a wide range of online interactions. | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "publicCertificate" | |
![]() ![]() ![]() ![]() |
1..1 | base64Binary | Value of extension | |
![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details" | |
![]() ![]() |
0..0 | Value of extension | ||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.extension:trustFrameworkType.value[x] | Base | extensible | Trust Framework Type Value Set | 📦2.0.0-current | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Extension | NDH Security Details | |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 1..1 | Extension | Trust Framework Type |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "trustFrameworkType" | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: Trust Framework Type Value Set (extensible) | |
![]() ![]() ![]() |
S | 0..1 | Extension | A qualifier associates with an endpoint to provide additional context or information about that endpoint in a trust framework community.
Qualifiers are used to help other members of the community understand the capabilities, compliance status, or other relevant characteristics of an endpoint. |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "qualifier" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | By utilizing a signed artifact, you can identify which Certificate Authority has issued the certificate for the entity that
signed the artifact. Verifying the issuing Certificate Authority is crucial because it adds an additional layer of trust and security, ensuring that the entity involved
in the data exchange is legitimate and that their digital identity has been properly validated. | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "signedArtifact" | |
![]() ![]() ![]() ![]() |
1..1 | base64Binary | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Public certificates help in affirming that an entity is indeed who they claim to be. These certificates are used to establish
secure connections via the Mutual TLS (Transport Layer Security) protocol. Public certificates issued by Certificate Authorities are fundamental in establishing a
secure and trustworthy digital environment. They enable secure communication, ensure data integrity, and facilitate authentication and trust across a wide range of
online interactions. | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "publicCertificate" | |
![]() ![]() ![]() ![]() |
1..1 | base64Binary | Value of extension | |
![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details" | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.extension:trustFrameworkType.value[x] | Base | extensible | Trust Framework Type Value Set | 📦2.0.0-current | This IG |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Summary
Complex Extension: 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).
Maturity: 4
Differential ViewDifferential View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Extension | NDH Security Details | |
![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 1..1 | Extension | Trust Framework Type |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "trustFrameworkType" | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: Trust Framework Type Value Set (extensible) | |
![]() ![]() ![]() |
S | 0..1 | Extension | A qualifier associates with an endpoint to provide additional context or information about that endpoint in a trust framework community. Qualifiers are used to help other members of the community understand the capabilities, compliance status, or other relevant characteristics of an endpoint. |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "qualifier" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | By utilizing a signed artifact, you can identify which Certificate Authority has issued the certificate for the entity that signed the artifact. Verifying the issuing Certificate Authority is crucial because it adds an additional layer of trust and security, ensuring that the entity involved in the data exchange is legitimate and that their digital identity has been properly validated. | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "signedArtifact" | |
![]() ![]() ![]() ![]() |
1..1 | base64Binary | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Public certificates help in affirming that an entity is indeed who they claim to be. These certificates are used to establish secure connections via the Mutual TLS (Transport Layer Security) protocol. Public certificates issued by Certificate Authorities are fundamental in establishing a secure and trustworthy digital environment. They enable secure communication, ensure data integrity, and facilitate authentication and trust across a wide range of online interactions. | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "publicCertificate" | |
![]() ![]() ![]() ![]() |
1..1 | base64Binary | Value of extension | |
![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details" | |
![]() ![]() |
0..0 | Value of extension | ||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.extension:trustFrameworkType.value[x] | Base | extensible | Trust Framework Type Value Set | 📦2.0.0-current | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Extension | NDH Security Details | |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 1..1 | Extension | Trust Framework Type |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "trustFrameworkType" | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: Trust Framework Type Value Set (extensible) | |
![]() ![]() ![]() |
S | 0..1 | Extension | A qualifier associates with an endpoint to provide additional context or information about that endpoint in a trust framework community.
Qualifiers are used to help other members of the community understand the capabilities, compliance status, or other relevant characteristics of an endpoint. |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "qualifier" | |
![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | By utilizing a signed artifact, you can identify which Certificate Authority has issued the certificate for the entity that
signed the artifact. Verifying the issuing Certificate Authority is crucial because it adds an additional layer of trust and security, ensuring that the entity involved
in the data exchange is legitimate and that their digital identity has been properly validated. | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "signedArtifact" | |
![]() ![]() ![]() ![]() |
1..1 | base64Binary | Value of extension | |
![]() ![]() ![]() |
0..1 | Extension | Public certificates help in affirming that an entity is indeed who they claim to be. These certificates are used to establish
secure connections via the Mutual TLS (Transport Layer Security) protocol. Public certificates issued by Certificate Authorities are fundamental in establishing a
secure and trustworthy digital environment. They enable secure communication, ensure data integrity, and facilitate authentication and trust across a wide range of
online interactions. | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "publicCertificate" | |
![]() ![]() ![]() ![]() |
1..1 | base64Binary | Value of extension | |
![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details" | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.extension:trustFrameworkType.value[x] | Base | extensible | Trust Framework Type Value Set | 📦2.0.0-current | This IG |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Summary
Complex Extension: 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).
Maturity: 4
Other representations of profile: CSV, Excel, Schematron