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

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

Resource Profile: Profile_R4_Endpoint_R5

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

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

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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(5.0.0) 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
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code R4: status
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Endpoint.status
Binding: EndpointStatus (required): The status of the endpoint.
Constraints: ext-1
... connectionType Σ 1..* CodeableConcept Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (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 Endpoint Status 📍5.0.0 FHIR Std.
Endpoint.connectionType Base example Endpoint Connection Type 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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.modifierExtension, Endpoint.status, Endpoint.status.extension, Endpoint.status.extension:status, Endpoint.connectionType, Endpoint.address All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Endpoint.modifierExtension, Endpoint.status.extension, Endpoint.status.extension:status 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(5.0.0) The technical details of an endpoint that can be used for electronic services
... status
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:status 0..1 code R4: status
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Endpoint.status
Binding: EndpointStatus (required): The status of the endpoint.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint(5.0.0) 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
... extension 0..* Extension Additional content defined by implementations
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.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code R4: status
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Endpoint.status
Binding: EndpointStatus (required): The status of the endpoint.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... connectionType Σ 1..* CodeableConcept Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (example)
... name Σ 0..1 string A name that this endpoint can be identified by
... description Σ 0..1 string Additional details about the endpoint that could be displayed as further information to identify the description beyond its name
... environmentType Σ 0..* CodeableConcept The type of environment(s) exposed at this endpoint
Binding: EndpointEnvironment (extensible)
... 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
... payload 0..* BackboneElement Set of payloads that are provided by this endpoint
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type Σ 0..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType . (example)
.... mimeType Σ 0..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
... 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 required All Languages 📍5.0.0 FHIR Std.
Endpoint.status Base required Endpoint Status 📍5.0.0 FHIR Std.
Endpoint.connectionType Base example Endpoint Connection Type 📍5.0.0 FHIR Std.
Endpoint.environmentType Base extensible Endpoint Environment 📍5.0.0 FHIR Std.
Endpoint.payload.type Base example Endpoint Payload Type . 📍5.0.0 tx.fhir.org
Endpoint.payload.mimeType Base required Mime Types 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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.modifierExtension, Endpoint.identifier, Endpoint.status, Endpoint.status.extension, Endpoint.status.extension:status, Endpoint.connectionType, Endpoint.name, Endpoint.description, Endpoint.environmentType, Endpoint.managingOrganization, Endpoint.contact, Endpoint.period, Endpoint.payload, Endpoint.payload.extension, Endpoint.payload.modifierExtension, Endpoint.payload.type, Endpoint.payload.mimeType, 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.modifierExtension, Endpoint.status.extension, Endpoint.status.extension:status, Endpoint.payload.extension, Endpoint.payload.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Endpoint

Summary

Extensions

This structure refers to these extensions:

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint(5.0.0) 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
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code R4: status
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Endpoint.status
Binding: EndpointStatus (required): The status of the endpoint.
Constraints: ext-1
... connectionType Σ 1..* CodeableConcept Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (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 Endpoint Status 📍5.0.0 FHIR Std.
Endpoint.connectionType Base example Endpoint Connection Type 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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.modifierExtension, Endpoint.status, Endpoint.status.extension, Endpoint.status.extension:status, Endpoint.connectionType, Endpoint.address All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Endpoint.modifierExtension, Endpoint.status.extension, Endpoint.status.extension:status 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(5.0.0) The technical details of an endpoint that can be used for electronic services
... status
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:status 0..1 code R4: status
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Endpoint.status
Binding: EndpointStatus (required): The status of the endpoint.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint(5.0.0) 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
... extension 0..* Extension Additional content defined by implementations
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.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code R4: status
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Endpoint.status
Binding: EndpointStatus (required): The status of the endpoint.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... connectionType Σ 1..* CodeableConcept Protocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (example)
... name Σ 0..1 string A name that this endpoint can be identified by
... description Σ 0..1 string Additional details about the endpoint that could be displayed as further information to identify the description beyond its name
... environmentType Σ 0..* CodeableConcept The type of environment(s) exposed at this endpoint
Binding: EndpointEnvironment (extensible)
... 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
... payload 0..* BackboneElement Set of payloads that are provided by this endpoint
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type Σ 0..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType . (example)
.... mimeType Σ 0..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
... 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 required All Languages 📍5.0.0 FHIR Std.
Endpoint.status Base required Endpoint Status 📍5.0.0 FHIR Std.
Endpoint.connectionType Base example Endpoint Connection Type 📍5.0.0 FHIR Std.
Endpoint.environmentType Base extensible Endpoint Environment 📍5.0.0 FHIR Std.
Endpoint.payload.type Base example Endpoint Payload Type . 📍5.0.0 tx.fhir.org
Endpoint.payload.mimeType Base required Mime Types 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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.modifierExtension, Endpoint.identifier, Endpoint.status, Endpoint.status.extension, Endpoint.status.extension:status, Endpoint.connectionType, Endpoint.name, Endpoint.description, Endpoint.environmentType, Endpoint.managingOrganization, Endpoint.contact, Endpoint.period, Endpoint.payload, Endpoint.payload.extension, Endpoint.payload.modifierExtension, Endpoint.payload.type, Endpoint.payload.mimeType, 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.modifierExtension, Endpoint.status.extension, Endpoint.status.extension:status, Endpoint.payload.extension, Endpoint.payload.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Endpoint

Summary

Extensions

This structure refers to these extensions:

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron