eHealthExchange Healthcare Directory Implementation Guide
1.2.0 - Release 1
eHealthExchange Healthcare Directory Implementation Guide
1.2.0 - Release 1
| Official URL: https://sequoiaproject.org/fhir/ehx/StructureDefinition/eHxEndpoint | Version: 1.2.0 | |||
| Active as of 2024-12-23 | Computable Name: EHxEndpoint | |||
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Endpoint |
C | 0..* | SequoiaEndpoint | 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 se-1: If the value of the Transaction extension = 'FHIR REST' then the Version extension must be a valid FHIR core specification version |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
  Slices for extension |
2..* | 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 | |
   transaction |
S | 1..1 | CodeableConcept | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction Binding: Transactions (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| version |
S | 1..1 | string | Optional Extensions Element URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 purposesofuse |
S | 0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
  extension |
0..0 | |||
| url |
1..1 | uri | "https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse" | |
  value[x] |
1..1 | CodeableConcept | Value of extension Binding: Purpose Of Use (required) ele-1: All FHIR elements must have a @value or children | |
| roles |
S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Roles Binding: NHIN User Role (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| downtime |
S | 0..* | Period, Timing | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Downtime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 fhirigconformance |
S | 0..* | (Complex) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/FHIRIGConformance ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 modifierExtension |
?! | 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 |
 Slices for identifier |
SΣ | 0..* | Identifier | Identifies this endpoint across multiple systems Slice: Unordered, Open by pattern:$this ele-1: All FHIR elements must have a @value or children |
| identifier:HCID |
SΣ | 0..1 | Identifier | OID (such as a Home Community ID) or UUID ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
  type |
1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
  coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system |
1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
 identifier:AAID |
SΣ | 0..* | Identifier | OID (such as an Assiging Authority ID) or UUID ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| type |
1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AAID | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
| status |
?!Σ | 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 |
| connectionType |
SΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Binding: Endpoint Connection Type (required) ele-1: All FHIR elements must have a @value or children |
| name |
SΣ | 1..1 | string | A name that this endpoint can be identified by ele-1: All FHIR elements must have a @value or children |
 managingOrganization |
SΣ | 1..1 | Reference(eHx Organization) | 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 |
| payloadType |
SΣ | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Binding: Endpoint Payload Type Codes (extensible) ele-1: All FHIR elements must have a @value or children |
| payloadMimeType |
SΣ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. ele-1: All FHIR elements must have a @value or children |
| address |
SΣ | 1..1 | url | The technical base address for connecting to this endpoint ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Endpoint.extension:purposesofuse.value[x] | required | PurposeOfUsehttps://sequoiaproject.org/fhir/sphd/ValueSet/PurposeOfUsefrom this IG | |
| Endpoint.status | required | EndpointStatushttp://hl7.org/fhir/ValueSet/endpoint-status|4.0.1from the FHIR Standard | |
| Endpoint.connectionType | required | EndpointConnectionTypehttps://sequoiaproject.org/fhir/sphd/ValueSet/EndpointConnectionTypefrom this IG | |
| Endpoint.payloadType | extensible | EndpointPayloadTypeCodeshttps://sequoiaproject.org/fhir/sphd/ValueSet/EndpointPayloadTypeCodesfrom this IG | |
| Endpoint.payloadMimeType | required | Mime Types (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Endpoint | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Endpoint | 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 | error | Endpoint | 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 | error | Endpoint | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Endpoint | A resource should have narrative for robust management : text.`div`.exists() | |
| 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() | |
| se-1 | error | Endpoint | If the value of the Transaction extension = 'FHIR REST' then the Version extension must be a valid FHIR core specification version : extension.where(url='https://sequoiaproject.org/fhir/sphd/StructureDefinition/Transaction' and (value as CodeableConcept).coding.first().code='FHIR REST').exists() implies extension.where(url='https://sequoiaproject.org/fhir/sphd/StructureDefinition/Version').where((value as string) = '4.0.1'or (value as string) = '5.0.0' or (value as string) = '3.0.2' or (value as string) = '1.0.2' ).exists() |
Other representations of profile: CSV, Excel, Schematron
