Sequoia Project Healthcare Directory Implementation Guide
0.0.1 - CI Build
US
Sequoia Project Healthcare Directory Implementation Guide - Local Development build (v0.0.1). See the Directory of published versions
Official URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/SequoiaOrganization | Version: 0.0.1 | |||
Active as of 2022-07-30 | Computable Name: SequoiaOrganization | |||
Copyright/Legal: This document is copyright 2017-18 by The Sequoia Project. All rights reserved world wide. |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreOrganizationProfile
Summary
Mandatory: 4 elements (2 nested mandatory elements)
Must-Support: 38 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:
This structure is derived from USCoreOrganizationProfile
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 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 |
![]() ![]() ![]() | S | 1..* | Coding | Domains URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains Binding: Domains (required) |
![]() ![]() ![]() | 0..* | Coding | HubServiceSubscription URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required) | |
![]() ![]() ![]() | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required) | |
![]() ![]() ![]() | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required) | |
![]() ![]() ![]() | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly Binding: Initiator Only (required) |
![]() ![]() ![]() | S | 0..1 | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-businesskey |
![]() ![]() ![]() | S | 0..1 | Reference(Sequoia Organization) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse Binding: Purpose Of Use (required) |
![]() ![]() ![]() | S | 0..* | Address | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases Binding: Endpoint Use Case Codes (required) |
![]() ![]() ![]() | S | 0..1 | Identifier | CMS Certification Number (CCN) Required Pattern: At least the following |
![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.336 | |
![]() ![]() ![]() | S | 1..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: At least the following |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID | |
![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
![]() ![]() ![]() | S | 1..1 | boolean | Whether the organization's record is still in active use |
![]() ![]() ![]() | S | 1..* | CodeableConcept | Kind of organization Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | Kind of organization Binding: Organization Type (required) |
![]() ![]() ![]() ![]() | S | 0..* | CodeableConcept | Kind of organization Binding: OrganizationAffiliationRole (required) |
![]() ![]() ![]() | S | 1..1 | string | Name used for the organization |
![]() ![]() ![]() | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past |
![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the organization |
![]() ![]() ![]() ![]() ![]() | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the organization |
![]() ![]() ![]() ![]() ![]() | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
![]() ![]() ![]() | S | 0..* | Address | An address for the organization |
![]() ![]() ![]() ![]() | S | 0..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation |
![]() ![]() ![]() ![]() | S | 0..1 | string | Street name, number, direction & P.O. Box etc. |
![]() ![]() ![]() ![]() | S | 0..1 | string | Name of city, town etc. |
![]() ![]() ![]() ![]() | S | 0..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() ![]() | S | 0..1 | string | US Zip Codes |
![]() ![]() ![]() ![]() | S | 0..1 | string | Must be an ISO 3166 3 letter code |
![]() ![]() ![]() | S | 0..1 | Reference(Sequoia Organization) | The organization of which this organization forms a part |
![]() ![]() ![]() | S | 0..* | BackboneElement | Contact for the organization for a certain purpose |
![]() ![]() ![]() ![]() | S | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company |
![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
![]() ![]() ![]() ![]() ![]() ![]() | S | 0..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact |
![]() ![]() ![]() ![]() ![]() ![]() | S | 0..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
![]() ![]() ![]() ![]() | S | 0..1 | Address | Visiting or postal addresses for the contact |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | string | Street name, number, direction & P.O. Box etc. |
![]() ![]() ![]() | S | 0..* | Reference(Sequoia Endpoint) | Technical endpoints providing access to services operated for the organization |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | I | 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 | ||||
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | S | 1..* | Coding | Domains URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains Binding: Domains (required) | ||||
![]() ![]() ![]() | 0..* | Coding | HubServiceSubscription URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required) | |||||
![]() ![]() ![]() | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required) | |||||
![]() ![]() ![]() | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required) | |||||
![]() ![]() ![]() | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly Binding: Initiator Only (required) | ||||
![]() ![]() ![]() | S | 0..1 | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-businesskey | ||||
![]() ![]() ![]() | S | 0..1 | Reference(Sequoia Organization) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org | ||||
![]() ![]() ![]() | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse Binding: Purpose Of Use (required) | ||||
![]() ![]() ![]() | S | 0..* | Address | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation | ||||
![]() ![]() ![]() | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases Binding: Endpoint Use Case Codes (required) | ||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | SΣI | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this | ||||
![]() ![]() ![]() ![]() | SΣI | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() ![]() | ΣI | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() ![]() | SΣI | 0..1 | Identifier | CMS Certification Number (CCN) Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.336 | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() ![]() | SΣI | 1..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use | ||||
![]() ![]() ![]() | SΣ | 1..* | CodeableConcept | Kind of organization Slice: Unordered, Open by pattern:$this Binding: OrganizationType (example): Used to categorize the organization. | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | Kind of organization Binding: Organization Type (required) | ||||
![]() ![]() ![]() ![]() | SΣ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationAffiliationRole (required) | ||||
![]() ![]() ![]() | SΣI | 1..1 | string | Name used for the organization | ||||
![]() ![]() ![]() | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | ||||
![]() ![]() ![]() | SI | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() | SI | 0..* | ContactPoint | A contact detail for the organization | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | SΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() | SI | 0..* | ContactPoint | A contact detail for the organization | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | SΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() | SI | 0..* | Address | An address for the organization | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | S | 0..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() | 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 | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Must be an ISO 3166 3 letter code | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() | SΣ | 0..1 | Reference(Sequoia Organization) | The organization of which this organization forms a part | ||||
![]() ![]() ![]() | S | 0..* | BackboneElement | Contact for the organization for a certain purpose | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | S | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company | ||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
![]() ![]() ![]() ![]() | 0..1 | HumanName | A name associated with the contact | |||||
![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | ||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() ![]() | S | 0..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact | ||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() | S | 0..1 | Address | Visiting or postal addresses for the contact | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() ![]() | 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 | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() | S | 0..* | Reference(Sequoia Endpoint) | Technical endpoints providing access to services operated for the organization | ||||
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 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 |
![]() ![]() ![]() | 1..* | Coding | Domains URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains Binding: Domains (required) | |
![]() ![]() ![]() | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly Binding: Initiator Only (required) | |
![]() ![]() ![]() | 0..1 | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-businesskey | |
![]() ![]() ![]() | 0..1 | Reference(Sequoia Organization) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org | |
![]() ![]() ![]() | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse Binding: Purpose Of Use (required) | |
![]() ![]() ![]() | 0..* | Address | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation | |
![]() ![]() ![]() | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases Binding: Endpoint Use Case Codes (required) | |
![]() ![]() ![]() | ΣI | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() ![]() | ΣI | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
![]() ![]() ![]() ![]() | ΣI | 0..1 | Identifier | CMS Certification Number (CCN) Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.336 | |
![]() ![]() ![]() ![]() | ΣI | 1..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
![]() ![]() ![]() | ?!Σ | 1..1 | boolean | Whether the organization's record is still in active use |
![]() ![]() ![]() | Σ | 1..* | CodeableConcept | Kind of organization Slice: Unordered, Open by pattern:$this Binding: OrganizationType (example): Used to categorize the organization. |
![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Kind of organization Binding: Organization Type (required) |
![]() ![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationAffiliationRole (required) |
![]() ![]() ![]() | ΣI | 1..1 | string | Name used for the organization |
![]() ![]() ![]() | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
![]() ![]() ![]() | I | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | I | 0..* | ContactPoint | A contact detail for the organization |
![]() ![]() ![]() ![]() ![]() | ΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | I | 0..* | ContactPoint | A contact detail for the organization |
![]() ![]() ![]() ![]() ![]() | ΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The actual contact point details |
![]() ![]() ![]() | I | 0..* | Address | An address for the organization |
![]() ![]() ![]() ![]() | 0..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | Σ | 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 |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Name of city, town etc. |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | US Zip Codes |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Must be an ISO 3166 3 letter code |
![]() ![]() ![]() | Σ | 0..1 | Reference(Sequoia Organization) | The organization of which this organization forms a part |
![]() ![]() ![]() | 0..* | BackboneElement | Contact for the organization for a certain purpose | |
![]() ![]() ![]() ![]() | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company | |
![]() ![]() ![]() ![]() | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() ![]() | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
![]() ![]() ![]() ![]() ![]() | 0..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
![]() ![]() ![]() ![]() | 0..1 | Address | Visiting or postal addresses for the contact | |
![]() ![]() ![]() ![]() ![]() | Σ | 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 |
![]() ![]() ![]() | 0..* | Reference(Sequoia Endpoint) | Technical endpoints providing access to services operated for the organization | |
![]() |
This structure is derived from USCoreOrganizationProfile
Summary
Mandatory: 4 elements (2 nested mandatory elements)
Must-Support: 38 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![]() |
---|---|---|---|---|
![]() ![]() | I | 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 |
![]() ![]() ![]() | S | 1..* | Coding | Domains URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains Binding: Domains (required) |
![]() ![]() ![]() | 0..* | Coding | HubServiceSubscription URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required) | |
![]() ![]() ![]() | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required) | |
![]() ![]() ![]() | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required) | |
![]() ![]() ![]() | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly Binding: Initiator Only (required) |
![]() ![]() ![]() | S | 0..1 | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-businesskey |
![]() ![]() ![]() | S | 0..1 | Reference(Sequoia Organization) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse Binding: Purpose Of Use (required) |
![]() ![]() ![]() | S | 0..* | Address | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases Binding: Endpoint Use Case Codes (required) |
![]() ![]() ![]() | S | 0..1 | Identifier | CMS Certification Number (CCN) Required Pattern: At least the following |
![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.336 | |
![]() ![]() ![]() | S | 1..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: At least the following |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID | |
![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |
![]() ![]() ![]() | S | 1..1 | boolean | Whether the organization's record is still in active use |
![]() ![]() ![]() | S | 1..* | CodeableConcept | Kind of organization Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | Kind of organization Binding: Organization Type (required) |
![]() ![]() ![]() ![]() | S | 0..* | CodeableConcept | Kind of organization Binding: OrganizationAffiliationRole (required) |
![]() ![]() ![]() | S | 1..1 | string | Name used for the organization |
![]() ![]() ![]() | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past |
![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the organization |
![]() ![]() ![]() ![]() ![]() | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the organization |
![]() ![]() ![]() ![]() ![]() | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
![]() ![]() ![]() | S | 0..* | Address | An address for the organization |
![]() ![]() ![]() ![]() | S | 0..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation |
![]() ![]() ![]() ![]() | S | 0..1 | string | Street name, number, direction & P.O. Box etc. |
![]() ![]() ![]() ![]() | S | 0..1 | string | Name of city, town etc. |
![]() ![]() ![]() ![]() | S | 0..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() ![]() | S | 0..1 | string | US Zip Codes |
![]() ![]() ![]() ![]() | S | 0..1 | string | Must be an ISO 3166 3 letter code |
![]() ![]() ![]() | S | 0..1 | Reference(Sequoia Organization) | The organization of which this organization forms a part |
![]() ![]() ![]() | S | 0..* | BackboneElement | Contact for the organization for a certain purpose |
![]() ![]() ![]() ![]() | S | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company |
![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
![]() ![]() ![]() ![]() ![]() ![]() | S | 0..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact |
![]() ![]() ![]() ![]() ![]() ![]() | S | 0..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
![]() ![]() ![]() ![]() | S | 0..1 | Address | Visiting or postal addresses for the contact |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | string | Street name, number, direction & P.O. Box etc. |
![]() ![]() ![]() | S | 0..* | Reference(Sequoia Endpoint) | Technical endpoints providing access to services operated for the organization |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | I | 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 | ||||
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | S | 1..* | Coding | Domains URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains Binding: Domains (required) | ||||
![]() ![]() ![]() | 0..* | Coding | HubServiceSubscription URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required) | |||||
![]() ![]() ![]() | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required) | |||||
![]() ![]() ![]() | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required) | |||||
![]() ![]() ![]() | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/InitiatorOnly Binding: Initiator Only (required) | ||||
![]() ![]() ![]() | S | 0..1 | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-businesskey | ||||
![]() ![]() ![]() | S | 0..1 | Reference(Sequoia Organization) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org | ||||
![]() ![]() ![]() | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/PurposesOfUse Binding: Purpose Of Use (required) | ||||
![]() ![]() ![]() | S | 0..* | Address | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/StateOfOperation | ||||
![]() ![]() ![]() | S | 0..* | CodeableConcept | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/UseCases Binding: Endpoint Use Case Codes (required) | ||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | SΣI | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this | ||||
![]() ![]() ![]() ![]() | SΣI | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() ![]() | ΣI | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() ![]() | SΣI | 0..1 | Identifier | CMS Certification Number (CCN) Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.336 | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() ![]() | SΣI | 1..1 | Identifier | OID (such as a Home Community ID) or UUID Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: https://sequoiaproject.org/fhir/sphd/CodeSystem/SequoiaIdentifierCodes | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: HCID | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use | ||||
![]() ![]() ![]() | SΣ | 1..* | CodeableConcept | Kind of organization Slice: Unordered, Open by pattern:$this Binding: OrganizationType (example): Used to categorize the organization. | ||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | Kind of organization Binding: Organization Type (required) | ||||
![]() ![]() ![]() ![]() | SΣ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationAffiliationRole (required) | ||||
![]() ![]() ![]() | SΣI | 1..1 | string | Name used for the organization | ||||
![]() ![]() ![]() | S | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | ||||
![]() ![]() ![]() | SI | 0..* | ContactPoint | A contact detail for the organization Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() | SI | 0..* | ContactPoint | A contact detail for the organization | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | SΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() | SI | 0..* | ContactPoint | A contact detail for the organization | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | SΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() | SI | 0..* | Address | An address for the organization | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | S | 0..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() | 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 | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Must be an ISO 3166 3 letter code | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() | SΣ | 0..1 | Reference(Sequoia Organization) | The organization of which this organization forms a part | ||||
![]() ![]() ![]() | S | 0..* | BackboneElement | Contact for the organization for a certain purpose | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | S | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/company | ||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
![]() ![]() ![]() ![]() | 0..1 | HumanName | A name associated with the contact | |||||
![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | ||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() ![]() | S | 0..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact | ||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() | S | 0..1 | Address | Visiting or postal addresses for the contact | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() ![]() | 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 | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() | S | 0..* | Reference(Sequoia Endpoint) | Technical endpoints providing access to services operated for the organization | ||||
![]() |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
Organization.language | preferred | CommonLanguages Max Binding: AllLanguages |
Organization.type | example | OrganizationType |
Organization.type:sequoiaorgtype | required | OrganizationType |
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 |
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 | 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() | |
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 | |
so-1 | warning | Organization | For any organization entry with endpoints, the Organization.id value must match the HCID OID contained under Organization.identifier : | |
ele-1 | error | Organization.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Organization.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Organization.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Organization.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | error | Organization.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Organization.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Organization.extension:Domains | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Organization.extension:Domains | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Organization.extension:HubServiceSubscriptions | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Organization.extension:HubServiceSubscriptions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Organization.extension:AdministrativeStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Organization.extension:AdministrativeStatus | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Organization.extension:HubRoutingStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Organization.extension:HubRoutingStatus | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Organization.extension:InitiatorOnly | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Organization.extension:InitiatorOnly | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Organization.extension:org-businesskey | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Organization.extension:org-businesskey | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Organization.extension:org-managing-org | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | Organization.extension:org-managing-org | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | error | Organization.extension:PurposesOfUse | All FHIR |