HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1.0 (Standard for Trial Use)

This page is part of the Occupational Data for Health (ODH) FHIR IG (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions

Endpoint

 

The official URL for this profile is: 

http://hl7.org/fhir/us/odh/StructureDefinition/obf-Endpoint

PractitionerRole covers the recording of the location and types of services that Practitioners are able to provide for an organization.

This profile builds on Endpoint.

This profile was published on Sat Jan 04 00:00:00 UTC 2020 as a draft by HL7 International Public Health Work Group.

Summary

Mapping Source

This structure represents the following mapping definition:

obf.Endpoint maps to Endpoint:
  Identifier maps to identifier
  EndpointStatus maps to status
  TimePeriod maps to period
  EndpointConnectionType maps to connectionType
  EndpointName maps to name
  ManagingOrganization maps to managingOrganization
  ContactPoint maps to contact
  PayloadType maps to payloadType
  PayloadMimeType maps to payloadMimeType
  EndpointAddress maps to address
  Header maps to header
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint I0..*EndpointEndpoint
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifies this endpoint across multiple systems
... status ?!ΣI1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required)
... connectionType ΣI1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (required)
... name ΣI0..1stringA name that this endpoint can be identified by
... managingOrganization ΣI0..1Reference(Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact I0..*ContactPointContact details for source (e.g. troubleshooting)
... period ΣI0..1PeriodInterval the endpoint is expected to be operational
... payloadType ΣI1..*CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (required)
... payloadMimeType ΣI0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Mime Types (required)
... address ΣI1..1urlThe technical base address for connecting to this endpoint
... header I0..*stringUsage depends on the channel type

doco Documentation for this format

Summary

Mapping Source

This structure represents the following mapping definition:

obf.Endpoint maps to Endpoint:
  Identifier maps to identifier
  EndpointStatus maps to status
  TimePeriod maps to period
  EndpointConnectionType maps to connectionType
  EndpointName maps to name
  ManagingOrganization maps to managingOrganization
  ContactPoint maps to contact
  PayloadType maps to payloadType
  PayloadMimeType maps to payloadMimeType
  EndpointAddress maps to address
  Header maps to header

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint I0..*EndpointEndpoint
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifies this endpoint across multiple systems
... status ?!ΣI1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required)
... connectionType ΣI1..1CodingProtocol/Profile/Standard to be used with this endpoint connection
Binding: EndpointConnectionType (required)
... name ΣI0..1stringA name that this endpoint can be identified by
... managingOrganization ΣI0..1Reference(Organization)Organization that manages this endpoint (might not be the organization that exposes the endpoint)
... contact I0..*ContactPointContact details for source (e.g. troubleshooting)
... period ΣI0..1PeriodInterval the endpoint is expected to be operational
... payloadType ΣI1..*CodeableConceptThe type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Binding: EndpointPayloadType (required)
... payloadMimeType ΣI0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: Mime Types (required)
... address ΣI1..1urlThe technical base address for connecting to this endpoint
... header I0..*stringUsage depends on the channel type

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathConformanceValueSet
Endpoint.languagepreferredCommonLanguages
Max Binding: AllLanguages
Endpoint.statusrequiredEndpointStatus
Endpoint.connectionTyperequiredEndpointConnectionType
Endpoint.payloadTyperequiredEndpointPayloadType
Endpoint.payloadMimeTyperequiredMime Types

 

Constraints

IdPathDetailsRequirements
dom-2EndpointIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3EndpointIf 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-4EndpointIf 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-5EndpointIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6EndpointA resource should have narrative for robust management
: text.`div`.exists()
ele-1Endpoint.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Endpoint.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Endpoint.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Endpoint.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Endpoint.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.connectionTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.managingOrganizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.payloadTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.payloadMimeTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Endpoint.headerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())