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

SPL Mapping FHIR 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.1.0 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: RegistrantOrganization ( Abstract )

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

A profile for the data elements required to identify an organization that registers organizations and facilities.

Usage:

Formal Views of Profile Content

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

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization Organization This is an abstract profile. Child profiles: EstablishmentRegistrantOrganization, GDUFARegistrantOrganization
... Slices for identifier S 1..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... system S 1..1 uri The namespace for the identifier value
..... value S 1..1 string The value that is unique
.... identifier:DUNSNumber SC 1..1 Identifier Identifies this organization across multiple systems
spl-2.1.5.2: DUNS number is 9 digits
..... system 0..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.3.6.1.4.1.519.1
... type S 1..1 CodeableConcept Kind of organization
Binding: Registrant Organization Types (required)
... name S 1..1 string Name used for the organization
.... name S 1..1 HumanName A name associated with the contact
.... Slices for telecom S 2..* ContactPoint Contact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:Phone S 1..1 SPLContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
...... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... telecom:Email S 1..1 SPLContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
...... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email
.... address S 1..1 SPLAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.typerequiredRegistrantOrganizationTypes
http://hl7.org/fhir/us/spl/ValueSet/valueset-registrantOrganizationTypes
from this IG

Constraints

IdGradePath(s)DetailsRequirements
spl-2.1.5.2errorOrganization.identifier:DUNSNumberDUNS number is 9 digits
: system = 'urn:oid:1.3.6.1.4.1.519.1' implies value.length() = 9
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization This is an abstract profile. Child profiles: EstablishmentRegistrantOrganization, GDUFARegistrantOrganization
A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣC 1..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:DUNSNumber SΣC 1..1 Identifier Identifies this organization across multiple systems
spl-2.1.5.2: DUNS number is 9 digits
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.3.6.1.4.1.519.1
... type SΣ 1..1 CodeableConcept Kind of organization
Binding: Registrant Organization Types (required)
... name SΣC 1..1 string Name used for the organization
... contact S 1..1 BackboneElement Contact for the organization for a certain purpose
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name S 1..1 HumanName A name associated with the contact
.... Slices for telecom S 2..* ContactPoint Contact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:Phone SC 1..1 SPLContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
spl-2.1.7.x: Telephone and fax numbers are formatted properly
spl-2.1.7.11: Emails are formatted properly
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Required Pattern: phone
...... value SΣ 1..1 string The actual contact point details
...... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... telecom:Email SC 1..1 SPLContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
spl-2.1.7.x: Telephone and fax numbers are formatted properly
spl-2.1.7.11: Emails are formatted properly
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Required Pattern: email
...... value SΣ 1..1 string The actual contact point details
...... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... address SC 1..1 SPLAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
spl-2.1.6.4: If the country is USA, then the state and postal code exist
spl-2.1.6.5: If the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
from the FHIR Standard
Organization.identifier:DUNSNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
from the FHIR Standard
Organization.typerequiredRegistrantOrganizationTypes
http://hl7.org/fhir/us/spl/ValueSet/valueset-registrantOrganizationTypes
from this IG
Organization.contact.telecom:Phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
from the FHIR Standard
Organization.contact.telecom:Phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
from the FHIR Standard
Organization.contact.telecom:Email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
from the FHIR Standard
Organization.contact.telecom:Email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorOrganization.contact.telecom:Phone, Organization.contact.telecom:EmailA system is required if a value is provided.
: value.empty() or system.exists()
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.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-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
spl-2.1.5.2errorOrganization.identifier:DUNSNumberDUNS number is 9 digits
: system = 'urn:oid:1.3.6.1.4.1.519.1' implies value.length() = 9
spl-2.1.6.4errorOrganization.contact.addressIf the country is USA, then the state and postal code exist
: country = 'USA' implies (state.exists() and state.length() = 2 and postalCode.exists())
spl-2.1.6.5errorOrganization.contact.addressIf the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers
: country = 'USA' implies postalCode.matches('^[0-9]{5}(-[0-9]{4})?$')
spl-2.1.7.11errorOrganization.contact.telecom:Phone, Organization.contact.telecom:EmailEmails are formatted properly
: system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$')
spl-2.1.7.xerrorOrganization.contact.telecom:Phone, Organization.contact.telecom:EmailTelephone and fax numbers are formatted properly
: (system = 'phone' or system = 'fax') implies value.matches('^\\+[0-9]{1,3}-[0-9]{1,3}-[0-9]{3,4}-[0-9]{4}(;ext=[0-9]+)?$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization This is an abstract profile. Child profiles: EstablishmentRegistrantOrganization, GDUFARegistrantOrganization
A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣC 1..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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 SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..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)
.... identifier:DUNSNumber SΣC 1..1 Identifier Identifies this organization across multiple systems
spl-2.1.5.2: DUNS number is 9 digits
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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
Required Pattern: urn:oid:1.3.6.1.4.1.519.1
..... 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)
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use
... type SΣ 1..1 CodeableConcept Kind of organization
Binding: Registrant Organization Types (required)
... name SΣC 1..1 string Name used for the organization
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom C 0..* ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address C 0..* Address An address for the organization
org-2: An address of an organization can never be of use 'home'
... partOf Σ 0..1 Reference(Organization) The organization of which this organization forms a part
... contact S 1..1 BackboneElement Contact for the organization for a certain purpose
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S 1..1 HumanName A name associated with the contact
.... Slices for telecom S 2..* ContactPoint Contact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:Phone SC 1..1 SPLContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
spl-2.1.7.x: Telephone and fax numbers are formatted properly
spl-2.1.7.11: Emails are formatted properly
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Required Pattern: phone
...... value SΣ 1..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
..... telecom:Email SC 1..1 SPLContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
spl-2.1.7.x: Telephone and fax numbers are formatted properly
spl-2.1.7.11: Emails are formatted properly
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Required Pattern: email
...... value SΣ 1..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
.... address SC 1..1 SPLAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
spl-2.1.6.4: If the country is USA, then the state and postal code exist
spl-2.1.6.5: If the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
from the FHIR Standard
Organization.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.identifier:DUNSNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
from the FHIR Standard
Organization.identifier:DUNSNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typerequiredRegistrantOrganizationTypes
http://hl7.org/fhir/us/spl/ValueSet/valueset-registrantOrganizationTypes
from this IG
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard
Organization.contact.telecom:Phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
from the FHIR Standard
Organization.contact.telecom:Phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
from the FHIR Standard
Organization.contact.telecom:Email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
from the FHIR Standard
Organization.contact.telecom:Email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorOrganization.contact.telecom:Phone, Organization.contact.telecom:EmailA system is required if a value is provided.
: value.empty() or system.exists()
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.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-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()
dom-r4bwarningOrganization.containedContaining 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-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-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
spl-2.1.5.2errorOrganization.identifier:DUNSNumberDUNS number is 9 digits
: system = 'urn:oid:1.3.6.1.4.1.519.1' implies value.length() = 9
spl-2.1.6.4errorOrganization.contact.addressIf the country is USA, then the state and postal code exist
: country = 'USA' implies (state.exists() and state.length() = 2 and postalCode.exists())
spl-2.1.6.5errorOrganization.contact.addressIf the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers
: country = 'USA' implies postalCode.matches('^[0-9]{5}(-[0-9]{4})?$')
spl-2.1.7.11errorOrganization.contact.telecom:Phone, Organization.contact.telecom:EmailEmails are formatted properly
: system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$')
spl-2.1.7.xerrorOrganization.contact.telecom:Phone, Organization.contact.telecom:EmailTelephone and fax numbers are formatted properly
: (system = 'phone' or system = 'fax') implies value.matches('^\\+[0-9]{1,3}-[0-9]{1,3}-[0-9]{3,4}-[0-9]{4}(;ext=[0-9]+)?$')

This structure is derived from Organization

Summary

Mandatory: 11 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Organization.identifier
  • The element 1 is sliced based on the value of Organization.contact.telecom

Maturity: 1

Differential View

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization Organization This is an abstract profile. Child profiles: EstablishmentRegistrantOrganization, GDUFARegistrantOrganization
... Slices for identifier S 1..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... system S 1..1 uri The namespace for the identifier value
..... value S 1..1 string The value that is unique
.... identifier:DUNSNumber SC 1..1 Identifier Identifies this organization across multiple systems
spl-2.1.5.2: DUNS number is 9 digits
..... system 0..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.3.6.1.4.1.519.1
... type S 1..1 CodeableConcept Kind of organization
Binding: Registrant Organization Types (required)
... name S 1..1 string Name used for the organization
.... name S 1..1 HumanName A name associated with the contact
.... Slices for telecom S 2..* ContactPoint Contact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:Phone S 1..1 SPLContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
...... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... telecom:Email S 1..1 SPLContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
...... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email
.... address S 1..1 SPLAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.typerequiredRegistrantOrganizationTypes
http://hl7.org/fhir/us/spl/ValueSet/valueset-registrantOrganizationTypes
from this IG

Constraints

IdGradePath(s)DetailsRequirements
spl-2.1.5.2errorOrganization.identifier:DUNSNumberDUNS number is 9 digits
: system = 'urn:oid:1.3.6.1.4.1.519.1' implies value.length() = 9

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization This is an abstract profile. Child profiles: EstablishmentRegistrantOrganization, GDUFARegistrantOrganization
A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣC 1..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:DUNSNumber SΣC 1..1 Identifier Identifies this organization across multiple systems
spl-2.1.5.2: DUNS number is 9 digits
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: urn:oid:1.3.6.1.4.1.519.1
... type SΣ 1..1 CodeableConcept Kind of organization
Binding: Registrant Organization Types (required)
... name SΣC 1..1 string Name used for the organization
... contact S 1..1 BackboneElement Contact for the organization for a certain purpose
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name S 1..1 HumanName A name associated with the contact
.... Slices for telecom S 2..* ContactPoint Contact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:Phone SC 1..1 SPLContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
spl-2.1.7.x: Telephone and fax numbers are formatted properly
spl-2.1.7.11: Emails are formatted properly
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Required Pattern: phone
...... value SΣ 1..1 string The actual contact point details
...... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... telecom:Email SC 1..1 SPLContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
spl-2.1.7.x: Telephone and fax numbers are formatted properly
spl-2.1.7.11: Emails are formatted properly
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Required Pattern: email
...... value SΣ 1..1 string The actual contact point details
...... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... address SC 1..1 SPLAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
spl-2.1.6.4: If the country is USA, then the state and postal code exist
spl-2.1.6.5: If the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
from the FHIR Standard
Organization.identifier:DUNSNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
from the FHIR Standard
Organization.typerequiredRegistrantOrganizationTypes
http://hl7.org/fhir/us/spl/ValueSet/valueset-registrantOrganizationTypes
from this IG
Organization.contact.telecom:Phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
from the FHIR Standard
Organization.contact.telecom:Phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
from the FHIR Standard
Organization.contact.telecom:Email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
from the FHIR Standard
Organization.contact.telecom:Email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorOrganization.contact.telecom:Phone, Organization.contact.telecom:EmailA system is required if a value is provided.
: value.empty() or system.exists()
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.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-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
spl-2.1.5.2errorOrganization.identifier:DUNSNumberDUNS number is 9 digits
: system = 'urn:oid:1.3.6.1.4.1.519.1' implies value.length() = 9
spl-2.1.6.4errorOrganization.contact.addressIf the country is USA, then the state and postal code exist
: country = 'USA' implies (state.exists() and state.length() = 2 and postalCode.exists())
spl-2.1.6.5errorOrganization.contact.addressIf the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers
: country = 'USA' implies postalCode.matches('^[0-9]{5}(-[0-9]{4})?$')
spl-2.1.7.11errorOrganization.contact.telecom:Phone, Organization.contact.telecom:EmailEmails are formatted properly
: system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$')
spl-2.1.7.xerrorOrganization.contact.telecom:Phone, Organization.contact.telecom:EmailTelephone and fax numbers are formatted properly
: (system = 'phone' or system = 'fax') implies value.matches('^\\+[0-9]{1,3}-[0-9]{1,3}-[0-9]{3,4}-[0-9]{4}(;ext=[0-9]+)?$')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization This is an abstract profile. Child profiles: EstablishmentRegistrantOrganization, GDUFARegistrantOrganization
A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣC 1..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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 SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..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)
.... identifier:DUNSNumber SΣC 1..1 Identifier Identifies this organization across multiple systems
spl-2.1.5.2: DUNS number is 9 digits
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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
Required Pattern: urn:oid:1.3.6.1.4.1.519.1
..... 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)
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use
... type SΣ 1..1 CodeableConcept Kind of organization
Binding: Registrant Organization Types (required)
... name SΣC 1..1 string Name used for the organization
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom C 0..* ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address C 0..* Address An address for the organization
org-2: An address of an organization can never be of use 'home'
... partOf Σ 0..1 Reference(Organization) The organization of which this organization forms a part
... contact S 1..1 BackboneElement Contact for the organization for a certain purpose
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name S 1..1 HumanName A name associated with the contact
.... Slices for telecom S 2..* ContactPoint Contact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:Phone SC 1..1 SPLContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
spl-2.1.7.x: Telephone and fax numbers are formatted properly
spl-2.1.7.11: Emails are formatted properly
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Required Pattern: phone
...... value SΣ 1..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
..... telecom:Email SC 1..1 SPLContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
spl-2.1.7.x: Telephone and fax numbers are formatted properly
spl-2.1.7.11: Emails are formatted properly
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Required Pattern: email
...... value SΣ 1..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
.... address SC 1..1 SPLAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
spl-2.1.6.4: If the country is USA, then the state and postal code exist
spl-2.1.6.5: If the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
from the FHIR Standard
Organization.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.identifier:DUNSNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.3.0
from the FHIR Standard
Organization.identifier:DUNSNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typerequiredRegistrantOrganizationTypes
http://hl7.org/fhir/us/spl/ValueSet/valueset-registrantOrganizationTypes
from this IG
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard
Organization.contact.telecom:Phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
from the FHIR Standard
Organization.contact.telecom:Phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
from the FHIR Standard
Organization.contact.telecom:Email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
from the FHIR Standard
Organization.contact.telecom:Email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorOrganization.contact.telecom:Phone, Organization.contact.telecom:EmailA system is required if a value is provided.
: value.empty() or system.exists()
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.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-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()
dom-r4bwarningOrganization.containedContaining 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-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-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
spl-2.1.5.2errorOrganization.identifier:DUNSNumberDUNS number is 9 digits
: system = 'urn:oid:1.3.6.1.4.1.519.1' implies value.length() = 9
spl-2.1.6.4errorOrganization.contact.addressIf the country is USA, then the state and postal code exist
: country = 'USA' implies (state.exists() and state.length() = 2 and postalCode.exists())
spl-2.1.6.5errorOrganization.contact.addressIf the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers
: country = 'USA' implies postalCode.matches('^[0-9]{5}(-[0-9]{4})?$')
spl-2.1.7.11errorOrganization.contact.telecom:Phone, Organization.contact.telecom:EmailEmails are formatted properly
: system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$')
spl-2.1.7.xerrorOrganization.contact.telecom:Phone, Organization.contact.telecom:EmailTelephone and fax numbers are formatted properly
: (system = 'phone' or system = 'fax') implies value.matches('^\\+[0-9]{1,3}-[0-9]{1,3}-[0-9]{3,4}-[0-9]{4}(;ext=[0-9]+)?$')

This structure is derived from Organization

Summary

Mandatory: 11 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Organization.identifier
  • The element 1 is sliced based on the value of Organization.contact.telecom

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron