Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU International flag

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

Resource Profile: Profile_R3_Endpoint_R4B

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

This cross-version profile allows STU3 Endpoint content to be represented via FHIR R4B 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.3.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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... status ?!Σ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.
... 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.3.0 FHIR Std.
Endpoint.connectionType Base extensible Endpoint Connection Type 📍4.3.0 FHIR Std.
Endpoint.payloadType Base example Endpoint Payload Type 📍4.3.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.exists() and ('#'+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(uri) = '#').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.connectionType, Endpoint.payloadType, Endpoint.address All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Endpoint.modifierExtension 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.3.0) The technical details of an endpoint that can be used for electronic services
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:managingOrganization 0..1 Reference(Resource) STU3: Organization that manages this endpoint (may not be the organization that exposes the endpoint) additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* ContactPoint STU3: contact additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.contact
... period
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.period

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint(4.3.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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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)
... 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)
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:managingOrganization 0..1 Reference(Resource) STU3: Organization that manages this endpoint (may not be the organization that exposes the endpoint) additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:contact 0..* ContactPoint STU3: contact additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.contact
Constraints: ext-1
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... period Σ 0..1 Period Interval the endpoint is expected to be operational
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.period
Constraints: ext-1
.... start ΣC 0..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... 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): 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.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Endpoint.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
Endpoint.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Endpoint.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
Endpoint.identifier.​use Base required IdentifierUse 📍4.3.0 FHIR Std.
Endpoint.identifier.​type Base extensible IdentifierType 📍4.3.0 FHIR Std.
Endpoint.status Base required EndpointStatus 📍4.3.0 FHIR Std.
Endpoint.connectionType Base extensible Endpoint Connection Type 📍4.3.0 FHIR Std.
Endpoint.managingOrganization.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Endpoint.contact.system Base required ContactPointSystem 📍4.3.0 FHIR Std.
Endpoint.contact.use Base required ContactPointUse 📍4.3.0 FHIR Std.
Endpoint.payloadType Base example Endpoint Payload Type 📍4.3.0 FHIR Std.
Endpoint.payloadMimeType Base required MimeType 📍4.3.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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning Endpoint.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error Endpoint.meta, Endpoint.meta.extension, Endpoint.meta.extension:meta, Endpoint.meta.versionId, Endpoint.meta.lastUpdated, Endpoint.meta.source, Endpoint.meta.profile, Endpoint.meta.security, Endpoint.meta.tag, Endpoint.implicitRules, Endpoint.language, Endpoint.text, Endpoint.text.extension, Endpoint.text.extension:text, Endpoint.text.status, Endpoint.text.div, Endpoint.extension, Endpoint.modifierExtension, Endpoint.identifier, Endpoint.identifier.extension, Endpoint.identifier.extension:identifier, Endpoint.identifier.use, Endpoint.identifier.type, Endpoint.identifier.system, Endpoint.identifier.value, Endpoint.identifier.period, Endpoint.identifier.assigner, Endpoint.status, Endpoint.connectionType, Endpoint.name, Endpoint.managingOrganization, Endpoint.managingOrganization.extension, Endpoint.managingOrganization.extension:managingOrganization, Endpoint.managingOrganization.reference, Endpoint.managingOrganization.type, Endpoint.managingOrganization.identifier, Endpoint.managingOrganization.display, Endpoint.contact, Endpoint.contact.extension, Endpoint.contact.extension:contact, Endpoint.contact.system, Endpoint.contact.value, Endpoint.contact.use, Endpoint.contact.rank, Endpoint.contact.period, Endpoint.period, Endpoint.period.extension, Endpoint.period.extension:period, Endpoint.period.start, Endpoint.period.end, 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.meta.extension, Endpoint.meta.extension:meta, Endpoint.text.extension, Endpoint.text.extension:text, Endpoint.extension, Endpoint.modifierExtension, Endpoint.identifier.extension, Endpoint.identifier.extension:identifier, Endpoint.managingOrganization.extension, Endpoint.managingOrganization.extension:managingOrganization, Endpoint.contact.extension, Endpoint.contact.extension:contact, Endpoint.period.extension, Endpoint.period.extension:period Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error Endpoint.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Endpoint.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint(4.3.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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... status ?!Σ 1..1 code active | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required): The status of the endpoint.
... 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.3.0 FHIR Std.
Endpoint.connectionType Base extensible Endpoint Connection Type 📍4.3.0 FHIR Std.
Endpoint.payloadType Base example Endpoint Payload Type 📍4.3.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.exists() and ('#'+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(uri) = '#').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.connectionType, Endpoint.payloadType, Endpoint.address All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Endpoint.modifierExtension 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.3.0) The technical details of an endpoint that can be used for electronic services
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:managingOrganization 0..1 Reference(Resource) STU3: Organization that manages this endpoint (may not be the organization that exposes the endpoint) additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* ContactPoint STU3: contact additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.contact
... period
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.period

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Endpoint 0..* Endpoint(4.3.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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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)
... 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)
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:managingOrganization 0..1 Reference(Resource) STU3: Organization that manages this endpoint (may not be the organization that exposes the endpoint) additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:contact 0..* ContactPoint STU3: contact additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.contact
Constraints: ext-1
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... period Σ 0..1 Period Interval the endpoint is expected to be operational
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.period
Constraints: ext-1
.... start ΣC 0..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... 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): 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.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Endpoint.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
Endpoint.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Endpoint.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
Endpoint.identifier.​use Base required IdentifierUse 📍4.3.0 FHIR Std.
Endpoint.identifier.​type Base extensible IdentifierType 📍4.3.0 FHIR Std.
Endpoint.status Base required EndpointStatus 📍4.3.0 FHIR Std.
Endpoint.connectionType Base extensible Endpoint Connection Type 📍4.3.0 FHIR Std.
Endpoint.managingOrganization.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Endpoint.contact.system Base required ContactPointSystem 📍4.3.0 FHIR Std.
Endpoint.contact.use Base required ContactPointUse 📍4.3.0 FHIR Std.
Endpoint.payloadType Base example Endpoint Payload Type 📍4.3.0 FHIR Std.
Endpoint.payloadMimeType Base required MimeType 📍4.3.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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning Endpoint.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error Endpoint.meta, Endpoint.meta.extension, Endpoint.meta.extension:meta, Endpoint.meta.versionId, Endpoint.meta.lastUpdated, Endpoint.meta.source, Endpoint.meta.profile, Endpoint.meta.security, Endpoint.meta.tag, Endpoint.implicitRules, Endpoint.language, Endpoint.text, Endpoint.text.extension, Endpoint.text.extension:text, Endpoint.text.status, Endpoint.text.div, Endpoint.extension, Endpoint.modifierExtension, Endpoint.identifier, Endpoint.identifier.extension, Endpoint.identifier.extension:identifier, Endpoint.identifier.use, Endpoint.identifier.type, Endpoint.identifier.system, Endpoint.identifier.value, Endpoint.identifier.period, Endpoint.identifier.assigner, Endpoint.status, Endpoint.connectionType, Endpoint.name, Endpoint.managingOrganization, Endpoint.managingOrganization.extension, Endpoint.managingOrganization.extension:managingOrganization, Endpoint.managingOrganization.reference, Endpoint.managingOrganization.type, Endpoint.managingOrganization.identifier, Endpoint.managingOrganization.display, Endpoint.contact, Endpoint.contact.extension, Endpoint.contact.extension:contact, Endpoint.contact.system, Endpoint.contact.value, Endpoint.contact.use, Endpoint.contact.rank, Endpoint.contact.period, Endpoint.period, Endpoint.period.extension, Endpoint.period.extension:period, Endpoint.period.start, Endpoint.period.end, 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.meta.extension, Endpoint.meta.extension:meta, Endpoint.text.extension, Endpoint.text.extension:text, Endpoint.extension, Endpoint.modifierExtension, Endpoint.identifier.extension, Endpoint.identifier.extension:identifier, Endpoint.managingOrganization.extension, Endpoint.managingOrganization.extension:managingOrganization, Endpoint.contact.extension, Endpoint.contact.extension:contact, Endpoint.period.extension, Endpoint.period.extension:period Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error Endpoint.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Endpoint.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron