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.1 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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: EstablishmentRegistrantOrganization

A specialization of the RegistrantOrganization profile that fixes the type to EstablishmentRegistrant

Usage:

• Use this Resource Profile: EstablishmentRegistrationBundle
• Refer to this Resource Profile: EstablishmentAffiliation and EstablishmentRegistrationMessage
• Examples for this Resource Profile: REGISTRANT SERVICES INC

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from RegistrantOrganization

Name	Flags	Card.	Type	Description & Constraints
Organization			RegistrantOrganization
type		1..1	CodeableConcept	Kind of organization 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: EstablishmentRegistrant
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	RegistrantOrganization	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
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
contained		0..*	Resource	Contained, inline Resources
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
Slices for identifier	SΣC	1..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
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	Σ	0..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: urn:oid:1.3.6.1.4.1.519.1
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: Registrant Organization Types (required) 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: EstablishmentRegistrant
name	SΣC	1..1	string	Name used for the organization ele-1: All FHIR elements must have a @value or children
contact	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'
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	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. ele-1: All FHIR elements must have a @value or children 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): 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	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. ele-1: All FHIR elements must have a @value or children 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): 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	SC	1..1	SPLAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats) ele-1: All FHIR elements must have a @value or children 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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Organization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard
Organization.identifier:DUNSNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard
Organization.type	required	Pattern: EstablishmentRegistrant http://hl7.org/fhir/us/spl/ValueSet/valueset-registrantOrganizationTypes from this IG
Organization.contact.telecom:Phone.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard
Organization.contact.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard
Organization.contact.telecom:Email.system	required	Pattern: email http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard
Organization.contact.telecom:Email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cpt-2	error	Organization.contact.telecom:Phone, Organization.contact.telecom:Email	A system is required if a value is provided. : value.empty() or system.exists()
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Organization	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	Organization	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	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Organization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0
org-3	error	Organization.contact	The telecom of an organization can never be of use 'home' : telecom.where(use = 'home').empty()
org-4	error	Organization.contact	The address of an organization can never be of use 'home' : address.where(use = 'home').empty()
spl-2.1.5.2	error	Organization.identifier:DUNSNumber	DUNS number is 9 digits : system = 'urn:oid:1.3.6.1.4.1.519.1' implies value.length() = 9
spl-2.1.6.4	error	Organization.contact.address	If 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.5	error	Organization.contact.address	If 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.11	error	Organization.contact.telecom:Phone, Organization.contact.telecom:Email	Emails are formatted properly : system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$')
spl-2.1.7.x	error	Organization.contact.telecom:Phone, Organization.contact.telecom:Email	Telephone 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]+)?$')

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	RegistrantOrganization	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
language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
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): 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	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣC	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): 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 Required Pattern: urn:oid:1.3.6.1.4.1.519.1
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)
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) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/spl/CodeSystem/codesystem-organizationTypes
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: EstablishmentRegistrant
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
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
description	Σ	0..1	markdown	Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name
contact	SC	1..1	ExtendedContactDetail	Official contact details for the Organization 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'
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
purpose	Σ	0..1	CodeableConcept	The type of contact Binding: Contact entity type (preferred): The purpose for which an extended contact detail should be used.
name	SΣ	1..1	HumanName	Name of an individual to contact
Slices for telecom	SΣ	2..*	ContactPoint	Contact details (e.g.phone/fax/url) 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): Telecommunications form for contact point. Required Pattern: phone
value	SΣC	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): 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
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): Telecommunications form for contact point. Required Pattern: email
value	SΣC	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): 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
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
organization	Σ	0..1	Reference(Organization)	This contact detail is handled/monitored by a specific organization
period	Σ	0..1	Period	Period that this contact was valid for usage
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
qualification		0..*	BackboneElement	Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care
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
identifier		0..*	Identifier	An identifier for this qualification for the organization
code		1..1	CodeableConcept	Coded representation of the qualification Binding Description (No ValueSet): (example): Specific qualification the organization has to provide a service.
period		0..1	Period	Period during which the qualification is valid
issuer		0..1	Reference(Organization)	Organization that regulates and issues the qualification
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Organization.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Organization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard
Organization.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Organization.identifier:DUNSNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard
Organization.identifier:DUNSNumber.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Organization.type	required	Pattern: EstablishmentRegistrant http://hl7.org/fhir/us/spl/ValueSet/valueset-registrantOrganizationTypes from this IG
Organization.contact.purpose	preferred	ContactEntityType http://terminology.hl7.org/ValueSet/contactentity-type
Organization.contact.telecom:Phone.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard
Organization.contact.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard
Organization.contact.telecom:Email.system	required	Pattern: email http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard
Organization.contact.telecom:Email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard
Organization.qualification.code	example

Constraints

Id	Grade	Path(s)	Details	Requirements
cpt-2	error	Organization.contact.telecom:Phone, Organization.contact.telecom:Email	A system is required if a value is provided. : value.empty() or system.exists()
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Organization	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	Organization	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	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Organization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0
org-3	error	Organization.contact	The telecom of an organization can never be of use 'home' : telecom.where(use = 'home').empty()
org-4	error	Organization.contact	The address of an organization can never be of use 'home' : address.where(use = 'home').empty()
spl-2.1.5.2	error	Organization.identifier:DUNSNumber	DUNS number is 9 digits : system = 'urn:oid:1.3.6.1.4.1.519.1' implies value.length() = 9
spl-2.1.6.4	error	Organization.contact.address	If 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.5	error	Organization.contact.address	If 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.11	error	Organization.contact.telecom:Phone, Organization.contact.telecom:Email	Emails are formatted properly : system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$')
spl-2.1.7.x	error	Organization.contact.telecom:Phone, Organization.contact.telecom:Email	Telephone 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 RegistrantOrganization

