This page is part of the DaVinci PDEX Plan Net (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. 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/davinci-pdex-plan-net/StructureDefinition/plannet-Organization
An organization is a formal or informal grouping of people or organizations with a common purpose, such as a company, institution, corporation, community group, or healthcare practice.
This profile builds on USCoreOrganizationProfile.
This profile was published on Wed Oct 23 00:00:00 EDT 2019 as a active by HL7 Financial Management WG.
Summary
Must-Support: 27 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Mapping Source
This structure represents the following mapping definition:
plannet.Organization maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization: Qualification maps to http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification TAvailableTime maps to telecom.extension CAvailableTime maps to contact.telecom.extension TViaIntermediary maps to telecom.extension CViaIntermediary maps to contact.telecom.extension Description maps to http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description PartOf maps to partOf GeoLocation maps to address.extension Address maps to address Address.Purpose maps to address.use Address.Type maps to address.type Address.DisplayText maps to address.text Address.AddressLine maps to address.line Address.City maps to address.city Address.State maps to address.state Address.PostalCode maps to address.postalCode Address.Country maps to address.country Address.EffectiveTimePeriod maps to address.period OrganizationAlias maps to alias OrganizationEndpoint maps to endpoint PN_Identifier.IdentifierUse maps to identifier.use PN_Identifier.IdentifierSystem maps to identifier.system PN_Identifier.IdentifierValue maps to identifier.value PN_Identifier.IdentifierType maps to identifier.type PN_Identifier.IdentifierPeriod maps to identifier.period PN_Identifier.IdentifierAssigner maps to identifier.assigner PN_Identifier.IdentifierStatus maps to identifier.extension OrganizationActive maps to active OrganizationName maps to name OrganizationTelecom.ContactPoint maps to telecom OrganizationTelecom.ContactPoint.TelecomNumberOrAddress maps to telecom.value OrganizationTelecom.ContactPoint.Type maps to telecom.system OrganizationTelecom.ContactPoint.Purpose maps to telecom.use OrganizationTelecom.ContactPoint.PriorityRank maps to telecom.rank OrganizationTelecom.ContactPoint.EffectiveTimePeriod maps to telecom.period OrganizationContact maps to contact OrganizationContact.HumanName maps to contact.name OrganizationContact.HumanName.GivenName maps to contact.name.given OrganizationContact.HumanName.FamilyName maps to contact.name.family OrganizationContact.ContactPoint.TelecomNumberOrAddress maps to contact.telecom.value OrganizationContact.ContactPoint.Type maps to contact.telecom.system OrganizationContact.ContactPoint.Purpose maps to contact.telecom.use OrganizationContact.ContactPoint.PriorityRank maps to contact.telecom.rank OrganizationContact.ContactPoint.EffectiveTimePeriod maps to contact.telecom.period
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | I | 0..* | plannet-Organization | |
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) Max Binding: AllLanguages | |
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 Slice: Unordered, Open by value:url | |
org-description | S | 0..1 | string | Description URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description |
qualification | S | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣI | 1..* | Identifier | Identifies this organization across multiple systems |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
identifier-status | 0..* | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) | |
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | SΣ | 1..1 | uri | The namespace for the identifier value |
value | SΣ | 0..1 | string | The value that is unique |
period | SΣ | 0..1 | Period | Time period when id is/was valid for use |
assigner | SΣ | 0..1 | Reference(plannet-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 | Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example) |
name | SΣI | 1..1 | string | Name used for the organization |
alias | S | 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 |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
contactpoint-availabletime | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
plannet-CViaIntermediary-extension | S | 0..* | Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location) | CViaIntermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension |
system | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
value | SΣ | 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 | SI | 1..* | Address | An address for the organization |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
geolocation | S | 0..* | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation |
use | ?!SΣ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required) |
type | SΣ | 0..1 | code | postal | physical | both Binding: AddressType (required) |
text | SΣ | 0..1 | string | Text representation of the address |
line | SΣ | 0..4 | 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 (extensible) |
postalCode | SΣ | 0..1 | string | US Zip Codes |
country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
period | SΣ | 0..1 | Period | Time period when address was/is in use |
partOf | SΣ | 0..1 | Reference(plannet-Organization) | The organization of which this organization forms a part |
contact | SI | 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) | |
name | S | 0..1 | HumanName | A name associated with the contact |
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
contactpoint-availabletime | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
plannet-CViaIntermediary-extension | S | 0..* | Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location) | CViaIntermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension |
system | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
value | SΣ | 0..1 | string | The actual contact point details |
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | SΣ | 0..1 | Period | Time period when the contact point was/is in use |
address | 0..1 | Address | Visiting or postal addresses for the contact | |
endpoint | S | 0..* | Reference(plannet-Endpoint) | Technical endpoints providing access to services operated for the organization |
Documentation for this format |
Summary
Must-Support: 27 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Mapping Source
This structure represents the following mapping definition:
plannet.Organization maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization: Qualification maps to http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification TAvailableTime maps to telecom.extension CAvailableTime maps to contact.telecom.extension TViaIntermediary maps to telecom.extension CViaIntermediary maps to contact.telecom.extension Description maps to http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description PartOf maps to partOf GeoLocation maps to address.extension Address maps to address Address.Purpose maps to address.use Address.Type maps to address.type Address.DisplayText maps to address.text Address.AddressLine maps to address.line Address.City maps to address.city Address.State maps to address.state Address.PostalCode maps to address.postalCode Address.Country maps to address.country Address.EffectiveTimePeriod maps to address.period OrganizationAlias maps to alias OrganizationEndpoint maps to endpoint PN_Identifier.IdentifierUse maps to identifier.use PN_Identifier.IdentifierSystem maps to identifier.system PN_Identifier.IdentifierValue maps to identifier.value PN_Identifier.IdentifierType maps to identifier.type PN_Identifier.IdentifierPeriod maps to identifier.period PN_Identifier.IdentifierAssigner maps to identifier.assigner PN_Identifier.IdentifierStatus maps to identifier.extension OrganizationActive maps to active OrganizationName maps to name OrganizationTelecom.ContactPoint maps to telecom OrganizationTelecom.ContactPoint.TelecomNumberOrAddress maps to telecom.value OrganizationTelecom.ContactPoint.Type maps to telecom.system OrganizationTelecom.ContactPoint.Purpose maps to telecom.use OrganizationTelecom.ContactPoint.PriorityRank maps to telecom.rank OrganizationTelecom.ContactPoint.EffectiveTimePeriod maps to telecom.period OrganizationContact maps to contact OrganizationContact.HumanName maps to contact.name OrganizationContact.HumanName.GivenName maps to contact.name.given OrganizationContact.HumanName.FamilyName maps to contact.name.family OrganizationContact.ContactPoint.TelecomNumberOrAddress maps to contact.telecom.value OrganizationContact.ContactPoint.Type maps to contact.telecom.system OrganizationContact.ContactPoint.Purpose maps to contact.telecom.use OrganizationContact.ContactPoint.PriorityRank maps to contact.telecom.rank OrganizationContact.ContactPoint.EffectiveTimePeriod maps to contact.telecom.period
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | I | 0..* | plannet-Organization | |
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) Max Binding: AllLanguages | |
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 Slice: Unordered, Open by value:url | |
org-description | S | 0..1 | string | Description URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/org-description |
qualification | S | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣI | 1..* | Identifier | Identifies this organization across multiple systems |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
identifier-status | 0..* | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) | |
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | SΣ | 1..1 | uri | The namespace for the identifier value |
value | SΣ | 0..1 | string | The value that is unique |
period | SΣ | 0..1 | Period | Time period when id is/was valid for use |
assigner | SΣ | 0..1 | Reference(plannet-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 | Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example) |
name | SΣI | 1..1 | string | Name used for the organization |
alias | S | 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 |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
contactpoint-availabletime | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
plannet-CViaIntermediary-extension | S | 0..* | Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location) | CViaIntermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension |
system | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
value | SΣ | 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 | SI | 1..* | Address | An address for the organization |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
geolocation | S | 0..* | (Complex) | The absolute geographic location URL: http://hl7.org/fhir/StructureDefinition/geolocation |
use | ?!SΣ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required) |
type | SΣ | 0..1 | code | postal | physical | both Binding: AddressType (required) |
text | SΣ | 0..1 | string | Text representation of the address |
line | SΣ | 0..4 | 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 (extensible) |
postalCode | SΣ | 0..1 | string | US Zip Codes |
country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
period | SΣ | 0..1 | Period | Time period when address was/is in use |
partOf | SΣ | 0..1 | Reference(plannet-Organization) | The organization of which this organization forms a part |
contact | SI | 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) | |
name | S | 0..1 | HumanName | A name associated with the contact |
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
contactpoint-availabletime | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
plannet-CViaIntermediary-extension | S | 0..* | Reference(plannet-PractitionerRole | plannet-Organization | plannet-OrganizationAffiliation | plannet-Location) | CViaIntermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-CViaIntermediary-extension |
system | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
value | SΣ | 0..1 | string | The actual contact point details |
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | SΣ | 0..1 | Period | Time period when the contact point was/is in use |
address | 0..1 | Address | Visiting or postal addresses for the contact | |
endpoint | S | 0..* | Reference(plannet-Endpoint) | Technical endpoints providing access to services operated for the organization |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
Path | Conformance | ValueSet |
Organization.language | preferred | CommonLanguages Max Binding: AllLanguages |
Organization.identifier.use | required | IdentifierUse |
Organization.identifier.type | extensible | Identifier Type Codes |
Organization.type | example | OrganizationType |
Organization.telecom.system | required | ContactPointSystem |
Organization.telecom.use | required | ContactPointUse |
Organization.address.use | required | AddressUse |
Organization.address.type | required | AddressType |
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes |
Organization.contact.purpose | extensible | ContactEntityType |
Organization.contact.telecom.system | required | ContactPointSystem |
Organization.contact.telecom.use | required | ContactPointUse |
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-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 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-6 | Organization | A resource should have narrative for robust management : text.div.exists() | |
dom-5 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
org-1 | Organization | The organization SHALL at least have a name or an identifier, 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() or (children().count() > id.count()) |