0.0.1 - CI Build
SequoiaProjectHealthcareDirectoryImplementationGuideSTU3 - Local Development build (v0.0.1). See the Directory of published versions
The official URL for this profile is:
https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/SequoiaOrganization
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from US Core Organization Profile
Summary
Mandatory: 1 element
Must-Support: 32 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 US Core Organization Profile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | 0..* | US Core Organization Profile | US Core Organization Profile | |
Domains | S | 0..* | Coding | Domains URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/Domains Binding: Domains (required) |
HubServiceSubscriptions | S | 0..* | Coding | HubServiceSubscription URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required) |
AdministrativeStatus | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required) |
HubRoutingStatus | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required) |
org-businesskey | S | 0..1 | string | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3-internal/StructureDefinition/org-businesskey |
identifier | S | 1..* | Identifier | Identifies this organization across multiple systems |
active | S | 1..1 | boolean | Whether the organization's record is still in active use |
type | S | 1..* | CodeableConcept | Kind of organization Binding: OrganizationType (required) |
name | S | 1..1 | string | Name used for the organization |
telecom | S | 1..* | (Slice Definition) | A contact detail for the organization Slice: Unordered, Open by value:telecom.system |
telecom:phone | S | 1..* | ContactPoint | A contact detail for the organization |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
telecom:email | S | 1..* | ContactPoint | A contact detail for the organization |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
address | S | 1..* | Address | An address for the organization |
OrgLocation | S | 0..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3/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 |
person-company | S | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3-internal/StructureDefinition/person-company |
telecom | S | 0..* | (Slice Definition) | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:telecom.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 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | I | 0..* | US Core Organization Profile | US Core Organization Profile |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Domains | SI | 0..* | Coding | Domains URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/Domains Binding: Domains (required) |
HubServiceSubscriptions | SI | 0..* | Coding | HubServiceSubscription URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required) |
AdministrativeStatus | SI | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required) |
HubRoutingStatus | SI | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required) |
org-businesskey | SI | 0..1 | string | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3-internal/StructureDefinition/org-businesskey |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣI | 1..* | Identifier | Identifies this organization across multiple systems |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use |
type | SΣ | 1..* | CodeableConcept | Kind of organization Binding: OrganizationType (required) |
name | SΣI | 1..1 | string | Name used for the organization |
alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
telecom | SI | 1..* | (Slice Definition) | A contact detail for the organization Slice: Unordered, Open by value:telecom.system |
telecom:phone | SI | 1..* | ContactPoint | A contact detail for the organization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) 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) |
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 | SI | 1..* | ContactPoint | A contact detail for the organization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) 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) |
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
address | SI | 1..* | Address | An address for the organization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
OrgLocation | S | 0..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/OrgLocation Slice: Unordered, Open by value:url |
use | ?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example General: home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General: both |
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
line | SΣ | 0..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 (required) |
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-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"} |
partOf | SΣ | 0..1 | Reference(Sequoia Organization) | The organization of which this organization forms a part |
contact | SI | 0..* | BackboneElement | Contact for the organization for a certain purpose |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
person-company | SI | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3-internal/StructureDefinition/person-company |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible) | |
name | 0..1 | HumanName | A name associated with the contact | |
telecom | S | 0..* | (Slice Definition) | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:telecom.system |
telecom:phone | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) 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) |
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 | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) 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) |
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 | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example General: home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General: both |
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
line | SΣ | 0..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 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | I | 0..* | US Core Organization Profile | US Core Organization Profile |
Domains | I | 0..* | Coding | Domains URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/Domains Binding: Domains (required) |
HubServiceSubscriptions | I | 0..* | Coding | HubServiceSubscription URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required) |
AdministrativeStatus | I | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required) |
HubRoutingStatus | I | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required) |
org-businesskey | I | 0..1 | string | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3-internal/StructureDefinition/org-businesskey |
identifier | ΣI | 1..* | Identifier | Identifies this organization across multiple systems |
system | Σ | 1..1 | uri | The namespace for the identifier value |
active | ?!Σ | 1..1 | boolean | Whether the organization's record is still in active use |
type | Σ | 1..* | CodeableConcept | Kind of organization Binding: OrganizationType (required) |
name | ΣI | 1..1 | string | Name used for the organization |
telecom | I | 1..* | (Slice Definition) | A contact detail for the organization Slice: Unordered, Open by value:telecom.system |
telecom:phone | I | 1..* | ContactPoint | A contact detail for the organization |
system | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: phone |
telecom:email | I | 1..* | ContactPoint | A contact detail for the organization |
system | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: email |
address | I | 1..* | Address | An address for the organization |
OrgLocation | 0..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/OrgLocation Slice: Unordered, Open by value:url | |
line | Σ | 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 |
city | Σ | 0..1 | string | Name of city, town etc. |
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (required) |
postalCode | Σ | 0..1 | string | US Zip Codes |
country | Σ | 0..1 | string | Must be an ISO 3166 3 letter code |
partOf | Σ | 0..1 | Reference(Sequoia Organization) | The organization of which this organization forms a part |
contact | I | 0..* | BackboneElement | Contact for the organization for a certain purpose |
person-company | I | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3-internal/StructureDefinition/person-company |
telecom | 0..* | (Slice Definition) | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:telecom.system | |
telecom:phone | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
system | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: phone |
telecom:email | 0..1 | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
system | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) Fixed Value: email |
address | 0..1 | Address | Visiting or postal addresses for the contact | |
line | Σ | 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 |
endpoint | 0..* | Reference(Sequoia Endpoint) | Technical endpoints providing access to services operated for the organization | |
Documentation for this format |
This structure is derived from US Core Organization Profile
Summary
Mandatory: 1 element
Must-Support: 32 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 US Core Organization Profile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | 0..* | US Core Organization Profile | US Core Organization Profile | |
Domains | S | 0..* | Coding | Domains URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/Domains Binding: Domains (required) |
HubServiceSubscriptions | S | 0..* | Coding | HubServiceSubscription URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required) |
AdministrativeStatus | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required) |
HubRoutingStatus | S | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required) |
org-businesskey | S | 0..1 | string | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3-internal/StructureDefinition/org-businesskey |
identifier | S | 1..* | Identifier | Identifies this organization across multiple systems |
active | S | 1..1 | boolean | Whether the organization's record is still in active use |
type | S | 1..* | CodeableConcept | Kind of organization Binding: OrganizationType (required) |
name | S | 1..1 | string | Name used for the organization |
telecom | S | 1..* | (Slice Definition) | A contact detail for the organization Slice: Unordered, Open by value:telecom.system |
telecom:phone | S | 1..* | ContactPoint | A contact detail for the organization |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
telecom:email | S | 1..* | ContactPoint | A contact detail for the organization |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
address | S | 1..* | Address | An address for the organization |
OrgLocation | S | 0..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3/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 |
person-company | S | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3-internal/StructureDefinition/person-company |
telecom | S | 0..* | (Slice Definition) | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:telecom.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 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | I | 0..* | US Core Organization Profile | US Core Organization Profile |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
Domains | SI | 0..* | Coding | Domains URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/Domains Binding: Domains (required) |
HubServiceSubscriptions | SI | 0..* | Coding | HubServiceSubscription URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/HubServiceSubscriptions Binding: Hub Service Subscriptions (required) |
AdministrativeStatus | SI | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/AdministrativeStatus Binding: Administrative Status (required) |
HubRoutingStatus | SI | 0..1 | Coding | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/HubRoutingStatus Binding: Hub Routing Status (required) |
org-businesskey | SI | 0..1 | string | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3-internal/StructureDefinition/org-businesskey |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣI | 1..* | Identifier | Identifies this organization across multiple systems |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use |
type | SΣ | 1..* | CodeableConcept | Kind of organization Binding: OrganizationType (required) |
name | SΣI | 1..1 | string | Name used for the organization |
alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
telecom | SI | 1..* | (Slice Definition) | A contact detail for the organization Slice: Unordered, Open by value:telecom.system |
telecom:phone | SI | 1..* | ContactPoint | A contact detail for the organization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) 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) |
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 | SI | 1..* | ContactPoint | A contact detail for the organization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) 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) |
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
address | SI | 1..* | Address | An address for the organization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
OrgLocation | S | 0..* | Reference(Sequoia Location) | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3/StructureDefinition/OrgLocation Slice: Unordered, Open by value:url |
use | ?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example General: home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General: both |
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
line | SΣ | 0..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 (required) |
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-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"} |
partOf | SΣ | 0..1 | Reference(Sequoia Organization) | The organization of which this organization forms a part |
contact | SI | 0..* | BackboneElement | Contact for the organization for a certain purpose |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
person-company | SI | 0..* | string | Extension URL: https://sequoiaproject.org/fhir/sphd-stu3-internal/StructureDefinition/person-company |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible) | |
name | 0..1 | HumanName | A name associated with the contact | |
telecom | S | 0..* | (Slice Definition) | Contact details (telephone, email, etc.) for a contact Slice: Unordered, Open by value:telecom.system |
telecom:phone | S | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) 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) |
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 | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | SΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) 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) |
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 | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example General: home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General: both |
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
line | SΣ | 0..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 |
Other representations of profile: Schematron
Path | Conformance | ValueSet / Code |
Organization.language | extensible | Common Languages Max Binding: All Languages |
Organization.identifier.use | required | IdentifierUse |
Organization.identifier.type | extensible | Identifier Type Codes |
Organization.type | required | OrganizationType |
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 | required | USPS Two Letter Alphabetic Codes |
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 | Path | Details | Requirements |
dom-2 | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | Organization | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-3 | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
org-1 | Organization | The organization SHALL at least have a name or an id, and possibly more than one : (identifier.count() + name.count()) > 0 | |
ele-1 | Organization.extension:Domains | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Organization.extension:Domains | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Organization.extension:HubServiceSubscriptions | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Organization.extension:HubServiceSubscriptions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Organization.extension:AdministrativeStatus | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Organization.extension:AdministrativeStatus | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Organization.extension:HubRoutingStatus | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Organization.extension:HubRoutingStatus | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Organization.extension:org-businesskey | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Organization.extension:org-businesskey | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
org-3 | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-3 | Organization.telecom:phone | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-3 | Organization.telecom:email | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-2 | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
ele-1 | Organization.contact | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Organization.contact.extension:person-company | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Organization.contact.extension:person-company | Must have either extensions or value[x], not both : extension.exists() != value.exists() |