Summary

Maturity: 1

Differential View

This structure is derived from RegistrantOrganization

Name	Flags	Card.	Type	Description & Constraints
Organization			RegistrantOrganization
type		1..1	CodeableConcept	Kind of organization 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: EstablishmentRegistrant
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	RegistrantOrganization	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
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
contained		0..*	Resource	Contained, inline Resources
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
Slices for identifier	SΣC	1..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
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	Σ	0..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: urn:oid:1.3.6.1.4.1.519.1
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: Registrant Organization Types (required) 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: EstablishmentRegistrant
name	SΣC	1..1	string	Name used for the organization ele-1: All FHIR elements must have a @value or children
contact	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'
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	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. ele-1: All FHIR elements must have a @value or children 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): 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	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. ele-1: All FHIR elements must have a @value or children 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): 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	SC	1..1	SPLAddress	An address expressed using postal conventions (as opposed to GPS or other location definition formats) ele-1: All FHIR elements must have a @value or children 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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Organization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard
Organization.identifier:DUNSNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard
Organization.type	required	Pattern: EstablishmentRegistrant http://hl7.org/fhir/us/spl/ValueSet/valueset-registrantOrganizationTypes from this IG
Organization.contact.telecom:Phone.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard
Organization.contact.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard
Organization.contact.telecom:Email.system	required	Pattern: email http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard
Organization.contact.telecom:Email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cpt-2	error	Organization.contact.telecom:Phone, Organization.contact.telecom:Email	A system is required if a value is provided. : value.empty() or system.exists()
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Organization	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	Organization	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	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Organization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0
org-3	error	Organization.contact	The telecom of an organization can never be of use 'home' : telecom.where(use = 'home').empty()
org-4	error	Organization.contact	The address of an organization can never be of use 'home' : address.where(use = 'home').empty()
spl-2.1.5.2	error	Organization.identifier:DUNSNumber	DUNS number is 9 digits : system = 'urn:oid:1.3.6.1.4.1.519.1' implies value.length() = 9
spl-2.1.6.4	error	Organization.contact.address	If 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.5	error	Organization.contact.address	If 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.11	error	Organization.contact.telecom:Phone, Organization.contact.telecom:Email	Emails are formatted properly : system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$')
spl-2.1.7.x	error	Organization.contact.telecom:Phone, Organization.contact.telecom:Email	Telephone 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

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	RegistrantOrganization	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
language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
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): 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	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣC	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): 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 Required Pattern: urn:oid:1.3.6.1.4.1.519.1
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)
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) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/spl/CodeSystem/codesystem-organizationTypes
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: EstablishmentRegistrant
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
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
description	Σ	0..1	markdown	Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name
contact	SC	1..1	ExtendedContactDetail	Official contact details for the Organization 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'
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
purpose	Σ	0..1	CodeableConcept	The type of contact Binding: Contact entity type (preferred): The purpose for which an extended contact detail should be used.
name	SΣ	1..1	HumanName	Name of an individual to contact
Slices for telecom	SΣ	2..*	ContactPoint	Contact details (e.g.phone/fax/url) 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): Telecommunications form for contact point. Required Pattern: phone
value	SΣC	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): 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
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): Telecommunications form for contact point. Required Pattern: email
value	SΣC	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): 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
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
organization	Σ	0..1	Reference(Organization)	This contact detail is handled/monitored by a specific organization
period	Σ	0..1	Period	Period that this contact was valid for usage
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
qualification		0..*	BackboneElement	Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care
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
identifier		0..*	Identifier	An identifier for this qualification for the organization
code		1..1	CodeableConcept	Coded representation of the qualification Binding Description (No ValueSet): (example): Specific qualification the organization has to provide a service.
period		0..1	Period	Period during which the qualification is valid
issuer		0..1	Reference(Organization)	Organization that regulates and issues the qualification
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Organization.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
Organization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard
Organization.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Organization.identifier:DUNSNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard
Organization.identifier:DUNSNumber.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Organization.type	required	Pattern: EstablishmentRegistrant http://hl7.org/fhir/us/spl/ValueSet/valueset-registrantOrganizationTypes from this IG
Organization.contact.purpose	preferred	ContactEntityType http://terminology.hl7.org/ValueSet/contactentity-type
Organization.contact.telecom:Phone.system	required	Pattern: phone http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard
Organization.contact.telecom:Phone.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard
Organization.contact.telecom:Email.system	required	Pattern: email http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard
Organization.contact.telecom:Email.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard
Organization.qualification.code	example

Constraints

Id	Grade	Path(s)	Details	Requirements
cpt-2	error	Organization.contact.telecom:Phone, Organization.contact.telecom:Email	A system is required if a value is provided. : value.empty() or system.exists()
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Organization	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	Organization	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	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Organization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0
org-3	error	Organization.contact	The telecom of an organization can never be of use 'home' : telecom.where(use = 'home').empty()
org-4	error	Organization.contact	The address of an organization can never be of use 'home' : address.where(use = 'home').empty()
spl-2.1.5.2	error	Organization.identifier:DUNSNumber	DUNS number is 9 digits : system = 'urn:oid:1.3.6.1.4.1.519.1' implies value.length() = 9
spl-2.1.6.4	error	Organization.contact.address	If 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.5	error	Organization.contact.address	If 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.11	error	Organization.contact.telecom:Phone, Organization.contact.telecom:Email	Emails are formatted properly : system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$')
spl-2.1.7.x	error	Organization.contact.telecom:Phone, Organization.contact.telecom:Email	Telephone 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 RegistrantOrganization

Summary

Maturity: 1

Other representations of profile: CSV, Excel, Schematron