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

SPL Mapping FHIR R5 Implementation Guide, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.2.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

Resource Profile: ImporterOrganization

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

A profile for the data elements required for an organization fulfilling the role of an importer for another organization.

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
... 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
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: Importer
... name S 1..1 string Name used for the organization
.... Slices for telecom S 2..* ContactPoint Contact details (e.g.phone/fax/url)
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

doco Documentation for this format

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 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
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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 .

..... 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
.... 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): Identifies the purpose for this identifier, if known .

..... system Σ 0..1 uri The namespace for the identifier value
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
... type SΣ 1..1 CodeableConcept Kind of organization
Binding: OrganizationType (example): Used to categorize the 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: Importer
... name SΣC 1..1 string Name used for the organization
... 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'
.... 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
...... 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.

..... 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): 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Organization.identifier:DUNSNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Organization.typeexamplePattern: Importer
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.contact.telecom:Phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Organization.contact.telecom:Phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Organization.contact.telecom:Email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Organization.contact.telecom:Email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-3errorOrganization.contactThe telecom of an organization can never be of use 'home'
: telecom.where(use = 'home').empty()
org-4errorOrganization.contactThe address of an organization can never be of use 'home'
: address.where(use = 'home').empty()
spl-2.1.5.2errorOrganization.identifier:DUNSNumberDUNS number is 9 digits
: system = 'urn:oid:1.3.6.1.4.1.519.1' implies value.length() = 9
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 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
... 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: OrganizationType (example): Used to categorize the organization.



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: Importer
..... 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 Σ 0..* 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 Σ 0..1 Address Address for the contact
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Organization.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.identifier:DUNSNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Organization.identifier:DUNSNumber.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typeexamplePattern: Importer
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.contact.purposepreferredContactEntityType
http://terminology.hl7.org/ValueSet/contactentity-type
Organization.contact.telecom:Phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Organization.contact.telecom:Phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Organization.contact.telecom:Email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Organization.contact.telecom:Email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Organization.qualification.codeexample

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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-3errorOrganization.contactThe telecom of an organization can never be of use 'home'
: telecom.where(use = 'home').empty()
org-4errorOrganization.contactThe address of an organization can never be of use 'home'
: address.where(use = 'home').empty()
spl-2.1.5.2errorOrganization.identifier:DUNSNumberDUNS number is 9 digits
: system = 'urn:oid:1.3.6.1.4.1.519.1' implies value.length() = 9
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: 9 elements
Must-Support: 10 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
... 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
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: Importer
... name S 1..1 string Name used for the organization
.... Slices for telecom S 2..* ContactPoint Contact details (e.g.phone/fax/url)
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

doco Documentation for this format

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 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
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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 .

..... 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
.... 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): Identifies the purpose for this identifier, if known .

..... system Σ 0..1 uri The namespace for the identifier value
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
... type SΣ 1..1 CodeableConcept Kind of organization
Binding: OrganizationType (example): Used to categorize the 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: Importer
... name SΣC 1..1 string Name used for the organization
... 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'
.... 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
...... 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.

..... 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): 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.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Organization.identifier:DUNSNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Organization.typeexamplePattern: Importer
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.contact.telecom:Phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Organization.contact.telecom:Phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Organization.contact.telecom:Email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Organization.contact.telecom:Email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-3errorOrganization.contactThe telecom of an organization can never be of use 'home'
: telecom.where(use = 'home').empty()
org-4errorOrganization.contactThe address of an organization can never be of use 'home'
: address.where(use = 'home').empty()
spl-2.1.5.2errorOrganization.identifier:DUNSNumberDUNS number is 9 digits
: system = 'urn:oid:1.3.6.1.4.1.519.1' implies value.length() = 9
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 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
... 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: OrganizationType (example): Used to categorize the organization.



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: Importer
..... 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 Σ 0..* 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 Σ 0..1 Address Address for the contact
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Organization.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.identifier:DUNSNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Organization.identifier:DUNSNumber.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typeexamplePattern: Importer
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.contact.purposepreferredContactEntityType
http://terminology.hl7.org/ValueSet/contactentity-type
Organization.contact.telecom:Phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Organization.contact.telecom:Phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Organization.contact.telecom:Email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Organization.contact.telecom:Email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Organization.qualification.codeexample

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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-3errorOrganization.contactThe telecom of an organization can never be of use 'home'
: telecom.where(use = 'home').empty()
org-4errorOrganization.contactThe address of an organization can never be of use 'home'
: address.where(use = 'home').empty()
spl-2.1.5.2errorOrganization.identifier:DUNSNumberDUNS number is 9 digits
: system = 'urn:oid:1.3.6.1.4.1.519.1' implies value.length() = 9
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: 9 elements
Must-Support: 10 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