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

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

Resource Profile: Profile_R3_Endpoint_R5

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_R5

This cross-version profile allows STU3 Endpoint content to be represented via FHIR R5 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(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 STU3: status
URL: http://hl7.org/fhir/3.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
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta 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:status 0..1 code STU3: status
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.status
Binding: EndpointStatus (required): The status of the endpoint
... managingOrganization
.... 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(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
.... 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 Meta 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: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 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".
... 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): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... 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
.... 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): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 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.
.... 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 STU3: status
URL: http://hl7.org/fhir/3.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)
.... 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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 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): Telecommunications form for contact point.
.... value ΣC 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): Use of contact point.
.... 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
... 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.meta.security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
Endpoint.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
Endpoint.language Base required All Languages 📍5.0.0 FHIR Std.
Endpoint.text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
Endpoint.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Endpoint.identifier.​type Base extensible Identifier Type Codes 📍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.managingOrganization.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Endpoint.contact.system Base required ContactPointSystem 📍5.0.0 FHIR Std.
Endpoint.contact.use Base required ContactPointUse 📍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.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.status.extension, Endpoint.status.extension:status, Endpoint.connectionType, Endpoint.name, Endpoint.description, Endpoint.environmentType, 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.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.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.status.extension, Endpoint.status.extension:status, Endpoint.managingOrganization.extension, Endpoint.managingOrganization.extension:managingOrganization, Endpoint.contact.extension, Endpoint.contact.extension:contact, Endpoint.period.extension, Endpoint.period.extension:period, Endpoint.payload.extension, Endpoint.payload.modifierExtension 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(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 STU3: status
URL: http://hl7.org/fhir/3.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
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta 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:status 0..1 code STU3: status
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Endpoint.status
Binding: EndpointStatus (required): The status of the endpoint
... managingOrganization
.... 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(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
.... 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 Meta 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: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 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".
... 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): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... 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
.... 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): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 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.
.... 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 STU3: status
URL: http://hl7.org/fhir/3.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)
.... 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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 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): Telecommunications form for contact point.
.... value ΣC 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): Use of contact point.
.... 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
... 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.meta.security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
Endpoint.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
Endpoint.language Base required All Languages 📍5.0.0 FHIR Std.
Endpoint.text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
Endpoint.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Endpoint.identifier.​type Base extensible Identifier Type Codes 📍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.managingOrganization.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Endpoint.contact.system Base required ContactPointSystem 📍5.0.0 FHIR Std.
Endpoint.contact.use Base required ContactPointUse 📍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.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.status.extension, Endpoint.status.extension:status, Endpoint.connectionType, Endpoint.name, Endpoint.description, Endpoint.environmentType, 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.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.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.status.extension, Endpoint.status.extension:status, Endpoint.managingOrganization.extension, Endpoint.managingOrganization.extension:managingOrganization, Endpoint.contact.extension, Endpoint.contact.extension:contact, Endpoint.period.extension, Endpoint.period.extension:period, Endpoint.payload.extension, Endpoint.payload.modifierExtension 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