Sequoia Project Healthcare Directory Implementation Guide
1.0.3 - Release 1
Official URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/SequoiaOrganization | Version: 1.0.3 | |||
Active as of 2023-12-13 | Computable Name: SequoiaOrganization |
This profile on the FHIR Organization resource is an abstract base profile that defines shared constraints for all other profiles on the Organization resource in the implementation guides that are based on it. It is not intended to be used directly, rather end users should create instances conforming to the non-abstract profiles defined in other IGs such as Carequality, eHealthExchange, and RCE.
This profile on the FHIR Organization resource is an abstract base profile that defines shared constraints for all other profiles on the Organization resource in the implementation guides that are based on it. It is not intended to be used directly, rather end users should create instances conforming to the non-abstract profiles defined in other IGs such as Carequality, eHealthExchange, and RCE.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreOrganizationProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | USCoreOrganizationProfile | This is an abstract profile. A grouping of people or organizations with a common purpose so-1: For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier |
extension | 1..* | Extension | Extension | |
Domains | S | 1..* | Coding | Domains URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains Binding: Domains (required) |
HubServiceSubscriptions | 0..* | Coding | HubServiceSubscription URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required) | |
AdministrativeStatus | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required) | |
HubRoutingStatus | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required) | |
InitiatorOnly | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly Binding: Initiator Only (required) |
org-managing-org | S | 0..1 | Reference(Sequoia Organization) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org |
PurposesOfUse | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse Binding: Purpose Of Use (preferred) |
StateOfOperation | S | 0..* | Address | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation |
UseCases | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases Binding: Endpoint Use Case Codes (required) | |
identifier | 1..* | Identifier | Identifies this organization across multiple systems | |
identifier:CCN | S | 0..1 | Identifier | CMS Certification Number (CCN) Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.336 | |
identifier:HCID | S | 1..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
identifier:AAID | S | 0..* | Identifier | OID (such as an Assiging Authority ID) or UUID Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AAID | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
active | S | 1..1 | boolean | Whether the organization's record is still in active use |
Slices for type | S | 1..* | CodeableConcept | Kind of organization Slice: Unordered, Open by pattern:$this |
type:sequoiaorgtype | S | 1..1 | CodeableConcept | Kind of organization Binding: Organization Type (required) |
type:hl7orgrole | S | 0..* | CodeableConcept | Kind of organization Binding: OrganizationAffiliationRole (required) |
name | S | 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 |
Slices for telecom | S | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system |
telecom:phone | S | 0..* | ContactPoint | A contact detail for the organization |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
telecom:email | S | 0..* | ContactPoint | A contact detail for the organization |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
address | S | 0..* | Address | An address for the organization |
OrgLocation | S | 0..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation |
line | S | 0..1 | string | Street name, number, direction & P.O. Box etc. |
city | S | 0..1 | string | Name of city, town etc. |
state | S | 0..1 | string | Sub-unit of country (abbreviations ok) |
postalCode | S | 0..1 | string | US Zip Codes |
country | S | 0..1 | string | Must be an ISO 3166 3 letter code |
partOf | S | 0..1 | Reference(Sequoia Organization) | The organization of which this organization forms a part |
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose |
company | S | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company |
Slices for telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system |
telecom:phone | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
telecom:email | S | 0..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
address | S | 0..1 | Address | Visiting or postal addresses for the contact |
line | S | 0..1 | string | Street name, number, direction & P.O. Box etc. |
endpoint | S | 0..* | Reference(Sequoia Endpoint) | Technical endpoints providing access to services operated for the organization |
Documentation for this format |
Path | Conformance | ValueSet |
Organization.type:sequoiaorgtype | required | OrganizationType (a valid code from Organization Type) |
Organization.type:hl7orgrole | required | OrganizationAffiliationRole |
Id | Grade | Path(s) | Details | Requirements |
so-1 | warning | Organization | For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier : endpoint.exists() implies identifier.where(type.coding.code='HCID').first().value.substring(8)=id |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | USCoreOrganizationProfile | This is an abstract profile. A grouping of people or organizations with a common purpose so-1: For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
Domains | S | 1..* | Coding | Domains URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains Binding: Domains (required) |
HubServiceSubscriptions | 0..* | Coding | HubServiceSubscription URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required) | |
AdministrativeStatus | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required) | |
HubRoutingStatus | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required) | |
InitiatorOnly | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly Binding: Initiator Only (required) |
org-managing-org | S | 0..1 | Reference(Sequoia Organization) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org |
PurposesOfUse | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse Binding: Purpose Of Use (preferred) |
StateOfOperation | S | 0..* | Address | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation |
UseCases | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases Binding: Endpoint Use Case Codes (required) | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this |
identifier:NPI | SΣC | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
identifier:CLIA | ΣC | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |
identifier:CCN | SΣC | 0..1 | Identifier | CMS Certification Number (CCN) Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.336 | |
identifier:HCID | SΣC | 1..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
identifier:AAID | SΣC | 0..* | Identifier | OID (such as an Assiging Authority ID) or UUID Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AAID | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use |
Slices for type | SΣ | 1..* | CodeableConcept | Kind of organization Slice: Unordered, Open by pattern:$this Binding: OrganizationType (example): Used to categorize the organization. |
type:sequoiaorgtype | SΣ | 1..1 | CodeableConcept | Kind of organization Binding: Organization Type (required) |
type:hl7orgrole | SΣ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationAffiliationRole (required) |
name | SΣC | 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 |
Slices for telecom | SC | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system |
telecom:All Slices | Content/Rules for all slices | |||
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
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): Use of contact point. |
telecom:phone | SC | 0..* | ContactPoint | A contact detail for the organization |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
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): Use of contact point. |
telecom:email | SC | 0..* | ContactPoint | A contact detail for the organization |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
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): Use of contact point. |
address | SC | 0..* | Address | An address for the organization |
OrgLocation | S | 0..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation Slice: Unordered, Open by value:url |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
line | SΣ | 0..1 | 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 |
state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. |
postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
country | SΣ | 0..1 | string | Must be an ISO 3166 3 letter code |
partOf | SΣ | 0..1 | Reference(Sequoia Organization) | The organization of which this organization forms a part |
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose |
company | S | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Slices for telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system |
telecom:phone | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
telecom:email | S | 0..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact |
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
address | S | 0..1 | Address | Visiting or postal addresses for the contact |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
line | SΣ | 0..1 | 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 |
endpoint | S | 0..* | Reference(Sequoia Endpoint) | Technical endpoints providing access to services operated for the organization |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Organization.type | example | OrganizationType |
Organization.type:sequoiaorgtype | required | OrganizationType (a valid code from Organization Type) |
Organization.type:hl7orgrole | required | OrganizationAffiliationRole |
Organization.telecom.system | required | ContactPointSystem |
Organization.telecom.use | required | ContactPointUse |
Organization.telecom:phone.system | required | Fixed Value: phone |
Organization.telecom:phone.use | required | ContactPointUse |
Organization.telecom:email.system | required | Fixed Value: email |
Organization.telecom:email.use | required | ContactPointUse |
Organization.address.use | required | AddressUse |
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/ ) |
Organization.contact.telecom:phone.system | required | Fixed Value: phone |
Organization.contact.telecom:phone.use | required | ContactPointUse |
Organization.contact.telecom:email.system | required | Fixed Value: email |
Organization.contact.telecom:email.use | required | ContactPointUse |
Organization.contact.address.use | required | AddressUse |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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 | error | 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 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-3 | error | Organization.telecom, Organization.telecom:phone, Organization.telecom:email | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() | |
so-1 | warning | Organization | For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier : endpoint.exists() implies identifier.where(type.coding.code='HCID').first().value.substring(8)=id |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | USCoreOrganizationProfile | This is an abstract profile. A grouping of people or organizations with a common purpose so-1: For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier | ||||
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): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
Domains | S | 1..* | Coding | Domains URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains Binding: Domains (required) | ||||
HubServiceSubscriptions | 0..* | Coding | HubServiceSubscription URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required) | |||||
AdministrativeStatus | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required) | |||||
HubRoutingStatus | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required) | |||||
InitiatorOnly | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly Binding: Initiator Only (required) | ||||
org-managing-org | S | 0..1 | Reference(Sequoia Organization) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org | ||||
PurposesOfUse | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse Binding: Purpose Of Use (preferred) | ||||
StateOfOperation | S | 0..* | Address | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation | ||||
UseCases | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases Binding: Endpoint Use Case Codes (required) | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this | ||||
identifier:NPI | SΣC | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
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) | |||||
identifier:CLIA | ΣC | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |||||
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) | |||||
identifier:CCN | SΣC | 0..1 | Identifier | CMS Certification Number (CCN) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.336 | |||||
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) | |||||
identifier:HCID | SΣC | 1..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |||||
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) | |||||
identifier:AAID | SΣC | 0..* | Identifier | OID (such as an Assiging Authority ID) or UUID Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AAID | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |||||
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 | ||||
Slices for type | SΣ | 1..* | CodeableConcept | Kind of organization Slice: Unordered, Open by pattern:$this Binding: OrganizationType (example): Used to categorize the organization. | ||||
type:sequoiaorgtype | SΣ | 1..1 | CodeableConcept | Kind of organization Binding: Organization Type (required) | ||||
type:hl7orgrole | SΣ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationAffiliationRole (required) | ||||
name | SΣC | 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 | ||||
Slices for telecom | SC | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system | ||||
telecom:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
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): Use of contact point. | ||||
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 | ||||
telecom:phone | SC | 0..* | 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 | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
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): Use of contact point. | ||||
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 | ||||
telecom:email | SC | 0..* | 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 | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
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): Use of contact point. | ||||
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 | SC | 0..* | Address | An address for the organization | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
OrgLocation | S | 0..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation Slice: Unordered, Open by value:url | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | SΣ | 0..1 | 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 (extensible): Two letter USPS alphabetic codes. | ||||
postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
country | SΣ | 0..1 | string | Must be an ISO 3166 3 letter code | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
partOf | SΣ | 0..1 | Reference(Sequoia Organization) | The organization of which this organization forms a part | ||||
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
company | S | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company | ||||
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 | |||||
Slices for telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system | ||||
telecom:phone | S | 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 | |||||
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | Σ | 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): Use of contact point. | ||||
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 | ||||
telecom:email | S | 0..1 | 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 | |||||
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
value | Σ | 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): Use of contact point. | ||||
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 | S | 0..1 | Address | Visiting or postal addresses for the 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 | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | SΣ | 0..1 | 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 | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | Σ | 0..1 | string | Postal code for area 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-23","end":"2010-07-01"} | ||||
endpoint | S | 0..* | Reference(Sequoia Endpoint) | Technical endpoints providing access to services operated for the organization | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Organization.language | preferred | CommonLanguages
| ||||
Organization.type | example | OrganizationType | ||||
Organization.type:sequoiaorgtype | required | OrganizationType (a valid code from Organization Type) | ||||
Organization.type:hl7orgrole | required | OrganizationAffiliationRole | ||||
Organization.telecom.system | required | ContactPointSystem | ||||
Organization.telecom.use | required | ContactPointUse | ||||
Organization.telecom:phone.system | required | Fixed Value: phone | ||||
Organization.telecom:phone.use | required | ContactPointUse | ||||
Organization.telecom:email.system | required | Fixed Value: email | ||||
Organization.telecom:email.use | required | ContactPointUse | ||||
Organization.address.use | required | AddressUse | ||||
Organization.address.type | required | AddressType | ||||
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/ ) | ||||
Organization.contact.purpose | extensible | ContactEntityType | ||||
Organization.contact.telecom:phone.system | required | Fixed Value: phone | ||||
Organization.contact.telecom:phone.use | required | ContactPointUse | ||||
Organization.contact.telecom:email.system | required | Fixed Value: email | ||||
Organization.contact.telecom:email.use | required | ContactPointUse | ||||
Organization.contact.address.use | required | AddressUse | ||||
Organization.contact.address.type | required | AddressType |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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 | error | 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 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-3 | error | Organization.telecom, Organization.telecom:phone, Organization.telecom:email | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() | |
so-1 | warning | Organization | For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier : endpoint.exists() implies identifier.where(type.coding.code='HCID').first().value.substring(8)=id |
This structure is derived from USCoreOrganizationProfile
Summary
Mandatory: 6 elements (2 nested mandatory elements)
Must-Support: 37 elements
Fixed Value: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from USCoreOrganizationProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | USCoreOrganizationProfile | This is an abstract profile. A grouping of people or organizations with a common purpose so-1: For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier |
extension | 1..* | Extension | Extension | |
Domains | S | 1..* | Coding | Domains URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains Binding: Domains (required) |
HubServiceSubscriptions | 0..* | Coding | HubServiceSubscription URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required) | |
AdministrativeStatus | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required) | |
HubRoutingStatus | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required) | |
InitiatorOnly | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly Binding: Initiator Only (required) |
org-managing-org | S | 0..1 | Reference(Sequoia Organization) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org |
PurposesOfUse | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse Binding: Purpose Of Use (preferred) |
StateOfOperation | S | 0..* | Address | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation |
UseCases | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases Binding: Endpoint Use Case Codes (required) | |
identifier | 1..* | Identifier | Identifies this organization across multiple systems | |
identifier:CCN | S | 0..1 | Identifier | CMS Certification Number (CCN) Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.336 | |
identifier:HCID | S | 1..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
identifier:AAID | S | 0..* | Identifier | OID (such as an Assiging Authority ID) or UUID Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AAID | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
active | S | 1..1 | boolean | Whether the organization's record is still in active use |
Slices for type | S | 1..* | CodeableConcept | Kind of organization Slice: Unordered, Open by pattern:$this |
type:sequoiaorgtype | S | 1..1 | CodeableConcept | Kind of organization Binding: Organization Type (required) |
type:hl7orgrole | S | 0..* | CodeableConcept | Kind of organization Binding: OrganizationAffiliationRole (required) |
name | S | 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 |
Slices for telecom | S | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system |
telecom:phone | S | 0..* | ContactPoint | A contact detail for the organization |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
telecom:email | S | 0..* | ContactPoint | A contact detail for the organization |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
address | S | 0..* | Address | An address for the organization |
OrgLocation | S | 0..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation |
line | S | 0..1 | string | Street name, number, direction & P.O. Box etc. |
city | S | 0..1 | string | Name of city, town etc. |
state | S | 0..1 | string | Sub-unit of country (abbreviations ok) |
postalCode | S | 0..1 | string | US Zip Codes |
country | S | 0..1 | string | Must be an ISO 3166 3 letter code |
partOf | S | 0..1 | Reference(Sequoia Organization) | The organization of which this organization forms a part |
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose |
company | S | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company |
Slices for telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system |
telecom:phone | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
telecom:email | S | 0..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
address | S | 0..1 | Address | Visiting or postal addresses for the contact |
line | S | 0..1 | string | Street name, number, direction & P.O. Box etc. |
endpoint | S | 0..* | Reference(Sequoia Endpoint) | Technical endpoints providing access to services operated for the organization |
Documentation for this format |
Path | Conformance | ValueSet |
Organization.type:sequoiaorgtype | required | OrganizationType (a valid code from Organization Type) |
Organization.type:hl7orgrole | required | OrganizationAffiliationRole |
Id | Grade | Path(s) | Details | Requirements |
so-1 | warning | Organization | For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier : endpoint.exists() implies identifier.where(type.coding.code='HCID').first().value.substring(8)=id |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | USCoreOrganizationProfile | This is an abstract profile. A grouping of people or organizations with a common purpose so-1: For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
Domains | S | 1..* | Coding | Domains URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains Binding: Domains (required) |
HubServiceSubscriptions | 0..* | Coding | HubServiceSubscription URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required) | |
AdministrativeStatus | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required) | |
HubRoutingStatus | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required) | |
InitiatorOnly | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly Binding: Initiator Only (required) |
org-managing-org | S | 0..1 | Reference(Sequoia Organization) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org |
PurposesOfUse | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse Binding: Purpose Of Use (preferred) |
StateOfOperation | S | 0..* | Address | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation |
UseCases | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases Binding: Endpoint Use Case Codes (required) | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this |
identifier:NPI | SΣC | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
identifier:CLIA | ΣC | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |
identifier:CCN | SΣC | 0..1 | Identifier | CMS Certification Number (CCN) Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.336 | |
identifier:HCID | SΣC | 1..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
identifier:AAID | SΣC | 0..* | Identifier | OID (such as an Assiging Authority ID) or UUID Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AAID | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use |
Slices for type | SΣ | 1..* | CodeableConcept | Kind of organization Slice: Unordered, Open by pattern:$this Binding: OrganizationType (example): Used to categorize the organization. |
type:sequoiaorgtype | SΣ | 1..1 | CodeableConcept | Kind of organization Binding: Organization Type (required) |
type:hl7orgrole | SΣ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationAffiliationRole (required) |
name | SΣC | 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 |
Slices for telecom | SC | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system |
telecom:All Slices | Content/Rules for all slices | |||
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
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): Use of contact point. |
telecom:phone | SC | 0..* | ContactPoint | A contact detail for the organization |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
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): Use of contact point. |
telecom:email | SC | 0..* | ContactPoint | A contact detail for the organization |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
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): Use of contact point. |
address | SC | 0..* | Address | An address for the organization |
OrgLocation | S | 0..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation Slice: Unordered, Open by value:url |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
line | SΣ | 0..1 | 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 |
state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. |
postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
country | SΣ | 0..1 | string | Must be an ISO 3166 3 letter code |
partOf | SΣ | 0..1 | Reference(Sequoia Organization) | The organization of which this organization forms a part |
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose |
company | S | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Slices for telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system |
telecom:phone | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
telecom:email | S | 0..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact |
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
address | S | 0..1 | Address | Visiting or postal addresses for the contact |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
line | SΣ | 0..1 | 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 |
endpoint | S | 0..* | Reference(Sequoia Endpoint) | Technical endpoints providing access to services operated for the organization |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Organization.type | example | OrganizationType |
Organization.type:sequoiaorgtype | required | OrganizationType (a valid code from Organization Type) |
Organization.type:hl7orgrole | required | OrganizationAffiliationRole |
Organization.telecom.system | required | ContactPointSystem |
Organization.telecom.use | required | ContactPointUse |
Organization.telecom:phone.system | required | Fixed Value: phone |
Organization.telecom:phone.use | required | ContactPointUse |
Organization.telecom:email.system | required | Fixed Value: email |
Organization.telecom:email.use | required | ContactPointUse |
Organization.address.use | required | AddressUse |
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/ ) |
Organization.contact.telecom:phone.system | required | Fixed Value: phone |
Organization.contact.telecom:phone.use | required | ContactPointUse |
Organization.contact.telecom:email.system | required | Fixed Value: email |
Organization.contact.telecom:email.use | required | ContactPointUse |
Organization.contact.address.use | required | AddressUse |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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 | error | 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 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-3 | error | Organization.telecom, Organization.telecom:phone, Organization.telecom:email | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() | |
so-1 | warning | Organization | For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier : endpoint.exists() implies identifier.where(type.coding.code='HCID').first().value.substring(8)=id |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | USCoreOrganizationProfile | This is an abstract profile. A grouping of people or organizations with a common purpose so-1: For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier | ||||
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): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
Domains | S | 1..* | Coding | Domains URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains Binding: Domains (required) | ||||
HubServiceSubscriptions | 0..* | Coding | HubServiceSubscription URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required) | |||||
AdministrativeStatus | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required) | |||||
HubRoutingStatus | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required) | |||||
InitiatorOnly | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly Binding: Initiator Only (required) | ||||
org-managing-org | S | 0..1 | Reference(Sequoia Organization) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org | ||||
PurposesOfUse | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse Binding: Purpose Of Use (preferred) | ||||
StateOfOperation | S | 0..* | Address | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation | ||||
UseCases | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases Binding: Endpoint Use Case Codes (required) | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this | ||||
identifier:NPI | SΣC | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
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) | |||||
identifier:CLIA | ΣC | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |||||
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) | |||||
identifier:CCN | SΣC | 0..1 | Identifier | CMS Certification Number (CCN) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.336 | |||||
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) | |||||
identifier:HCID | SΣC | 1..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |||||
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) | |||||
identifier:AAID | SΣC | 0..* | Identifier | OID (such as an Assiging Authority ID) or UUID Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AAID | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |||||
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 | ||||
Slices for type | SΣ | 1..* | CodeableConcept | Kind of organization Slice: Unordered, Open by pattern:$this Binding: OrganizationType (example): Used to categorize the organization. | ||||
type:sequoiaorgtype | SΣ | 1..1 | CodeableConcept | Kind of organization Binding: Organization Type (required) | ||||
type:hl7orgrole | SΣ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationAffiliationRole (required) | ||||
name | SΣC | 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 | ||||
Slices for telecom | SC | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system | ||||
telecom:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
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): Use of contact point. | ||||
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 | ||||
telecom:phone | SC | 0..* | 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 | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
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): Use of contact point. | ||||
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 | ||||
telecom:email | SC | 0..* | 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 | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
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): Use of contact point. | ||||
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 | SC | 0..* | Address | An address for the organization | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
OrgLocation | S | 0..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation Slice: Unordered, Open by value:url | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | SΣ | 0..1 | 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 (extensible): Two letter USPS alphabetic codes. | ||||
postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
country | SΣ | 0..1 | string | Must be an ISO 3166 3 letter code | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
partOf | SΣ | 0..1 | Reference(Sequoia Organization) | The organization of which this organization forms a part | ||||
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
company | S | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company | ||||
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 | |||||
Slices for telecom | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system | ||||
telecom:phone | S | 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 | |||||
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | Σ | 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): Use of contact point. | ||||
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 | ||||
telecom:email | S | 0..1 | 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 | |||||
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
value | Σ | 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): Use of contact point. | ||||
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 | S | 0..1 | Address | Visiting or postal addresses for the 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 | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | SΣ | 0..1 | 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 | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | Σ | 0..1 | string | Postal code for area 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-23","end":"2010-07-01"} | ||||
endpoint | S | 0..* | Reference(Sequoia Endpoint) | Technical endpoints providing access to services operated for the organization | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Organization.language | preferred | CommonLanguages
| ||||
Organization.type | example | OrganizationType | ||||
Organization.type:sequoiaorgtype | required | OrganizationType (a valid code from Organization Type) | ||||
Organization.type:hl7orgrole | required | OrganizationAffiliationRole | ||||
Organization.telecom.system | required | ContactPointSystem | ||||
Organization.telecom.use | required | ContactPointUse | ||||
Organization.telecom:phone.system | required | Fixed Value: phone | ||||
Organization.telecom:phone.use | required | ContactPointUse | ||||
Organization.telecom:email.system | required | Fixed Value: email | ||||
Organization.telecom:email.use | required | ContactPointUse | ||||
Organization.address.use | required | AddressUse | ||||
Organization.address.type | required | AddressType | ||||
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/ ) | ||||
Organization.contact.purpose | extensible | ContactEntityType | ||||
Organization.contact.telecom:phone.system | required | Fixed Value: phone | ||||
Organization.contact.telecom:phone.use | required | ContactPointUse | ||||
Organization.contact.telecom:email.system | required | Fixed Value: email | ||||
Organization.contact.telecom:email.use | required | ContactPointUse | ||||
Organization.contact.address.use | required | AddressUse | ||||
Organization.contact.address.type | required | AddressType |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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 | error | 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 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-3 | error | Organization.telecom, Organization.telecom:phone, Organization.telecom:email | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() | |
so-1 | warning | Organization | For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier : endpoint.exists() implies identifier.where(type.coding.code='HCID').first().value.substring(8)=id |
This structure is derived from USCoreOrganizationProfile
Summary
Mandatory: 6 elements (2 nested mandatory elements)
Must-Support: 37 elements
Fixed Value: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron