Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR STU3 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R3_Organization_R4B

Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-Organization Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R3_Organization_R4B

This cross-version profile allows STU3 Organization content to be represented via FHIR R4B Organization resources.

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization(4.3.0) 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use

doco Documentation for this format

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.exists() and ('#'+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(uri) = '#').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 Organization.implicitRules, Organization.modifierExtension, Organization.active All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Organization.modifierExtension 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization 0..* Organization(4.3.0) A grouping of people or organizations with a common purpose
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:telecom 0..* ContactPoint STU3: telecom additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.telecom
... address
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:address 0..* Address STU3: address additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.address
... partOf
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:partOf 0..1 Reference(Resource) STU3: partOf additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... contact
.... name
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:name 0..1 HumanName STU3: name additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.contact.name
.... telecom
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:telecom 0..* ContactPoint STU3: telecom additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.contact.telecom
.... address
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:address 0..1 Address STU3: address additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.contact.address
... endpoint
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:endpoint 0..* Reference(Resource) STU3: endpoint additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization(4.3.0) 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier ΣC 0..* Identifier Identifies this organization across multiple systems
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... 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: OrganizationType (example): Used to categorize the organization.
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:telecom 0..* ContactPoint STU3: telecom additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.telecom
Constraints: ext-1
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... 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)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address C 0..* Address An address for the organization
Constraints: org-2
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:address 0..* Address STU3: address additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.address
Constraints: ext-1
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
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
.... 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)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ 0..1 Reference(Organization) The organization of which this organization forms a part
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:partOf 0..1 Reference(Resource) STU3: partOf additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:name 0..1 HumanName STU3: name additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.contact.name
Constraints: ext-1
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... text Σ 0..1 string Text representation of the full name
..... family Σ 0..1 string Family name (often called 'Surname')
..... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:telecom 0..* ContactPoint STU3: telecom additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.contact.telecom
Constraints: ext-1
..... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... 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)
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... address 0..1 Address Visiting or postal addresses for the contact
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:address 0..1 Address STU3: address additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.contact.address
Constraints: ext-1
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
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
..... 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)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:endpoint 0..1 Reference(Resource) STU3: endpoint additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Organization.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
Organization.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Organization.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
Organization.identifier.​use Base required IdentifierUse 📍4.3.0 FHIR Std.
Organization.identifier.​type Base extensible IdentifierType 📍4.3.0 FHIR Std.
Organization.type Base example OrganizationType 📍4.3.0 FHIR Std.
Organization.telecom.​system Base required ContactPointSystem 📍4.3.0 FHIR Std.
Organization.telecom.​use Base required ContactPointUse 📍4.3.0 FHIR Std.
Organization.address.​use Base required AddressUse 📍4.3.0 FHIR Std.
Organization.address.​type Base required AddressType 📍4.3.0 FHIR Std.
Organization.partOf.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Organization.contact.​purpose Base extensible ContactEntityType 📍4.3.0 FHIR Std.
Organization.contact.​name.use Base required NameUse 📍4.3.0 FHIR Std.
Organization.contact.​telecom.system Base required ContactPointSystem 📍4.3.0 FHIR Std.
Organization.contact.​telecom.use Base required ContactPointUse 📍4.3.0 FHIR Std.
Organization.contact.​address.use Base required AddressUse 📍4.3.0 FHIR Std.
Organization.contact.​address.type Base required AddressType 📍4.3.0 FHIR Std.
Organization.endpoint.​type Base extensible ResourceType 📍4.3.0 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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning Organization.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error Organization.meta, Organization.meta.extension, Organization.meta.extension:meta, Organization.meta.versionId, Organization.meta.lastUpdated, Organization.meta.source, Organization.meta.profile, Organization.meta.security, Organization.meta.tag, Organization.implicitRules, Organization.language, Organization.text, Organization.text.extension, Organization.text.extension:text, Organization.text.status, Organization.text.div, Organization.extension, Organization.modifierExtension, Organization.identifier, Organization.identifier.extension, Organization.identifier.extension:identifier, Organization.identifier.use, Organization.identifier.type, Organization.identifier.system, Organization.identifier.value, Organization.identifier.period, Organization.identifier.assigner, Organization.active, Organization.type, Organization.name, Organization.alias, Organization.telecom, Organization.telecom.extension, Organization.telecom.extension:telecom, Organization.telecom.system, Organization.telecom.value, Organization.telecom.use, Organization.telecom.rank, Organization.telecom.period, Organization.address, Organization.address.extension, Organization.address.extension:address, Organization.address.use, Organization.address.type, Organization.address.text, Organization.address.line, Organization.address.city, Organization.address.district, Organization.address.state, Organization.address.postalCode, Organization.address.country, Organization.address.period, Organization.partOf, Organization.partOf.extension, Organization.partOf.extension:partOf, Organization.partOf.reference, Organization.partOf.type, Organization.partOf.identifier, Organization.partOf.display, Organization.contact, Organization.contact.extension, Organization.contact.modifierExtension, Organization.contact.purpose, Organization.contact.name, Organization.contact.name.extension, Organization.contact.name.extension:name, Organization.contact.name.use, Organization.contact.name.text, Organization.contact.name.family, Organization.contact.name.given, Organization.contact.name.prefix, Organization.contact.name.suffix, Organization.contact.name.period, Organization.contact.telecom, Organization.contact.telecom.extension, Organization.contact.telecom.extension:telecom, Organization.contact.telecom.system, Organization.contact.telecom.value, Organization.contact.telecom.use, Organization.contact.telecom.rank, Organization.contact.telecom.period, Organization.contact.address, Organization.contact.address.extension, Organization.contact.address.extension:address, Organization.contact.address.use, Organization.contact.address.type, Organization.contact.address.text, Organization.contact.address.line, Organization.contact.address.city, Organization.contact.address.district, Organization.contact.address.state, Organization.contact.address.postalCode, Organization.contact.address.country, Organization.contact.address.period, Organization.endpoint, Organization.endpoint.extension, Organization.endpoint.extension:endpoint, Organization.endpoint.reference, Organization.endpoint.type, Organization.endpoint.identifier, Organization.endpoint.display All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Organization.meta.extension, Organization.meta.extension:meta, Organization.text.extension, Organization.text.extension:text, Organization.extension, Organization.modifierExtension, Organization.identifier.extension, Organization.identifier.extension:identifier, Organization.telecom.extension, Organization.telecom.extension:telecom, Organization.address.extension, Organization.address.extension:address, Organization.partOf.extension, Organization.partOf.extension:partOf, Organization.contact.extension, Organization.contact.modifierExtension, Organization.contact.name.extension, Organization.contact.name.extension:name, Organization.contact.telecom.extension, Organization.contact.telecom.extension:telecom, Organization.contact.address.extension, Organization.contact.address.extension:address, Organization.endpoint.extension, Organization.endpoint.extension:endpoint 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()
txt-1 error Organization.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Organization.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization(4.3.0) 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use

