CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• JSON

Resource Profile: OrganizationSEVendorLite

Introduction

This is a light weight Swedish healthcare Organization profile. It can be used when Organizations have been referenced by other resources, such as Observation, ServiceRequest or Appointment. It can also be used for presenting a list of organizations with associated information.

Note that this profile is not maintained by Cambio, but is created in a Swedish vendor FHIR collaboration. Link to ImplementationGuide for the collaborative profiles will be added here shortly.

Intended Use

Intended use for this API is to get information about a healthcare organization, including units. The profile includes an extension which supports finding out the HSA care provider and HSA care unit for the specific organization. Following partOf reference can also be used to retrieve information about the whole organizational tree.

The profile is also referenced as target profile from many other resources enabling possibility to e.g. find PDL units connected to a certain resource, e.g. ServiceRequest or Organization. More information about this can be found on other resources in this ImplementationGuide.

The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between care providers, patient consent must be handled outside the API.

Specific Rules and Limitations

Versions

APIs & Supported Operations

Search Parameters

Supported Queries

1. GET [baseURL]/Organization/[id] (get by id)
2. GET [baseURL]/Organization/_search?identifier=[identifier] (Search)
3. GET [baseURL]/Organization/_search?name[name]= (Search)
4. GET [baseURL]/Organization/_search?_id=[id1],[id2],[id3] (Search)
5. GET [baseURL]/Organization/_search?_profile=[url] (Search)
6. POST [baseURL]/Organization (Post)
7. PUT [baseURL]/Organization (Put)

Supported _include params

1. partOf

Usages:

• Refer to this Profile: EncounterLite, ObservationNews2Lite and PractitionerRoleLiteSe
• Examples for this Profile: Medicinkliniken
• CapabilityStatements using this Profile: Cambio Open Services

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization	C	0..*	Organization	A grouping of people or organizations with a common purpose Constraints: org-1
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:hsaHierarchy		0..*	(Complex)	Extension URL: https://commonprofiles.care/StructureDefinition/common-hsaHierarchy/v1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	ΣC	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:system
identifier:hsaid	ΣC	0..1	Identifier	Identifies this organization across multiple systems
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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Fixed Value: As shown (Provider number)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PRN
display		0..0	string	Representation defined by the system
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.752.129.2.1.4.1
value	Σ	1..1	string	The value that is unique Example General: 123456
identifier:organizationIdentifier	ΣC	0..1	Identifier	Identifies this organization across multiple systems
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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Fixed Value: As shown (Organization identifier)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: XX
display		0..0	string	Representation defined by the system
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.5.4.97
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
Slices for type	Σ	0..*	CodeableConcept	Kind of organization Slice: Unordered, Open by value:coding.code Binding: OrganizationType (example): Used to categorize the organization.
type:careUnit	Σ	0..*	CodeableConcept	Kind of organization Binding: OrganizationType (example): Used to categorize the organization.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	1..1	string	Version of the system - if relevant Fixed Value: http://snomed.info/sct/45991000052106
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 43741000
type:careProvider	Σ	0..*	CodeableConcept	Kind of organization Binding: OrganizationType (example): Used to categorize the organization.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	1..1	string	Version of the system - if relevant Fixed Value: http://snomed.info/sct/45991000052106
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 143591000052106
name	ΣC	1..1	string	Name used for the organization
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Organization.identifier:hsaid.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Organization.identifier:hsaid.type	extensible	Fixed Value: PRN http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Organization.identifier:organizationIdentifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Organization.identifier:organizationIdentifier.type	extensible	Fixed Value: XX http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Organization.type	example	OrganizationType http://hl7.org/fhir/ValueSet/organization-type From the FHIR Standard
Organization.type:careUnit	example	OrganizationType http://hl7.org/fhir/ValueSet/organization-type From the FHIR Standard
Organization.type:careProvider	example	OrganizationType http://hl7.org/fhir/ValueSet/organization-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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().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	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

This structure is derived from Organization

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization			Organization
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:hsaHierarchy		0..*	(Complex)	Extension URL: https://commonprofiles.care/StructureDefinition/common-hsaHierarchy/v1
Slices for identifier		0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:system
identifier:hsaid		0..1	Identifier	Identifies this organization across multiple systems
type		0..1	CodeableConcept	Description of identifier Fixed Value: As shown (Provider number)
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PRN
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.752.129.2.1.4.1
value		1..1	string	The value that is unique
identifier:organizationIdentifier		0..1	Identifier	Identifies this organization across multiple systems
type		0..1	CodeableConcept	Description of identifier Fixed Value: As shown (Organization identifier)
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: XX
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.5.4.97
Slices for type		0..*	CodeableConcept	Kind of organization Slice: Unordered, Open by value:coding.code
type:careUnit		0..*	CodeableConcept	Kind of organization
coding		1..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		1..1	string	Version of the system - if relevant Fixed Value: http://snomed.info/sct/45991000052106
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 43741000
type:careProvider		0..*	CodeableConcept	Kind of organization
coding		1..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		1..1	string	Version of the system - if relevant Fixed Value: http://snomed.info/sct/45991000052106
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 143591000052106
name		1..1	string	Name used for the organization
telecom
period		0..0
address
line
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:careOf		0..*	string	careOf URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
extension:streetAddressLine		0..*	string	streetAddressLine URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine
period		0..0
contact		0..0
endpoint		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization	C	0..*	Organization	A grouping of people or organizations with a common purpose Constraints: org-1
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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:hsaHierarchy		0..*	(Complex)	Extension URL: https://commonprofiles.care/StructureDefinition/common-hsaHierarchy/v1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	ΣC	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:system
identifier:hsaid	ΣC	0..1	Identifier	Identifies this organization across multiple systems
id		0..1	string	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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Fixed Value: As shown (Provider number)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PRN
display		0..0	string	Representation defined by the system
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.752.129.2.1.4.1
value	Σ	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:organizationIdentifier	ΣC	0..1	Identifier	Identifies this organization across multiple systems
id		0..1	string	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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Fixed Value: As shown (Organization identifier)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: XX
display		0..0	string	Representation defined by the system
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.5.4.97
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
Slices for type	Σ	0..*	CodeableConcept	Kind of organization Slice: Unordered, Open by value:coding.code Binding: OrganizationType (example): Used to categorize the organization.
type:careUnit	Σ	0..*	CodeableConcept	Kind of organization Binding: OrganizationType (example): Used to categorize the organization.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	1..1	string	Version of the system - if relevant Fixed Value: http://snomed.info/sct/45991000052106
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 43741000
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
type:careProvider	Σ	0..*	CodeableConcept	Kind of organization Binding: OrganizationType (example): Used to categorize the organization.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	1..1	string	Version of the system - if relevant Fixed Value: http://snomed.info/sct/45991000052106
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 143591000052106
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	ΣC	1..1	string	Name used for the organization
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	C	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..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)
address	C	0..*	Address	An address for the organization Constraints: org-2
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	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
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:careOf		0..*	string	careOf URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
extension:streetAddressLine		0..*	string	streetAddressLine URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine
value		0..1	string	Primitive value for string Max Length:1048576
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Organization.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Organization.identifier:hsaid.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Organization.identifier:hsaid.type	extensible	Fixed Value: PRN http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Organization.identifier:organizationIdentifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Organization.identifier:organizationIdentifier.type	extensible	Fixed Value: XX http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Organization.type	example	OrganizationType http://hl7.org/fhir/ValueSet/organization-type From the FHIR Standard
Organization.type:careUnit	example	OrganizationType http://hl7.org/fhir/ValueSet/organization-type From the FHIR Standard
Organization.type:careProvider	example	OrganizationType http://hl7.org/fhir/ValueSet/organization-type From the FHIR Standard
Organization.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard
Organization.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
Organization.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 From the FHIR Standard
Organization.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 From the FHIR Standard
Organization.contact.purpose	extensible	ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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().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	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-2	error	Organization.address	An address of an organization can never be of use 'home' : where(use = 'home').empty()
org-3	error	Organization.telecom	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()

This structure is derived from Organization

Summary

Mandatory: 1 element(11 nested mandatory elements)
Fixed: 10 elements
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

• https://commonprofiles.care/StructureDefinition/common-hsaHierarchy/v1
• http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
• http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization	C	0..*	Organization	A grouping of people or organizations with a common purpose Constraints: org-1
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:hsaHierarchy		0..*	(Complex)	Extension URL: https://commonprofiles.care/StructureDefinition/common-hsaHierarchy/v1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	ΣC	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:system
identifier:hsaid	ΣC	0..1	Identifier	Identifies this organization across multiple systems
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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Fixed Value: As shown (Provider number)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PRN
display		0..0	string	Representation defined by the system
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.752.129.2.1.4.1
value	Σ	1..1	string	The value that is unique Example General: 123456
identifier:organizationIdentifier	ΣC	0..1	Identifier	Identifies this organization across multiple systems
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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Fixed Value: As shown (Organization identifier)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: XX
display		0..0	string	Representation defined by the system
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.5.4.97
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
Slices for type	Σ	0..*	CodeableConcept	Kind of organization Slice: Unordered, Open by value:coding.code Binding: OrganizationType (example): Used to categorize the organization.
type:careUnit	Σ	0..*	CodeableConcept	Kind of organization Binding: OrganizationType (example): Used to categorize the organization.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	1..1	string	Version of the system - if relevant Fixed Value: http://snomed.info/sct/45991000052106
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 43741000
type:careProvider	Σ	0..*	CodeableConcept	Kind of organization Binding: OrganizationType (example): Used to categorize the organization.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	1..1	string	Version of the system - if relevant Fixed Value: http://snomed.info/sct/45991000052106
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 143591000052106
name	ΣC	1..1	string	Name used for the organization
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Organization.identifier:hsaid.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Organization.identifier:hsaid.type	extensible	Fixed Value: PRN http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Organization.identifier:organizationIdentifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Organization.identifier:organizationIdentifier.type	extensible	Fixed Value: XX http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Organization.type	example	OrganizationType http://hl7.org/fhir/ValueSet/organization-type From the FHIR Standard
Organization.type:careUnit	example	OrganizationType http://hl7.org/fhir/ValueSet/organization-type From the FHIR Standard
Organization.type:careProvider	example	OrganizationType http://hl7.org/fhir/ValueSet/organization-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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().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	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

Differential View

This structure is derived from Organization

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization			Organization
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:hsaHierarchy		0..*	(Complex)	Extension URL: https://commonprofiles.care/StructureDefinition/common-hsaHierarchy/v1
Slices for identifier		0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:system
identifier:hsaid		0..1	Identifier	Identifies this organization across multiple systems
type		0..1	CodeableConcept	Description of identifier Fixed Value: As shown (Provider number)
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PRN
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.752.129.2.1.4.1
value		1..1	string	The value that is unique
identifier:organizationIdentifier		0..1	Identifier	Identifies this organization across multiple systems
type		0..1	CodeableConcept	Description of identifier Fixed Value: As shown (Organization identifier)
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: XX
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.5.4.97
Slices for type		0..*	CodeableConcept	Kind of organization Slice: Unordered, Open by value:coding.code
type:careUnit		0..*	CodeableConcept	Kind of organization
coding		1..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		1..1	string	Version of the system - if relevant Fixed Value: http://snomed.info/sct/45991000052106
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 43741000
type:careProvider		0..*	CodeableConcept	Kind of organization
coding		1..1	Coding	Code defined by a terminology system
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version		1..1	string	Version of the system - if relevant Fixed Value: http://snomed.info/sct/45991000052106
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 143591000052106
name		1..1	string	Name used for the organization
telecom
period		0..0
address
line
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:careOf		0..*	string	careOf URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
extension:streetAddressLine		0..*	string	streetAddressLine URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine
period		0..0
contact		0..0
endpoint		0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization	C	0..*	Organization	A grouping of people or organizations with a common purpose Constraints: org-1
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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:hsaHierarchy		0..*	(Complex)	Extension URL: https://commonprofiles.care/StructureDefinition/common-hsaHierarchy/v1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	ΣC	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:system
identifier:hsaid	ΣC	0..1	Identifier	Identifies this organization across multiple systems
id		0..1	string	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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Fixed Value: As shown (Provider number)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PRN
display		0..0	string	Representation defined by the system
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.752.129.2.1.4.1
value	Σ	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:organizationIdentifier	ΣC	0..1	Identifier	Identifies this organization across multiple systems
id		0..1	string	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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Fixed Value: As shown (Organization identifier)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: XX
display		0..0	string	Representation defined by the system
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.5.4.97
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
Slices for type	Σ	0..*	CodeableConcept	Kind of organization Slice: Unordered, Open by value:coding.code Binding: OrganizationType (example): Used to categorize the organization.
type:careUnit	Σ	0..*	CodeableConcept	Kind of organization Binding: OrganizationType (example): Used to categorize the organization.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	1..1	string	Version of the system - if relevant Fixed Value: http://snomed.info/sct/45991000052106
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 43741000
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
type:careProvider	Σ	0..*	CodeableConcept	Kind of organization Binding: OrganizationType (example): Used to categorize the organization.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	1..1	string	Version of the system - if relevant Fixed Value: http://snomed.info/sct/45991000052106
code	Σ	1..1	code	Symbol in syntax defined by the system Fixed Value: 143591000052106
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	ΣC	1..1	string	Name used for the organization
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	C	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..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)
address	C	0..*	Address	An address for the organization Constraints: org-2
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	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
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:careOf		0..*	string	careOf URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
extension:streetAddressLine		0..*	string	streetAddressLine URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine
value		0..1	string	Primitive value for string Max Length:1048576
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Organization.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Organization.identifier:hsaid.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Organization.identifier:hsaid.type	extensible	Fixed Value: PRN http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Organization.identifier:organizationIdentifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Organization.identifier:organizationIdentifier.type	extensible	Fixed Value: XX http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Organization.type	example	OrganizationType http://hl7.org/fhir/ValueSet/organization-type From the FHIR Standard
Organization.type:careUnit	example	OrganizationType http://hl7.org/fhir/ValueSet/organization-type From the FHIR Standard
Organization.type:careProvider	example	OrganizationType http://hl7.org/fhir/ValueSet/organization-type From the FHIR Standard
Organization.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard
Organization.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard
Organization.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 From the FHIR Standard
Organization.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 From the FHIR Standard
Organization.contact.purpose	extensible	ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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().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	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-2	error	Organization.address	An address of an organization can never be of use 'home' : where(use = 'home').empty()
org-3	error	Organization.telecom	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()

This structure is derived from Organization

Summary

Mandatory: 1 element(11 nested mandatory elements)
Fixed: 10 elements
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

• https://commonprofiles.care/StructureDefinition/common-hsaHierarchy/v1
• http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
• http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine

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

Other representations of profile: CSV, Excel, Schematron