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 1.0.0 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/ndh-ndapi-Endpoint | Version: 1.0.0 | |||
Standards status: Trial-use | Computable Name: NdhNdApiEndpoint |
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | NdhEndpoint | The technical details of an endpoint that can be used for electronic services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..1 | instant | When the resource version last changed ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Endpoint Usecase URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..* | (Complex) | Non FHIR Endpoint Usecase URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-non-fhir-usecase ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH FHIR IG URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Secure Exchange Artifacts URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Trust Framework URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Dynamic Registration URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Associated Servers URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | NDH Endpoint Access Control Mechanism URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism Binding: Endpoint Access Control Mechanism Value Set (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | NDH Endpoint Connection Type Version URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version Binding: FHIRVersion (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | NDH Endpoint Rank URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | IHE Specific Connection Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type Binding: Endpoint IHE Specific Connection Types Value Set (preferred) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..* | (Complex) | Endpoint Testing Certification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The type of environment exposed at this endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-environment-type Binding: NDH Endpoint Environment Value Set (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(National Directory API Organization Profile) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. ele-1: All FHIR elements must have a @value or children Fixed Value: active |
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | string | A name that this endpoint can be identified by ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(National Directory API Organization Profile) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when the contact point was/is in use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Period | Interval the endpoint is expected to be operational ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Value Set (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Endpoint FHIR Mimetype Value Set (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | url | The technical base address for connecting to this endpoint ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | string | Usage depends on the channel type ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet / Code | URI |
Endpoint.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Endpoint.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Endpoint.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 from the FHIR Standard | |
Endpoint.connectionType | extensible | EndpointConnectionTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS from this IG | |
Endpoint.contact.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Endpoint.contact.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Endpoint.payloadType | extensible | EndpointPayloadTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS from this IG | |
Endpoint.payloadMimeType | required | EndpointFhirMimeTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS from this IG |
This structure is derived from NdhEndpoint
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
NdhEndpoint | |||
![]() ![]() ![]() |
S | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..* | EndpointUsecase | NDH Endpoint Usecase |
![]() ![]() ![]() ![]() |
S | 0..* | FhirIg | NDH FHIR IG |
![]() ![]() ![]() ![]() |
S | 0..* | SecureExchangeArtifacts | NDH Secure Exchange Artifacts |
![]() ![]() ![]() ![]() |
S | 0..* | TrustFramework | NDH Trust Framework |
![]() ![]() ![]() ![]() |
S | 0..* | DynamicRegistration | NDH Dynamic Registration |
![]() ![]() ![]() ![]() |
S | 0..* | AssociatedServers | NDH Associated Servers |
![]() ![]() ![]() ![]() |
S | 0..1 | EndpointAccessControlMechanism | NDH Endpoint Access Control Mechanism |
![]() ![]() ![]() ![]() |
S | 0..* | EndpointConnectionTypeVersion | NDH Endpoint Connection Type Version |
![]() ![]() ![]() ![]() |
S | 0..1 | EndpointRank | NDH Endpoint Rank |
![]() ![]() ![]() ![]() |
S | 1..1 | VerificationStatus | NDH Verification Status |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | IdentifierStatus | NDH Identifier Status |
![]() ![]() ![]() ![]() |
S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(National Directory API Organization Profile) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
0..1 | Reference(National Directory API Organization Profile) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | ContactPointAvailableTime | NDH Contactpoint Availabletime |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | ViaIntermediary | NDH Via Intermediary |
![]() ![]() ![]() ![]() |
S | 0..1 | code | phone | fax | email | pager | url | sms | other |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() |
S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() |
S | 0..1 | Period | Interval the endpoint is expected to be operational |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) |
![]() ![]() ![]() |
S | 1..1 | url | The technical base address for connecting to this endpoint |
![]() ![]() ![]() |
S | 0..* | string | Usage depends on the channel type |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | NdhEndpoint | The technical details of an endpoint that can be used for electronic services | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Endpoint Usecase URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase | ||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Non FHIR Endpoint Usecase URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-non-fhir-usecase | |||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH FHIR IG URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Secure Exchange Artifacts URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Trust Framework URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Dynamic Registration URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Associated Servers URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | NDH Endpoint Access Control Mechanism URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism Binding: Endpoint Access Control Mechanism Value Set (extensible) | ||||
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | NDH Endpoint Connection Type Version URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version Binding: FHIRVersion (extensible) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | NDH Endpoint Rank URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | IHE Specific Connection Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type Binding: Endpoint IHE Specific Connection Types Value Set (preferred) | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | ||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Endpoint Testing Certification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The type of environment exposed at this endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-environment-type Binding: NDH Endpoint Environment Value Set (extensible) | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(National Directory API Organization Profile) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. Fixed Value: active | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | A name that this endpoint can be identified by | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(National Directory API Organization Profile) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | ||||
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Period | Interval the endpoint is expected to be operational | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Value Set (extensible) | ||||
![]() ![]() ![]() |
SΣ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Endpoint FHIR Mimetype Value Set (required) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | url | The technical base address for connecting to this endpoint | ||||
![]() ![]() ![]() |
S | 0..* | string | Usage depends on the channel type | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Endpoint.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Endpoint.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Endpoint.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Endpoint.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Endpoint.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Endpoint.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 from the FHIR Standard | ||||
Endpoint.connectionType | extensible | EndpointConnectionTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS from this IG | ||||
Endpoint.contact.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Endpoint.contact.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Endpoint.payloadType | extensible | EndpointPayloadTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS from this IG | ||||
Endpoint.payloadMimeType | required | EndpointFhirMimeTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS from this IG |
This structure is derived from NdhEndpoint
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | NdhEndpoint | The technical details of an endpoint that can be used for electronic services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..1 | instant | When the resource version last changed ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Endpoint Usecase URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..* | (Complex) | Non FHIR Endpoint Usecase URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-non-fhir-usecase ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH FHIR IG URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Secure Exchange Artifacts URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Trust Framework URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Dynamic Registration URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Associated Servers URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | NDH Endpoint Access Control Mechanism URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism Binding: Endpoint Access Control Mechanism Value Set (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | NDH Endpoint Connection Type Version URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version Binding: FHIRVersion (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | NDH Endpoint Rank URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | IHE Specific Connection Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type Binding: Endpoint IHE Specific Connection Types Value Set (preferred) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..* | (Complex) | Endpoint Testing Certification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The type of environment exposed at this endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-environment-type Binding: NDH Endpoint Environment Value Set (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(National Directory API Organization Profile) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. ele-1: All FHIR elements must have a @value or children Fixed Value: active |
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | string | A name that this endpoint can be identified by ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(National Directory API Organization Profile) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when the contact point was/is in use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Period | Interval the endpoint is expected to be operational ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Value Set (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Endpoint FHIR Mimetype Value Set (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | url | The technical base address for connecting to this endpoint ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | string | Usage depends on the channel type ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet / Code | URI |
Endpoint.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Endpoint.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Endpoint.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 from the FHIR Standard | |
Endpoint.connectionType | extensible | EndpointConnectionTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS from this IG | |
Endpoint.contact.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Endpoint.contact.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Endpoint.payloadType | extensible | EndpointPayloadTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS from this IG | |
Endpoint.payloadMimeType | required | EndpointFhirMimeTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS from this IG |
Differential View
This structure is derived from NdhEndpoint
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
NdhEndpoint | |||
![]() ![]() ![]() |
S | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..* | EndpointUsecase | NDH Endpoint Usecase |
![]() ![]() ![]() ![]() |
S | 0..* | FhirIg | NDH FHIR IG |
![]() ![]() ![]() ![]() |
S | 0..* | SecureExchangeArtifacts | NDH Secure Exchange Artifacts |
![]() ![]() ![]() ![]() |
S | 0..* | TrustFramework | NDH Trust Framework |
![]() ![]() ![]() ![]() |
S | 0..* | DynamicRegistration | NDH Dynamic Registration |
![]() ![]() ![]() ![]() |
S | 0..* | AssociatedServers | NDH Associated Servers |
![]() ![]() ![]() ![]() |
S | 0..1 | EndpointAccessControlMechanism | NDH Endpoint Access Control Mechanism |
![]() ![]() ![]() ![]() |
S | 0..* | EndpointConnectionTypeVersion | NDH Endpoint Connection Type Version |
![]() ![]() ![]() ![]() |
S | 0..1 | EndpointRank | NDH Endpoint Rank |
![]() ![]() ![]() ![]() |
S | 1..1 | VerificationStatus | NDH Verification Status |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | IdentifierStatus | NDH Identifier Status |
![]() ![]() ![]() ![]() |
S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(National Directory API Organization Profile) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
0..1 | Reference(National Directory API Organization Profile) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | ContactPointAvailableTime | NDH Contactpoint Availabletime |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | ViaIntermediary | NDH Via Intermediary |
![]() ![]() ![]() ![]() |
S | 0..1 | code | phone | fax | email | pager | url | sms | other |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() |
S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() |
S | 0..1 | Period | Interval the endpoint is expected to be operational |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) |
![]() ![]() ![]() |
S | 1..1 | url | The technical base address for connecting to this endpoint |
![]() ![]() ![]() |
S | 0..* | string | Usage depends on the channel type |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | NdhEndpoint | The technical details of an endpoint that can be used for electronic services | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Endpoint Usecase URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-usecase | ||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Non FHIR Endpoint Usecase URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-non-fhir-usecase | |||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH FHIR IG URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fhir-ig | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Secure Exchange Artifacts URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Trust Framework URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Dynamic Registration URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Associated Servers URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | NDH Endpoint Access Control Mechanism URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism Binding: Endpoint Access Control Mechanism Value Set (extensible) | ||||
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | NDH Endpoint Connection Type Version URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-connection-type-version Binding: FHIRVersion (extensible) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | NDH Endpoint Rank URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | IHE Specific Connection Type URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type Binding: Endpoint IHE Specific Connection Types Value Set (preferred) | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | ||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Endpoint Testing Certification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The type of environment exposed at this endpoint URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-environment-type Binding: NDH Endpoint Environment Value Set (extensible) | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(National Directory API Organization Profile) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | active | suspended | error | off | entered-in-error | test Binding: EndpointStatus (required): The status of the endpoint. Fixed Value: active | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Types Value Set (extensible) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | A name that this endpoint can be identified by | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(National Directory API Organization Profile) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | ||||
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Period | Interval the endpoint is expected to be operational | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Value Set (extensible) | ||||
![]() ![]() ![]() |
SΣ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Endpoint FHIR Mimetype Value Set (required) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | url | The technical base address for connecting to this endpoint | ||||
![]() ![]() ![]() |
S | 0..* | string | Usage depends on the channel type | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Endpoint.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Endpoint.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Endpoint.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Endpoint.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Endpoint.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Endpoint.status | required | Fixed Value: activehttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1 from the FHIR Standard | ||||
Endpoint.connectionType | extensible | EndpointConnectionTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS from this IG | ||||
Endpoint.contact.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Endpoint.contact.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Endpoint.payloadType | extensible | EndpointPayloadTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS from this IG | ||||
Endpoint.payloadMimeType | required | EndpointFhirMimeTypeVShttp://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS from this IG |
This structure is derived from NdhEndpoint
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Patient Administration. Package hl7.fhir.us.ndh#1.0.0 based on FHIR 4.0.1. Generated 2025-02-28
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change