FHIR Implementation Guide for HCX
0.0.1 - CI Build
FHIR Implementation Guide for HCX
0.0.1 - CI Build
FHIR Implementation Guide for HCX - Local Development build (v0.0.1). See the Directory of published versions
| Defining URL: | http://hl7.org/fhir/StructureDefinition/HCXOrganization |
| Version: | 0.0.1 |
| Name: | Organization |
| Status: | Draft as of 2019-11-01T09:29:23+11:00 (Standards Status: Trial Use) |
| Definition: | A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. |
| Publisher: | HL7 International - HCX |
| Committee: | Patient Administration |
| Maturity: | 3 |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/HCXOrganization
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Organization
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organization | 0..* | Organization | A grouping of people or organizations with a common purpose | |
  identifier | ΣI | 1..* | Identifier | Identifies this organization across multiple systems |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | I | 0..* | Organization | A grouping of people or organizations with a common purpose |
 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 1..* | Identifier | Identifies this organization across multiple systems |
| 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 | ΣI | 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 | I | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' |
| address | I | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' |
 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 | |
 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | I | 0..* | Organization | A grouping of people or organizations with a common purpose |
| Documentation for this format | ||||
This structure is derived from Organization
Differential View
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | 0..* | Organization | A grouping of people or organizations with a common purpose | |
| identifier | ΣI | 1..* | Identifier | Identifies this organization across multiple systems |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | I | 0..* | Organization | A grouping of people or organizations with a common purpose |
| 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 1..* | Identifier | Identifies this organization across multiple systems |
| 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 | ΣI | 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 | I | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' |
| address | I | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' |
| 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 | |
| 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 | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| Organization.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Organization.type | example | OrganizationType |
| Organization.contact.purpose | extensible | ContactEntityType |
| Id | Path | Details | Requirements |
| dom-2 | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
| org-1 | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
| ele-1 | Organization.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Organization.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Organization.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Organization.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Organization.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Organization.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Organization.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Organization.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Organization.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Organization.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Organization.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Organization.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Organization.alias | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Organization.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| org-3 | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() | |
| ele-1 | Organization.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| org-2 | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| ele-1 | Organization.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Organization.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Organization.contact.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Organization.contact.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Organization.contact.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Organization.contact.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Organization.contact.purpose | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Organization.contact.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Organization.contact.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Organization.contact.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Organization.endpoint | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |