STU 2 Ballot

This page is part of the Quality Improvement Core Framework (v1.6.0: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) v1.6.0. The current version which supersedes this version is 7.0.2. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: qicore-organization

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/qicore/StructureDefinition/qicore-organization

This profile was published on Fri Feb 27 00:00:00 AEDT 2015 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

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

This structure is derived from Organization

Summary

Must-Support: 2 elements

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*A grouping of people or organizations with a common purpose
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
org-1: The organization SHALL at least have a name or an id, and possibly more than one
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier I0..*IdentifierIdentifies this organization across multiple systems
... active ?!S0..1booleanWhether the organization's record is still in active use
... type S0..1CodeableConceptKind of organization
Binding: OrganizationType (example)
... name I0..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom I0..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address I0..*AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?!∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line ∑0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city ∑0..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state 0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred)
.... postalCode ∑0..1stringPostal code for area
Example: 9132
.... country ∑0..1stringCountry (can be ISO 3166 3 letter code)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... partOf 0..1Reference(Profile qicore-organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

This structure is derived from StructureDefinition.

Summary

Must-Support: 2 elements

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*A grouping of people or organizations with a common purpose
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
org-1: The organization SHALL at least have a name or an id, and possibly more than one
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier I0..*IdentifierIdentifies this organization across multiple systems
... active ?!S0..1booleanWhether the organization's record is still in active use
... type S0..1CodeableConceptKind of organization
Binding: OrganizationType (example)
... name I0..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom I0..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address I0..*AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?!∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line ∑0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city ∑0..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state 0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred)
.... postalCode ∑0..1stringPostal code for area
Example: 9132
.... country ∑0..1stringCountry (can be ISO 3166 3 letter code)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... partOf 0..1Reference(Profile qicore-organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Organization.languageCommon LanguagesextensibleCommon Languages
Organization.typeOrganizationTypeexampleOrganizationType
Organization.address.useAddressUserequiredAddressUse
Organization.address.typeAddressTyperequiredAddressType
Organization.address.stateUSPS Two Letter Alphabetic CodespreferredUSPS Two Letter Alphabetic Codes
Organization.contact.purposeContactEntityTypeextensibleContactEntityType

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2OrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1OrganizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4OrganizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3OrganizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
org-1OrganizationThe organization SHALL at least have a name or an id, and possibly more than one
XPath: count(f:identifier | f:name) > 0
org-3Organization.telecomThe telecom of an organization can never be of use 'home'
XPath: count(f:use[@value='home']) = 0
org-2Organization.addressAn address of an organization can never be of use 'home'
XPath: count(f:use[@value='home']) = 0
.