Sequoia Project Healthcare Directory Implementation Guide
0.0.1 - CI Build

Sequoia Project Healthcare Directory Implementation Guide - Local Development build (v0.0.1). See the Directory of published versions

Resource Profile: Sequoia Organization

Defining URL:https://sequoiaproject.org/fhir/sphd/StructureDefinition/SequoiaOrganization
Version:0.0.1
Name:SequoiaOrganization
Title:Sequoia Organization
Status:Active as of 2021-02-26T13:58:23+00:00
Publisher:The Sequoia Project
Copyright:

This document is copyright 2017-18 by The Sequoia Project. All rights reserved world wide.

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://sequoiaproject.org/fhir/sphd/StructureDefinition/SequoiaOrganization

Formal Views of Profile Content

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

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 35 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:

  • The element Organization.type is sliced based on the value of pattern:$this
  • The element Organization.telecom is sliced based on the value of value:system
  • The element Organization.contact.telecom is sliced based on the value of value:system

This structure is derived from USCoreOrganizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*USCoreOrganizationProfileThis is an abstract profile
A grouping of people or organizations with a common purpose
... Domains S1..*CodingDomains
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
... HubServiceSubscriptions S0..*CodingHubServiceSubscription
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
... AdministrativeStatus S0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus
Binding: Administrative Status (required)
... org-businesskey S0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-businesskey
... org-managing-org S0..1Reference(Sequoia Organization)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
... identifier:CCN S0..1IdentifierCMS Certification Number (CCN)
Required Pattern: At least the following
.... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.336
... active S1..1booleanWhether the organization's record is still in active use
... type S1..*(Slice Definition)Kind of organization
Slice: Unordered, Open by pattern:$this
.... type:sequoiaorgtype S1..1CodeableConceptKind of organization
Binding: Organization Type (required)
... name S1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom S0..*(Slice Definition)A contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:phone S0..*ContactPointA contact detail for the organization
..... system S1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
.... telecom:email S0..*ContactPointA contact detail for the organization
..... system S1..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
... address S0..*AddressAn address for the organization
.... OrgLocation S0..*Reference(Sequoia Location)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
.... line S0..1stringStreet name, number, direction & P.O. Box etc.
.... city S0..1stringName of city, town etc.
.... state S0..1stringSub-unit of country (abbreviations ok)
.... postalCode S0..1stringUS Zip Codes
.... country S0..1stringMust be an ISO 3166 3 letter code
... partOf S0..1Reference(Sequoia Organization)The organization of which this organization forms a part
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... person-company S0..*stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/person-company
.... telecom S0..*(Slice Definition)Contact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:phone S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... system S0..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
..... telecom:email S0..1ContactPointContact details (telephone, email, etc.) for a contact
...... system S0..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
.... address S0..1AddressVisiting or postal addresses for the contact
..... line S0..1stringStreet name, number, direction & P.O. Box etc.
... endpoint S0..*Reference(Sequoia Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*USCoreOrganizationProfileThis is an abstract profile
A grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... Domains S1..*CodingDomains
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
... HubServiceSubscriptions S0..*CodingHubServiceSubscription
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
... AdministrativeStatus S0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus
Binding: Administrative Status (required)
... HubRoutingStatus S0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus
Binding: Hub Routing Status (required)
... org-businesskey S0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-businesskey
... org-managing-org S0..1Reference(Sequoia Organization)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*(Slice Definition)Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣI0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:CLIA ΣI0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:CCN SΣI0..1IdentifierCMS Certification Number (CCN)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.336
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... type SΣ1..*(Slice Definition)Kind of organization
Slice: Unordered, Open by pattern:$this
Binding: OrganizationType (example): Used to categorize the organization.


.... type:sequoiaorgtype SΣ1..1CodeableConceptKind of organization
Binding: Organization Type (required)
... name SΣI1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SI0..*(Slice Definition)A contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:phone SI0..*ContactPointA contact detail for the organization
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:email SI0..*ContactPointA contact detail for the organization
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... address SI0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... OrgLocation S0..*Reference(Sequoia Location)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..1stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringMust be an ISO 3166 3 letter code
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf SΣ0..1Reference(Sequoia Organization)The organization of which this organization forms a part
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... person-company S0..*stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/person-company
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1HumanNameA name associated with the contact
.... telecom S0..*(Slice Definition)Contact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:phone S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
...... value Σ0..1stringThe actual contact point details
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

...... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
...... period Σ0..1PeriodTime period when the contact point was/is in use
..... telecom:email S0..1ContactPointContact details (telephone, email, etc.) for a contact
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
...... value Σ0..1stringThe actual contact point details
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

...... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
...... period Σ0..1PeriodTime period when the contact point was/is in use
.... address S0..1AddressVisiting or postal addresses for the contact
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ0..1stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... endpoint S0..*Reference(Sequoia Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*USCoreOrganizationProfileThis is an abstract profile
A grouping of people or organizations with a common purpose
... Domains 1..*CodingDomains
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
... HubServiceSubscriptions 0..*CodingHubServiceSubscription
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
... AdministrativeStatus 0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus
Binding: Administrative Status (required)
... org-businesskey 0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-businesskey
... org-managing-org 0..1Reference(Sequoia Organization)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
... identifier ΣI0..*(Slice Definition)Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI ΣI0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... identifier:CCN ΣI0..1IdentifierCMS Certification Number (CCN)

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.336
... active ?!Σ1..1booleanWhether the organization's record is still in active use
... type Σ1..*(Slice Definition)Kind of organization
Slice: Unordered, Open by pattern:$this
Binding: OrganizationType (example): Used to categorize the organization.


.... type:sequoiaorgtype Σ1..1CodeableConceptKind of organization
Binding: Organization Type (required)
... name ΣI1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom I0..*(Slice Definition)A contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:phone I0..*ContactPointA contact detail for the organization
..... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
.... telecom:email I0..*ContactPointA contact detail for the organization
..... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
... address I0..*AddressAn address for the organization
.... OrgLocation 0..*Reference(Sequoia Location)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Slice: Unordered, Open by value:url
.... line Σ0..1stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
.... city Σ0..1stringName of city, town etc.
.... state Σ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode Σ0..1stringUS Zip Codes
.... country Σ0..1stringMust be an ISO 3166 3 letter code
... partOf Σ0..1Reference(Sequoia Organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... person-company 0..*stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/person-company
.... telecom 0..*(Slice Definition)Contact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:phone 0..*ContactPointContact details (telephone, email, etc.) for a contact
...... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... telecom:email 0..1ContactPointContact details (telephone, email, etc.) for a contact
...... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
.... address 0..1AddressVisiting or postal addresses for the contact
..... line Σ0..1stringStreet 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

doco Documentation for this format

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 35 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:

  • The element Organization.type is sliced based on the value of pattern:$this
  • The element Organization.telecom is sliced based on the value of value:system
  • The element Organization.contact.telecom is sliced based on the value of value:system

Differential View

This structure is derived from USCoreOrganizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*USCoreOrganizationProfileThis is an abstract profile
A grouping of people or organizations with a common purpose
... Domains S1..*CodingDomains
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
... HubServiceSubscriptions S0..*CodingHubServiceSubscription
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
... AdministrativeStatus S0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus
Binding: Administrative Status (required)
... org-businesskey S0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-businesskey
... org-managing-org S0..1Reference(Sequoia Organization)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
... identifier:CCN S0..1IdentifierCMS Certification Number (CCN)
Required Pattern: At least the following
.... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.336
... active S1..1booleanWhether the organization's record is still in active use
... type S1..*(Slice Definition)Kind of organization
Slice: Unordered, Open by pattern:$this
.... type:sequoiaorgtype S1..1CodeableConceptKind of organization
Binding: Organization Type (required)
... name S1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom S0..*(Slice Definition)A contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:phone S0..*ContactPointA contact detail for the organization
..... system S1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
.... telecom:email S0..*ContactPointA contact detail for the organization
..... system S1..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
... address S0..*AddressAn address for the organization
.... OrgLocation S0..*Reference(Sequoia Location)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
.... line S0..1stringStreet name, number, direction & P.O. Box etc.
.... city S0..1stringName of city, town etc.
.... state S0..1stringSub-unit of country (abbreviations ok)
.... postalCode S0..1stringUS Zip Codes
.... country S0..1stringMust be an ISO 3166 3 letter code
... partOf S0..1Reference(Sequoia Organization)The organization of which this organization forms a part
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... person-company S0..*stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/person-company
.... telecom S0..*(Slice Definition)Contact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:phone S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... system S0..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
..... telecom:email S0..1ContactPointContact details (telephone, email, etc.) for a contact
...... system S0..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
.... address S0..1AddressVisiting or postal addresses for the contact
..... line S0..1stringStreet name, number, direction & P.O. Box etc.
... endpoint S0..*Reference(Sequoia Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*USCoreOrganizationProfileThis is an abstract profile
A grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... Domains S1..*CodingDomains
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/Domains
Binding: Domains (required)
... HubServiceSubscriptions S0..*CodingHubServiceSubscription
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubServiceSubscriptions
Binding: Hub Service Subscriptions (required)
... AdministrativeStatus S0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/AdministrativeStatus
Binding: Administrative Status (required)
... HubRoutingStatus S0..1CodingExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/HubRoutingStatus
Binding: Hub Routing Status (required)
... org-businesskey S0..1stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-businesskey
... org-managing-org S0..1Reference(Sequoia Organization)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/org-managing-org
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*(Slice Definition)Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣI0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:CLIA ΣI0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:CCN SΣI0..1IdentifierCMS Certification Number (CCN)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.336
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... type SΣ1..*(Slice Definition)Kind of organization
Slice: Unordered, Open by pattern:$this
Binding: OrganizationType (example): Used to categorize the organization.


.... type:sequoiaorgtype SΣ1..1CodeableConceptKind of organization
Binding: Organization Type (required)
... name SΣI1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SI0..*(Slice Definition)A contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:phone SI0..*ContactPointA contact detail for the organization
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:email SI0..*ContactPointA contact detail for the organization
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... address SI0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... OrgLocation S0..*Reference(Sequoia Location)Extension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/OrgLocation
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..1stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringMust be an ISO 3166 3 letter code
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf SΣ0..1Reference(Sequoia Organization)The organization of which this organization forms a part
... contact S0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... person-company S0..*stringExtension
URL: https://sequoiaproject.org/fhir/sphd/StructureDefinition/person-company
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1HumanNameA name associated with the contact
.... telecom S0..*(Slice Definition)Contact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
..... telecom:phone S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
...... value Σ0..1stringThe actual contact point details
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

...... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
...... period Σ0..1PeriodTime period when the contact point was/is in use
..... telecom:email S0..1ContactPointContact details (telephone, email, etc.) for a contact
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
...... value Σ0..1stringThe actual contact point details
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

...... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
...... period Σ0..1PeriodTime period when the contact point was/is in use
.... address S0..1AddressVisiting or postal addresses for the contact
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ0..1stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... endpoint S0..*Reference(Sequoia Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Organization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Organization.typeexampleOrganizationType
Organization.type:sequoiaorgtyperequiredOrganizationType
Organization.telecom:phone.systemrequiredFixed Value: phone
Organization.telecom:phone.userequiredContactPointUse
Organization.telecom:email.systemrequiredFixed Value: email
Organization.telecom:email.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes
Organization.contact.purposeextensibleContactEntityType
Organization.contact.telecom:phone.systemrequiredFixed Value: phone
Organization.contact.telecom:phone.userequiredContactPointUse
Organization.contact.telecom:email.systemrequiredFixed Value: email
Organization.contact.telecom:email.userequiredContactPointUse
Organization.contact.address.userequiredAddressUse
Organization.contact.address.typerequiredAddressType

Constraints

IdPathDetailsRequirements
dom-2OrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3OrganizationIf 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-4OrganizationIf 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-5OrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6OrganizationA resource should have narrative for robust management
: text.`div`.exists()
org-1OrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
ele-1Organization.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.extension:DomainsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.extension:DomainsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.extension:HubServiceSubscriptionsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.extension:HubServiceSubscriptionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.extension:AdministrativeStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.extension:AdministrativeStatusMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.extension:HubRoutingStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.extension:HubRoutingStatusMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.extension:org-businesskeyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.extension:org-businesskeyMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.extension:org-managing-orgAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.extension:org-managing-orgMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:NPIAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:CLIAAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.identifier:CCNAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.type:sequoiaorgtypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.aliasAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
org-3Organization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
ele-1Organization.telecom:phoneAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
org-3Organization.telecom:phoneThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
ele-1Organization.telecom:phone.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.telecom:phone.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.telecom:phone.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.telecom:phone.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.telecom:phone.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.telecom:phone.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.telecom:phone.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.telecom:emailAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
org-3Organization.telecom:emailThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
ele-1Organization.telecom:email.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.telecom:email.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.telecom:email.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.telecom:email.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.telecom:email.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.telecom:email.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.telecom:email.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
org-2Organization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
ele-1Organization.address.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.address.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.address.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.lineAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.cityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.districtAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.stateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.postalCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.countryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.address.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.contact.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.contact.extension:person-companyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.contact.extension:person-companyMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.contact.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.contact.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.contact.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.telecom:phoneAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.telecom:phone.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.contact.telecom:phone.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.contact.telecom:phone.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.telecom:phone.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.telecom:phone.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.telecom:phone.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.telecom:phone.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.telecom:emailAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.telecom:email.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.contact.telecom:email.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.contact.telecom:email.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.telecom:email.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.telecom:email.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.telecom:email.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.telecom:email.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.address.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Organization.contact.address.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Organization.contact.address.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.address.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.address.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.address.lineAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.address.cityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.address.districtAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.address.stateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.address.postalCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.address.countryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.contact.address.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Organization.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())