SPL Mapping FHIR R5 Implementation Guide
0.2.5 - Build CI United States of America flag

SPL Mapping FHIR R5 Implementation Guide, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.2.5 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-spl/ and changes regularly. See the Directory of published versions

Resource Profile: EstablishmentOrganization

Official URL: http://hl7.org/fhir/us/spl/StructureDefinition/EstablishmentOrganization Version: 0.2.5
Standards status: Trial-use Maturity Level: 1 Computable Name: EstablishmentOrganization

A profile for the data elements required to identify an organization that is registered as an Establishment.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
spl-6.1.4.1: If country is not USA, then US agent is mandatory.
spl-6.1.4.3: If country is USA, then US agent is not allowed.
spl-6.1.5.3: If country is USA, then import business is not allowed.
spl-5.1.5.6: Each business operation code is mentioned only once.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for contained 1..* Resource Contained, inline Resources
Slice: Unordered, Closed by profile:$this
.... contained:BusinessOperation S 1..* EstablishmentBusinessOperation The details of a healthcare service available at a location
.... contained:USAgentAffiliation S 0..1 USAgentAffiliation Defines an affiliation/association/relationship between 2 distinct organizations, that is not a part-of relationship/sub-division relationship
.... contained:USAgent S 0..1 USAgentOrganization A grouping of people or organizations with a common purpose
.... contained:ImporterAffiliation S 0..* ImporterAffiliation Defines an affiliation/association/relationship between 2 distinct organizations, that is not a part-of relationship/sub-division relationship
.... contained:Importer S 0..* ImporterOrganization A grouping of people or organizations with a common purpose
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system SΣ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
..... value SΣC 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:DUNSNumber SΣC 1..1 Identifier Identifies this organization across multiple systems
ele-1: All FHIR elements must have a @value or children
spl-2.1.5.2: DUNS number is 9 digits
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system SΣ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: http://terminology.hl7.org/NamingSystem/DUNSNumber
..... value SΣC 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:FEINumber SΣC 0..1 Identifier Identifies this organization across multiple systems
ele-1: All FHIR elements must have a @value or children
spl-6.1.3.7: FEI number is 7 or 10 digits
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system SΣ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: http://terminology.hl7.org/NamingSystem/FEI
..... value SΣC 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use
ele-1: All FHIR elements must have a @value or children
... type SΣ 1..1 CodeableConcept Kind of organization
Binding: OrganizationType (example): Used to categorize the organization.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/spl/CodeSystem/codesystem-organizationTypes
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Establishment
... name SΣC 1..1 string Name used for the organization
ele-1: All FHIR elements must have a @value or children
... Slices for contact SC 2..2 ExtendedContactDetail Official contact details for the Organization
Slice: Unordered, Closed by value:purpose
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
org-4: The address of an organization can never be of use 'home'
.... contact:OrgAddress SC 1..1 ExtendedContactDetail Official contact details for the Organization
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
org-4: The address of an organization can never be of use 'home'
..... purpose SΣ 1..1 CodeableConcept The type of contact
Binding: Contact entity type (preferred): The purpose for which an extended contact detail should be used.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/spl/CodeSystem/codesystem-organizationContactType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ADDRESS
..... address SΣ 1..1 Address Address for the contact
ele-1: All FHIR elements must have a @value or children
.... contact:OrgContact SC 1..1 ExtendedContactDetail Official contact details for the Organization
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
org-4: The address of an organization can never be of use 'home'
..... purpose SΣ 1..1 CodeableConcept The type of contact
Binding: Contact entity type (preferred): The purpose for which an extended contact detail should be used.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/contactentity-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ADMIN
..... name SΣ 1..1 HumanName Name of an individual to contact
ele-1: All FHIR elements must have a @value or children
..... Slices for telecom SΣ 2..* ContactPoint Contact details (e.g.phone/fax/url)
Slice: Unordered, Open by value:system
ele-1: All FHIR elements must have a @value or children
...... telecom:Phone SΣ 1..1 SPLContactPoint Contact details (e.g.phone/fax/url)
ele-1: All FHIR elements must have a @value or children
....... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: phone
....... value SΣC 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
...... telecom:Email SΣ 1..1 SPLContactPoint Contact details (e.g.phone/fax/url)
ele-1: All FHIR elements must have a @value or children
....... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: email
....... value SΣC 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
....... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
..... address SΣ 1..1 SPLAddress Address for the contact
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Organization.identifier:DUNSNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Organization.identifier:FEINumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Organization.typeexamplePattern: Establishment
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.contact:OrgAddress.purposepreferredPattern: ADDRESS
http://terminology.hl7.org/ValueSet/contactentity-type
Organization.contact:OrgContact.purposepreferredPattern: ADMIN
http://terminology.hl7.org/ValueSet/contactentity-type
Organization.contact:OrgContact.telecom:Phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Organization.contact:OrgContact.telecom:Phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Organization.contact:OrgContact.telecom:Email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Organization.contact:OrgContact.telecom:Email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-3errorOrganization.contact, Organization.contact:OrgAddress, Organization.contact:OrgContactThe telecom of an organization can never be of use 'home'
: telecom.where(use = 'home').empty()
org-4errorOrganization.contact, Organization.contact:OrgAddress, Organization.contact:OrgContactThe address of an organization can never be of use 'home'
: address.where(use = 'home').empty()
spl-2.1.5.2errorOrganization.identifier:DUNSNumberDUNS number is 9 digits
: system = 'http://terminology.hl7.org/NamingSystem/DUNSNumber' implies value.length() = 9
spl-5.1.5.6errorOrganizationEach business operation code is mentioned only once.
: contained.ofType(HealthcareService).type.coding.code.isDistinct()
spl-6.1.3.7errorOrganization.identifier:FEINumberFEI number is 7 or 10 digits
: system = 'urn:oid:2.16.840.1.113883.4.82' implies (value.length() = 7 or value.length() = 10)
spl-6.1.4.1errorOrganizationIf country is not USA, then US agent is mandatory.
: contact.where(purpose.coding.code = 'ADDRESS').address.where(country = 'USA').count() = 0 implies contained.ofType(Organization).where(type.coding.where(code = 'USAgent').count() = 0).count() = 1
spl-6.1.4.3errorOrganizationIf country is USA, then US agent is not allowed.
: contact.where(purpose.coding.code = 'ADDRESS').address.where(country = 'USA').count() > 0 implies contained.ofType(Organization).where(type.coding.where(code = 'USAgent').count() = 0).count() = 0
spl-6.1.5.3errorOrganizationIf country is USA, then import business is not allowed.
: contact.where(purpose.coding.code = 'ADDRESS').address.where(country = 'USA').count() > 0 implies contained.ofType(Organization).where(type.coding.where(code = 'Importer').count() = 0).count() = 0

 

Other representations of profile: CSV, Excel, Schematron