0.3.0 - Second STU ballot

This page is part of a downloaded copy of this specification. This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v0.3.0: STU 1 Ballot 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

## StructureDefinition: OrganizationR4

The official URL for this profile is:

    http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-organization-r4

### Formal Views of Profile Content

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

- Text Summary
- Differential Table
- Snapshot Table
- All

This structure is derived from US Core Organization Profile

Summary

Structures

This structure refers to these other structures:

- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-organization-r4

This structure is derived from US Core Organization Profile

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Organization |  | 0..* |  |
identifier |  | 1..* | Identifier |
partOf |  | 0..1 | Reference(OrganizationR4) |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Organization | I | 0..* |  | US Core 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: 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
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ 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
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 | S Σ | 1..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 | ?!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 |  | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past
telecom | S I | 1..* | ContactPoint | A contact detail for the organization
address | S I | 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
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required) Example General': home
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General': both
text | Σ | 0..1 | string | Text representation of the address Example General': 137 Nowhere Street, Erewhon 9132
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 Example General': 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General': Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General': Madison
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 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-23T11:00:00+11:00","end":"2010-07-01T10:00:00+10:00"}
partOf | Σ | 0..1 | Reference(OrganizationR4) | The organization of which this organization forms a part
contact | I | 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 |  | 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

This structure is derived from US Core Organization Profile

Summary

Structures

This structure refers to these other structures:

- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-organization-r4

Differential View

This structure is derived from US Core Organization Profile

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Organization |  | 0..* |  |
identifier |  | 1..* | Identifier |
partOf |  | 0..1 | Reference(OrganizationR4) |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Organization | I | 0..* |  | US Core 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: 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
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ 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
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 | S Σ | 1..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 | ?!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 |  | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past
telecom | S I | 1..* | ContactPoint | A contact detail for the organization
address | S I | 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
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required) Example General': home
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General': both
text | Σ | 0..1 | string | Text representation of the address Example General': 137 Nowhere Street, Erewhon 9132
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 Example General': 137 Nowhere Street
city | S Σ | 0..1 | string | Name of city, town etc. Example General': Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General': Madison
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 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-23T11:00:00+11:00","end":"2010-07-01T10:00:00+10:00"}
partOf | Σ | 0..1 | Reference(OrganizationR4) | The organization of which this organization forms a part
contact | I | 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 |  | 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

Other representations of profile: Schematron

### Terminology Bindings

Path | Conformance | ValueSet
Organization.address.state | required | UspsTwoLetterAlphabeticCodes

### Constraints

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()) |