HL7.FHIR.US.BSER\BSeR_Organization

BSeR: Bidirectional Services_eReferral

This page is part of the Bidirectional Services eReferrals (BSeR) (v1.0.0: STU 1) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

StructureDefinition: BSeR_Organization

An organization resource playing the roles of practitioner affiliated organization, patient coverage payer organization, or patient employer organization.

The official URL for this profile is:

http://hl7.org/fhir/us/bser/StructureDefinition/BSeR-Organization

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
All

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 1 element (2 nested mandatory elements)
Must-Support: 7 elements

This structure is derived from USCoreOrganizationProfile

Name	Flags	Card.	Type
Organization		0..*	USCoreOrganizationProfile
type		1..1	CodeableConcept
telecom	S	0..*	ContactPoint
system	S	1..1	code
value	S	1..1	string
use	S	0..1	code
address	S	0..*	Address
use	S	0..1	code
text	S	0..1	string
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Organization	I	0..*	USCoreOrganizationProfile	A grouping of people or organizations with a common purpose
id	Σ	0..1	string	Logical id of this artifact
meta	ΣI	0..1	Meta	Metadata about the resource
implicitRules	?!ΣI	0..1	uri	A set of rules under which this content was created
language	I	0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!I	0..*	Extension	Extensions that cannot be ignored
identifier	SΣI	0..*	(Slice Definition)	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!ΣI	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required)
type	ΣI	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
system	SΣI	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣI	0..1	string	The value that is unique Example General: 123456
period	ΣI	0..1	Period	Time period when id is/was valid for use
assigner	ΣI	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:NPI	SΣI	0..1	Identifier	National Provider Identifier (NPI) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual \| official \| temp \| secondary \| old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value		0..1	string	The value that is unique
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:CLIA	SΣI	0..1	Identifier	Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual \| official \| temp \| secondary \| old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7
value		0..1	string	The value that is unique
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	?!SΣI	1..1	boolean	Whether the organization's record is still in active use
type	ΣI	1..1	CodeableConcept	Kind of organization Binding: OrganizationType (example)
name	SΣI	1..1	string	Name used for the organization
alias	I	0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	SI	0..*	ContactPoint	A contact detail for the organization
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣI	1..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required)
value	SΣI	1..1	string	The actual contact point details
use	?!SΣI	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required)
rank	ΣI	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	ΣI	0..1	Period	Time period when the contact point was/is in use
address	SI	0..*	Address	An address for the organization
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣI	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required) Example General: home
type	ΣI	0..1	code	postal \| physical \| both Binding: AddressType (required) Example General: both
text	SΣI	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣI	0..4	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣI	0..1	string	Name of city, town etc. Example General: Erewhon
district	ΣI	0..1	string	District name (aka county) Example General: Madison
state	SΣI	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible)
postalCode	SΣI	0..1	string	US Zip Codes Example General: 9132
country	SΣI	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	ΣI	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-22T13:00:00+00:00","end":"2010-06-30T14:00:00+00:00"}
partOf	ΣI	0..1	Reference(Organization)	The organization of which this organization forms a part
contact	I	0..*	BackboneElement	Contact for the organization for a certain purpose
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
purpose	I	0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible)
name	I	0..1	HumanName	A name associated with the contact
telecom	I	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address	I	0..1	Address	Visiting or postal addresses for the contact
endpoint	I	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
Documentation for this format

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 1 element (2 nested mandatory elements)
Must-Support: 7 elements

Differential View

This structure is derived from USCoreOrganizationProfile

Name	Flags	Card.	Type
Organization		0..*	USCoreOrganizationProfile
type		1..1	CodeableConcept
telecom	S	0..*	ContactPoint
system	S	1..1	code
value	S	1..1	string
use	S	0..1	code
address	S	0..*	Address
use	S	0..1	code
text	S	0..1	string
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Organization	I	0..*	USCoreOrganizationProfile	A grouping of people or organizations with a common purpose
id	Σ	0..1	string	Logical id of this artifact
meta	ΣI	0..1	Meta	Metadata about the resource
implicitRules	?!ΣI	0..1	uri	A set of rules under which this content was created
language	I	0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!I	0..*	Extension	Extensions that cannot be ignored
identifier	SΣI	0..*	(Slice Definition)	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!ΣI	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required)
type	ΣI	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
system	SΣI	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣI	0..1	string	The value that is unique Example General: 123456
period	ΣI	0..1	Period	Time period when id is/was valid for use
assigner	ΣI	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:NPI	SΣI	0..1	Identifier	National Provider Identifier (NPI) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual \| official \| temp \| secondary \| old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value		0..1	string	The value that is unique
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:CLIA	SΣI	0..1	Identifier	Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual \| official \| temp \| secondary \| old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7
value		0..1	string	The value that is unique
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	?!SΣI	1..1	boolean	Whether the organization's record is still in active use
type	ΣI	1..1	CodeableConcept	Kind of organization Binding: OrganizationType (example)
name	SΣI	1..1	string	Name used for the organization
alias	I	0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	SI	0..*	ContactPoint	A contact detail for the organization
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣI	1..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required)
value	SΣI	1..1	string	The actual contact point details
use	?!SΣI	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required)
rank	ΣI	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	ΣI	0..1	Period	Time period when the contact point was/is in use
address	SI	0..*	Address	An address for the organization
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!SΣI	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required) Example General: home
type	ΣI	0..1	code	postal \| physical \| both Binding: AddressType (required) Example General: both
text	SΣI	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣI	0..4	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣI	0..1	string	Name of city, town etc. Example General: Erewhon
district	ΣI	0..1	string	District name (aka county) Example General: Madison
state	SΣI	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible)
postalCode	SΣI	0..1	string	US Zip Codes Example General: 9132
country	SΣI	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	ΣI	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-22T13:00:00+00:00","end":"2010-06-30T14:00:00+00:00"}
partOf	ΣI	0..1	Reference(Organization)	The organization of which this organization forms a part
contact	I	0..*	BackboneElement	Contact for the organization for a certain purpose
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
purpose	I	0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible)
name	I	0..1	HumanName	A name associated with the contact
telecom	I	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address	I	0..1	Address	Visiting or postal addresses for the contact
endpoint	I	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
Documentation for this format

Other representations of profile: Schematron

Terminology Bindings

Path	Conformance	ValueSet
Organization.language	preferred	CommonLanguages Max Binding: AllLanguages
Organization.identifier.use	required	IdentifierUse
Organization.identifier.type	extensible	Identifier Type Codes
Organization.type	example	OrganizationType
Organization.telecom.system	required	ContactPointSystem
Organization.telecom.use	required	ContactPointUse
Organization.address.use	required	AddressUse
Organization.address.type	required	AddressType
Organization.address.state	extensible	UspsTwoLetterAlphabeticCodes
Organization.contact.purpose	extensible	ContactEntityType

Constraints

Id	Path	Details	Requirements
dom-2	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	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().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	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	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Organization	A resource should have narrative for robust management : text.`div`.exists()
org-1	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0
ele-1	Organization.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Organization.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Organization.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Organization.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Organization.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.identifier.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Organization.identifier.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Organization.identifier.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.identifier.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.identifier.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.identifier.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.identifier.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.identifier.assigner	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.identifier:NPI	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.identifier:CLIA	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.active	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.alias	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.telecom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
org-3	Organization.telecom	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()
ele-1	Organization.telecom.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Organization.telecom.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Organization.telecom.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.telecom.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.telecom.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.telecom.rank	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.telecom.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
org-2	Organization.address	An address of an organization can never be of use 'home' : where(use = 'home').empty()
ele-1	Organization.address.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Organization.address.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Organization.address.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address.line	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address.city	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address.district	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address.state	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address.postalCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address.country	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.address.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.partOf	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.contact	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.contact.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Organization.contact.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Organization.contact.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Organization.contact.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Organization.contact.purpose	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.contact.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.contact.telecom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.contact.address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Organization.endpoint	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

IG © 2019+ HL7 International - Public Health Work Group. Package hl7.fhir.us.bser#1.0.0 based on FHIR 4.0.1. Generated 2020-03-02
Links: Table of Contents | QA Report | Search | Version History external | | Propose a change