Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_Endpoint_R4

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-Endpoint Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_Endpoint_R4

This cross-version profile allows R5 Endpoint content to be represented via FHIR R4 Endpoint resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint(4.0.1) The technical details of an endpoint that can be used for electronic services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:description 0..1 string R5: Additional details about the endpoint that could be displayed as further information to identify the description beyond its name (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.description
Constraints: ext-1
.... extension:environmentType 0..* CodeableConcept R5: The type of environment(s) exposed at this endpoint (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.environmentType
Binding: R5EndpointEnvironmentForR4 (0.1.0) (extensible)
Constraints: ext-1
.... extension:type 0..* CodeableConcept R5: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.payload.type
Binding: R5EndpointPayloadTypeForR4 (0.1.0) (example)
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:connectionType 1..* CodeableConcept R5: connectionType additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.connectionType
Binding: EndpointConnectionType (example)
Constraints: ext-1
... payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType . (example)
... address Σ 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Endpoint.status Base required EndpointStatus 📍4.0.1 FHIR Std.
Endpoint.connectionType Base extensible Endpoint Connection Type 📍4.0.1 FHIR Std.
Endpoint.payloadType Base example Endpoint Payload Type . 📍4.0.1 tx.fhir.org

Constraints

Id Grade Path(s) Description Expression
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 Endpoint.implicitRules, Endpoint.extension, Endpoint.extension:description, Endpoint.extension:environmentType, Endpoint.extension:type, Endpoint.modifierExtension, Endpoint.status, Endpoint.connectionType, Endpoint.connectionType.extension, Endpoint.connectionType.extension:connectionType, Endpoint.payloadType, Endpoint.address All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Endpoint.extension, Endpoint.extension:description, Endpoint.extension:environmentType, Endpoint.extension:type, Endpoint.modifierExtension, Endpoint.connectionType.extension, Endpoint.connectionType.extension:connectionType Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint(4.0.1) The technical details of an endpoint that can be used for electronic services
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:description 0..1 string R5: Additional details about the endpoint that could be displayed as further information to identify the description beyond its name (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.description
.... extension:environmentType 0..* CodeableConcept R5: The type of environment(s) exposed at this endpoint (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.environmentType
Binding: R5EndpointEnvironmentForR4 (0.1.0) (extensible)
.... extension:type 0..* CodeableConcept R5: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.payload.type
Binding: R5EndpointPayloadTypeForR4 (0.1.0) (example)
... connectionType
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:connectionType 0..* CodeableConcept R5: connectionType additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.connectionType
Binding: EndpointConnectionType (example)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint(4.0.1) The technical details of an endpoint that can be used for electronic services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:description 0..1 string R5: Additional details about the endpoint that could be displayed as further information to identify the description beyond its name (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.description
Constraints: ext-1
.... extension:environmentType 0..* CodeableConcept R5: The type of environment(s) exposed at this endpoint (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.environmentType
Binding: R5EndpointEnvironmentForR4 (0.1.0) (extensible)
Constraints: ext-1
.... extension:type 0..* CodeableConcept R5: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.payload.type
Binding: R5EndpointPayloadTypeForR4 (0.1.0) (example)
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Identifies this endpoint across multiple systems
... status ?!Σ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.
... connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:connectionType 1..* CodeableConcept R5: connectionType additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.connectionType
Binding: EndpointConnectionType (example)
Constraints: ext-1
.... system Σ 0..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 0..1 code Symbol in syntax defined by the system
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... name Σ 0..1 string A name that this endpoint can be identified by
... managingOrganization Σ 0..1 Reference(Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
... period Σ 0..1 Period Interval the endpoint is expected to be operational
... payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType . (example)
... payloadMimeType Σ 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.
... address Σ 1..1 url The technical base address for connecting to this endpoint
... header 0..* string Usage depends on the channel type

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Endpoint.language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
Endpoint.status Base required EndpointStatus 📍4.0.1 FHIR Std.
Endpoint.connectionType Base extensible Endpoint Connection Type 📍4.0.1 FHIR Std.
Endpoint.payloadType Base example Endpoint Payload Type . 📍4.0.1 tx.fhir.org
Endpoint.payloadMimeType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 Endpoint.meta, Endpoint.implicitRules, Endpoint.language, Endpoint.text, Endpoint.extension, Endpoint.extension:description, Endpoint.extension:environmentType, Endpoint.extension:type, Endpoint.modifierExtension, Endpoint.identifier, Endpoint.status, Endpoint.connectionType, Endpoint.connectionType.extension, Endpoint.connectionType.extension:connectionType, Endpoint.connectionType.system, Endpoint.connectionType.version, Endpoint.connectionType.code, Endpoint.connectionType.display, Endpoint.connectionType.userSelected, Endpoint.name, Endpoint.managingOrganization, Endpoint.contact, Endpoint.period, Endpoint.payloadType, Endpoint.payloadMimeType, Endpoint.address, Endpoint.header All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Endpoint.extension, Endpoint.extension:description, Endpoint.extension:environmentType, Endpoint.extension:type, Endpoint.modifierExtension, Endpoint.connectionType.extension, Endpoint.connectionType.extension:connectionType Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint(4.0.1) The technical details of an endpoint that can be used for electronic services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:description 0..1 string R5: Additional details about the endpoint that could be displayed as further information to identify the description beyond its name (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.description
Constraints: ext-1
.... extension:environmentType 0..* CodeableConcept R5: The type of environment(s) exposed at this endpoint (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.environmentType
Binding: R5EndpointEnvironmentForR4 (0.1.0) (extensible)
Constraints: ext-1
.... extension:type 0..* CodeableConcept R5: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.payload.type
Binding: R5EndpointPayloadTypeForR4 (0.1.0) (example)
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:connectionType 1..* CodeableConcept R5: connectionType additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.connectionType
Binding: EndpointConnectionType (example)
Constraints: ext-1
... payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType . (example)
... address Σ 1..1 url The technical base address for connecting to this endpoint

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Endpoint.status Base required EndpointStatus 📍4.0.1 FHIR Std.
Endpoint.connectionType Base extensible Endpoint Connection Type 📍4.0.1 FHIR Std.
Endpoint.payloadType Base example Endpoint Payload Type . 📍4.0.1 tx.fhir.org

Constraints

Id Grade Path(s) Description Expression
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 Endpoint.implicitRules, Endpoint.extension, Endpoint.extension:description, Endpoint.extension:environmentType, Endpoint.extension:type, Endpoint.modifierExtension, Endpoint.status, Endpoint.connectionType, Endpoint.connectionType.extension, Endpoint.connectionType.extension:connectionType, Endpoint.payloadType, Endpoint.address All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Endpoint.extension, Endpoint.extension:description, Endpoint.extension:environmentType, Endpoint.extension:type, Endpoint.modifierExtension, Endpoint.connectionType.extension, Endpoint.connectionType.extension:connectionType Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Endpoint

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint(4.0.1) The technical details of an endpoint that can be used for electronic services
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:description 0..1 string R5: Additional details about the endpoint that could be displayed as further information to identify the description beyond its name (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.description
.... extension:environmentType 0..* CodeableConcept R5: The type of environment(s) exposed at this endpoint (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.environmentType
Binding: R5EndpointEnvironmentForR4 (0.1.0) (extensible)
.... extension:type 0..* CodeableConcept R5: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.payload.type
Binding: R5EndpointPayloadTypeForR4 (0.1.0) (example)
... connectionType
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:connectionType 0..* CodeableConcept R5: connectionType additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.connectionType
Binding: EndpointConnectionType (example)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint(4.0.1) The technical details of an endpoint that can be used for electronic services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:description 0..1 string R5: Additional details about the endpoint that could be displayed as further information to identify the description beyond its name (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.description
Constraints: ext-1
.... extension:environmentType 0..* CodeableConcept R5: The type of environment(s) exposed at this endpoint (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.environmentType
Binding: R5EndpointEnvironmentForR4 (0.1.0) (extensible)
Constraints: ext-1
.... extension:type 0..* CodeableConcept R5: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.payload.type
Binding: R5EndpointPayloadTypeForR4 (0.1.0) (example)
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Identifies this endpoint across multiple systems
... status ?!Σ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.
... connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:connectionType 1..* CodeableConcept R5: connectionType additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Endpoint.connectionType
Binding: EndpointConnectionType (example)
Constraints: ext-1
.... system Σ 0..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 0..1 code Symbol in syntax defined by the system
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... name Σ 0..1 string A name that this endpoint can be identified by
... managingOrganization Σ 0..1 Reference(Organization) Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
... period Σ 0..1 Period Interval the endpoint is expected to be operational
... payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType . (example)
... payloadMimeType Σ 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.
... address Σ 1..1 url The technical base address for connecting to this endpoint
... header 0..* string Usage depends on the channel type

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Endpoint.language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
Endpoint.status Base required EndpointStatus 📍4.0.1 FHIR Std.
Endpoint.connectionType Base extensible Endpoint Connection Type 📍4.0.1 FHIR Std.
Endpoint.payloadType Base example Endpoint Payload Type . 📍4.0.1 tx.fhir.org
Endpoint.payloadMimeType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 Endpoint.meta, Endpoint.implicitRules, Endpoint.language, Endpoint.text, Endpoint.extension, Endpoint.extension:description, Endpoint.extension:environmentType, Endpoint.extension:type, Endpoint.modifierExtension, Endpoint.identifier, Endpoint.status, Endpoint.connectionType, Endpoint.connectionType.extension, Endpoint.connectionType.extension:connectionType, Endpoint.connectionType.system, Endpoint.connectionType.version, Endpoint.connectionType.code, Endpoint.connectionType.display, Endpoint.connectionType.userSelected, Endpoint.name, Endpoint.managingOrganization, Endpoint.contact, Endpoint.period, Endpoint.payloadType, Endpoint.payloadMimeType, Endpoint.address, Endpoint.header All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Endpoint.extension, Endpoint.extension:description, Endpoint.extension:environmentType, Endpoint.extension:type, Endpoint.modifierExtension, Endpoint.connectionType.extension, Endpoint.connectionType.extension:connectionType Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron