This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.2.0: STU 1 Draft) based on FHIR R3. . For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Organization
A social or legal structure formed by human beings.
This profile builds on US Core Organization Profile.
This profile was published on Fri Aug 17 00:00:00 AEST 2018 as a draft by The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC).
View the corresponding OrganizationModel logical model.
Summary
Mandatory: 0 element (2 nested mandatory elements)
Structures
This structure refers to these other structures:
BC Mapping Source
This structure represents the following BC mapping definition:
cimi.entity.Organization maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization: OrganizationName maps to name OrganizationAlias maps to alias // I wish FHIR allowed multiple names, but it doesn't Type maps to type OrganizationIdentifier maps to identifier Address maps to address ContactPoint maps to contact ActiveFlag maps to active PartOf maps to partOf
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | BC Organization Profile | |||
identifier | OrganizationIdentifierProfile | |||
type | 1..1 | Binding: OrganizationType (required) | ||
partOf | Reference(BC Organization Profile) | |||
contact | 1..* | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | I | 0..* | BC Organization Profile | |
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: Common Languages (extensible) | |
text | I | 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 | SΣI | 1..* | OrganizationIdentifierProfile | Identifies this organization across multiple systems |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | SΣ | 1..1 | uri | The namespace for the identifier value |
value | Σ | 0..1 | string | The value that is unique |
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 | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use |
type | Σ | 1..1 | CodeableConcept | Kind of organization Binding: OrganizationType (required) |
name | SΣI | 1..1 | string | Name used for the organization |
alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
telecom | SI | 1..* | ContactPoint | A contact detail for the organization |
address | SI | 1..* | Address | An address for the organization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) |
text | Σ | 0..1 | string | Text representation of the address |
line | SΣ | 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 |
city | SΣ | 0..1 | string | Name of city, town etc. |
district | Σ | 0..1 | string | District name (aka county) |
state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (required) |
postalCode | SΣ | 0..1 | string | US Zip Codes |
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 |
partOf | Σ | 0..1 | Reference(BC Organization Profile) | The organization of which this organization forms a part |
contact | I | 1..* | BackboneElement | Contact for the organization for a certain purpose |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible) | |
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 | S | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization |
Documentation for this format |
Summary
Mandatory: 0 element (2 nested mandatory elements)
Structures
This structure refers to these other structures:
BC Mapping Source
This structure represents the following BC mapping definition:
cimi.entity.Organization maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization: OrganizationName maps to name OrganizationAlias maps to alias // I wish FHIR allowed multiple names, but it doesn't Type maps to type OrganizationIdentifier maps to identifier Address maps to address ContactPoint maps to contact ActiveFlag maps to active PartOf maps to partOf
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | BC Organization Profile | |||
identifier | OrganizationIdentifierProfile | |||
type | 1..1 | Binding: OrganizationType (required) | ||
partOf | Reference(BC Organization Profile) | |||
contact | 1..* | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | I | 0..* | BC Organization Profile | |
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: Common Languages (extensible) | |
text | I | 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 | SΣI | 1..* | OrganizationIdentifierProfile | Identifies this organization across multiple systems |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | SΣ | 1..1 | uri | The namespace for the identifier value |
value | Σ | 0..1 | string | The value that is unique |
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 | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use |
type | Σ | 1..1 | CodeableConcept | Kind of organization Binding: OrganizationType (required) |
name | SΣI | 1..1 | string | Name used for the organization |
alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
telecom | SI | 1..* | ContactPoint | A contact detail for the organization |
address | SI | 1..* | Address | An address for the organization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) |
text | Σ | 0..1 | string | Text representation of the address |
line | SΣ | 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 |
city | SΣ | 0..1 | string | Name of city, town etc. |
district | Σ | 0..1 | string | District name (aka county) |
state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (required) |
postalCode | SΣ | 0..1 | string | US Zip Codes |
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 |
partOf | Σ | 0..1 | Reference(BC Organization Profile) | The organization of which this organization forms a part |
contact | I | 1..* | BackboneElement | Contact for the organization for a certain purpose |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible) | |
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 | S | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
Path | Name | Conformance | ValueSet |
Organization.language | Common Languages | extensible | Common Languages |
Organization.identifier.use | IdentifierUse | required | IdentifierUse |
Organization.identifier.type | Identifier Type Codes | extensible | Identifier Type Codes |
Organization.type | OrganizationType | required | OrganizationType |
Organization.address.use | AddressUse | required | AddressUse |
Organization.address.type | AddressType | required | AddressType |
Organization.address.state | USPS Two Letter Alphabetic Codes | required | USPS Two Letter Alphabetic Codes |
Organization.contact.purpose | ContactEntityType | 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-1 | Organization | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.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-3 | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
org-1 | Organization | The organization SHALL at least have a name or an id, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-3 | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-2 | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
ele-1 | Organization.contact | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |