BioMaxis Implementation Guide - Local Development build (v0.0.0-semantic-release) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: BioMaxis Organization

A profile for the Organization resource used in BioMaxis. This profile includes optional extensions for bank account details and documents.

Usages:

• This Profile is not used by any profiles in this Implementation Guide

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:bankDetails		0..*	(Complex)	Organization Bank Details URL: http://biomaxis.com/fhir/StructureDefinition/organization-bank-details
extension:document		0..*	(Complex)	Organization Document URL: http://biomaxis.com/fhir/StructureDefinition/organization-document
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:supplierCode	ΣC	0..1	Identifier	Supplier code identifier
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://biomaxis.com/fhir/identifier/organization-supplier-code
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
type	Σ	0..*	CodeableConcept	Kind of organization Binding: Extended Organization Type (example)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Organization.identifier:supplierCode.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.type	Base	example	Extended Organization Type	📦0.0.0-semantic-release	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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		0..*	Organization	A grouping of people or organizations with a common purpose
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:bankDetails		0..*	(Complex)	Organization Bank Details URL: http://biomaxis.com/fhir/StructureDefinition/organization-bank-details
extension:document		0..*	(Complex)	Organization Document URL: http://biomaxis.com/fhir/StructureDefinition/organization-document
Slices for identifier		0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:system
identifier:supplierCode		0..1	Identifier	Supplier code identifier
system		1..1	uri	The namespace for the identifier value Required Pattern: http://biomaxis.com/fhir/identifier/organization-supplier-code
type		0..*	CodeableConcept	Kind of organization Binding: Extended Organization Type (example)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Organization.type	Base	example	Extended Organization Type	📦0.0.0-semantic-release	This IG

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:bankDetails		0..*	(Complex)	Organization Bank Details URL: http://biomaxis.com/fhir/StructureDefinition/organization-bank-details
extension:document		0..*	(Complex)	Organization Document URL: http://biomaxis.com/fhir/StructureDefinition/organization-document
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:supplierCode	ΣC	0..1	Identifier	Supplier code identifier
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.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://biomaxis.com/fhir/identifier/organization-supplier-code
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
type	Σ	0..*	CodeableConcept	Kind of organization Binding: Extended Organization Type (example)
name	ΣC	0..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
address	C	0..*	Address	An address for the organization Constraints: org-2
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
contact		0..*	BackboneElement	Contact for the organization for a certain purpose
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
purpose		0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name		0..1	HumanName	A name associated with the contact
telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address		0..1	Address	Visiting or postal addresses for the contact
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Organization.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Organization.identifier:supplierCode.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:supplierCode.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Organization.type	Base	example	Extended Organization Type	📦0.0.0-semantic-release	This IG
Organization.contact.​purpose	Base	extensible	Contact entity type	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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: 0 element(1 nested mandatory element)

Extensions

This structure refers to these extensions:

• http://biomaxis.com/fhir/StructureDefinition/organization-bank-details
• http://biomaxis.com/fhir/StructureDefinition/organization-document

Slices

This structure defines the following Slices:

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

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:bankDetails		0..*	(Complex)	Organization Bank Details URL: http://biomaxis.com/fhir/StructureDefinition/organization-bank-details
extension:document		0..*	(Complex)	Organization Document URL: http://biomaxis.com/fhir/StructureDefinition/organization-document
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:supplierCode	ΣC	0..1	Identifier	Supplier code identifier
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://biomaxis.com/fhir/identifier/organization-supplier-code
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
type	Σ	0..*	CodeableConcept	Kind of organization Binding: Extended Organization Type (example)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Organization.identifier:supplierCode.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.type	Base	example	Extended Organization Type	📦0.0.0-semantic-release	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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		0..*	Organization	A grouping of people or organizations with a common purpose
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:bankDetails		0..*	(Complex)	Organization Bank Details URL: http://biomaxis.com/fhir/StructureDefinition/organization-bank-details
extension:document		0..*	(Complex)	Organization Document URL: http://biomaxis.com/fhir/StructureDefinition/organization-document
Slices for identifier		0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:system
identifier:supplierCode		0..1	Identifier	Supplier code identifier
system		1..1	uri	The namespace for the identifier value Required Pattern: http://biomaxis.com/fhir/identifier/organization-supplier-code
type		0..*	CodeableConcept	Kind of organization Binding: Extended Organization Type (example)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Organization.type	Base	example	Extended Organization Type	📦0.0.0-semantic-release	This IG

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:bankDetails		0..*	(Complex)	Organization Bank Details URL: http://biomaxis.com/fhir/StructureDefinition/organization-bank-details
extension:document		0..*	(Complex)	Organization Document URL: http://biomaxis.com/fhir/StructureDefinition/organization-document
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:supplierCode	ΣC	0..1	Identifier	Supplier code identifier
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.
system	Σ	1..1	uri	The namespace for the identifier value Required Pattern: http://biomaxis.com/fhir/identifier/organization-supplier-code
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
type	Σ	0..*	CodeableConcept	Kind of organization Binding: Extended Organization Type (example)
name	ΣC	0..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
address	C	0..*	Address	An address for the organization Constraints: org-2
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
contact		0..*	BackboneElement	Contact for the organization for a certain purpose
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
purpose		0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name		0..1	HumanName	A name associated with the contact
telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address		0..1	Address	Visiting or postal addresses for the contact
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Organization.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Organization.identifier:supplierCode.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier:supplierCode.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Organization.type	Base	example	Extended Organization Type	📦0.0.0-semantic-release	This IG
Organization.contact.​purpose	Base	extensible	Contact entity type	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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: 0 element(1 nested mandatory element)

Extensions

This structure refers to these extensions:

• http://biomaxis.com/fhir/StructureDefinition/organization-bank-details
• http://biomaxis.com/fhir/StructureDefinition/organization-document

Slices

This structure defines the following Slices:

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

Other representations of profile: CSV, Excel, Schematron