doco Documentation for this format

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.exists() and ('#'+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(uri) = '#').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 Organization.implicitRules, Organization.modifierExtension, Organization.active All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Organization.modifierExtension 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization 0..* Organization(4.3.0) A grouping of people or organizations with a common purpose
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:telecom 0..* ContactPoint STU3: telecom additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.telecom
... address
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:address 0..* Address STU3: address additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.address
... partOf
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:partOf 0..1 Reference(Resource) STU3: partOf additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... contact
.... name
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:name 0..1 HumanName STU3: name additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.contact.name
.... telecom
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:telecom 0..* ContactPoint STU3: telecom additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.contact.telecom
.... address
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:address 0..1 Address STU3: address additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.contact.address
... endpoint
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:endpoint 0..* Reference(Resource) STU3: endpoint additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization(4.3.0) 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier ΣC 0..* Identifier Identifies this organization across multiple systems
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... 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: OrganizationType (example): Used to categorize the organization.
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:telecom 0..* ContactPoint STU3: telecom additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.telecom
Constraints: ext-1
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... 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)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address C 0..* Address An address for the organization
Constraints: org-2
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:address 0..* Address STU3: address additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.address
Constraints: ext-1
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
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
.... 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)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ 0..1 Reference(Organization) The organization of which this organization forms a part
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:partOf 0..1 Reference(Resource) STU3: partOf additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:name 0..1 HumanName STU3: name additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.contact.name
Constraints: ext-1
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... text Σ 0..1 string Text representation of the full name
..... family Σ 0..1 string Family name (often called 'Surname')
..... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:telecom 0..* ContactPoint STU3: telecom additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.contact.telecom
Constraints: ext-1
..... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... 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)
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... address 0..1 Address Visiting or postal addresses for the contact
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:address 0..1 Address STU3: address additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Organization.contact.address
Constraints: ext-1
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
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
..... 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)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:endpoint 0..1 Reference(Resource) STU3: endpoint additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Organization.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
Organization.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Organization.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
Organization.identifier.​use Base required IdentifierUse 📍4.3.0 FHIR Std.
Organization.identifier.​type Base extensible IdentifierType 📍4.3.0 FHIR Std.
Organization.type Base example OrganizationType 📍4.3.0 FHIR Std.
Organization.telecom.​system Base required ContactPointSystem 📍4.3.0 FHIR Std.
Organization.telecom.​use Base required ContactPointUse 📍4.3.0 FHIR Std.
Organization.address.​use Base required AddressUse 📍4.3.0 FHIR Std.
Organization.address.​type Base required AddressType 📍4.3.0 FHIR Std.
Organization.partOf.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
Organization.contact.​purpose Base extensible ContactEntityType 📍4.3.0 FHIR Std.
Organization.contact.​name.use Base required NameUse 📍4.3.0 FHIR Std.
Organization.contact.​telecom.system Base required ContactPointSystem 📍4.3.0 FHIR Std.
Organization.contact.​telecom.use Base required ContactPointUse 📍4.3.0 FHIR Std.
Organization.contact.​address.use Base required AddressUse 📍4.3.0 FHIR Std.
Organization.contact.​address.type Base required AddressType 📍4.3.0 FHIR Std.
Organization.endpoint.​type Base extensible ResourceType 📍4.3.0 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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning Organization.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error Organization.meta, Organization.meta.extension, Organization.meta.extension:meta, Organization.meta.versionId, Organization.meta.lastUpdated, Organization.meta.source, Organization.meta.profile, Organization.meta.security, Organization.meta.tag, Organization.implicitRules, Organization.language, Organization.text, Organization.text.extension, Organization.text.extension:text, Organization.text.status, Organization.text.div, Organization.extension, Organization.modifierExtension, Organization.identifier, Organization.identifier.extension, Organization.identifier.extension:identifier, Organization.identifier.use, Organization.identifier.type, Organization.identifier.system, Organization.identifier.value, Organization.identifier.period, Organization.identifier.assigner, Organization.active, Organization.type, Organization.name, Organization.alias, Organization.telecom, Organization.telecom.extension, Organization.telecom.extension:telecom, Organization.telecom.system, Organization.telecom.value, Organization.telecom.use, Organization.telecom.rank, Organization.telecom.period, Organization.address, Organization.address.extension, Organization.address.extension:address, Organization.address.use, Organization.address.type, Organization.address.text, Organization.address.line, Organization.address.city, Organization.address.district, Organization.address.state, Organization.address.postalCode, Organization.address.country, Organization.address.period, Organization.partOf, Organization.partOf.extension, Organization.partOf.extension:partOf, Organization.partOf.reference, Organization.partOf.type, Organization.partOf.identifier, Organization.partOf.display, Organization.contact, Organization.contact.extension, Organization.contact.modifierExtension, Organization.contact.purpose, Organization.contact.name, Organization.contact.name.extension, Organization.contact.name.extension:name, Organization.contact.name.use, Organization.contact.name.text, Organization.contact.name.family, Organization.contact.name.given, Organization.contact.name.prefix, Organization.contact.name.suffix, Organization.contact.name.period, Organization.contact.telecom, Organization.contact.telecom.extension, Organization.contact.telecom.extension:telecom, Organization.contact.telecom.system, Organization.contact.telecom.value, Organization.contact.telecom.use, Organization.contact.telecom.rank, Organization.contact.telecom.period, Organization.contact.address, Organization.contact.address.extension, Organization.contact.address.extension:address, Organization.contact.address.use, Organization.contact.address.type, Organization.contact.address.text, Organization.contact.address.line, Organization.contact.address.city, Organization.contact.address.district, Organization.contact.address.state, Organization.contact.address.postalCode, Organization.contact.address.country, Organization.contact.address.period, Organization.endpoint, Organization.endpoint.extension, Organization.endpoint.extension:endpoint, Organization.endpoint.reference, Organization.endpoint.type, Organization.endpoint.identifier, Organization.endpoint.display All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Organization.meta.extension, Organization.meta.extension:meta, Organization.text.extension, Organization.text.extension:text, Organization.extension, Organization.modifierExtension, Organization.identifier.extension, Organization.identifier.extension:identifier, Organization.telecom.extension, Organization.telecom.extension:telecom, Organization.address.extension, Organization.address.extension:address, Organization.partOf.extension, Organization.partOf.extension:partOf, Organization.contact.extension, Organization.contact.modifierExtension, Organization.contact.name.extension, Organization.contact.name.extension:name, Organization.contact.telecom.extension, Organization.contact.telecom.extension:telecom, Organization.contact.address.extension, Organization.contact.address.extension:address, Organization.endpoint.extension, Organization.endpoint.extension:endpoint 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()
txt-1 error Organization.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Organization.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron