Universal API Implementation Guide
1.1.19 - ci-build

Universal API Implementation Guide - Local Development build (v1.1.19). See the Directory of published versions

Resource Profile: UAPI Organization

Official URL: https://fhir.developer.gene.com/StructureDefinition/uapi-organization Version: 1.1.19
Active as of 2021-06-04 Responsible: Genentech USIX PE Realm: United States of America flag Computable Name: UapiOrganization

This profile constrains the Organization resource for representing practice and insurance

Usage:

Formal Views of Profile Content

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

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*OrganizationA grouping of people or organizations with a common purpose
... identifier S1..*IdentifierIdentifier used by Genentech to determine insert vs update operation.
.... system 1..1uriThe namespace for the identifier value
.... value 1..1stringUnique identifier for the organization
... type S1..1CodeableConceptOrganization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes

... name S1..1stringMax 255 Characters
.... telecom:All Slices Content/Rules for all slices
..... system S0..1codephone | fax | email | pager | url | sms | other
..... value S0..1stringThe actual contact point details
..... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
.... telecom:Phone S1..*ContactPointA contact detail for the organization
..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
..... value 0..1stringPhone (10 digit numeric values only)
.... telecom:Fax S0..*ContactPointA contact detail for the organization
..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: fax
..... value 0..1stringFax (10 digit numeric values only)
... address S0..*AddressAddress is required for Practice Organization and Site of Treatment
.... line 1..3stringMax 255 Characters
.... city 1..1stringMax 30 Characters
.... state 1..1stringStandard state 2 characters (Ex: CA, AZ, NC..)
.... postalCode 1..1stringMax 10 Characters
... contact S0..*BackboneElementContact is required for Practice Organization
.... name
..... family S1..1stringMax 40 Characters
..... given S1..1stringMax 80 Characters
.... Slices for telecom S1..*ContactPointRequired for Practice Organization
Slice: Unordered, Closed by value:system
..... telecom:All Slices Content/Rules for all slices
...... system S0..1codephone | fax | email | pager | url | sms | other
...... value S0..1stringThe actual contact point details
...... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
..... telecom:Phone S1..*ContactPointContact details (telephone, email, etc.) for a contact
...... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
...... value 0..1stringPhone (10 digit numeric values only)
..... telecom:Fax S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: fax
...... value 0..1stringFax (10 digit numeric values only)
..... telecom:Email S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
...... value 0..1stringEmail format

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Organization.typerequiredUapiValueSetOrganizationType
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*OrganizationA grouping of people or organizations with a common purpose
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣC1..*IdentifierIdentifier used by Genentech to determine insert vs update operation.
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringUnique identifier for the organization
Example General: 123456
... type SΣ1..1CodeableConceptOrganization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes


... name SΣC1..1stringMax 255 Characters
... Slices for telecom SC1..*ContactPointA contact detail for the organization
Slice: Unordered, Closed by value:system
.... telecom:All Slices Content/Rules for all slices
..... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value SΣ0..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... telecom:Phone SC1..*ContactPointA contact detail for the organization
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
..... value Σ0..1stringPhone (10 digit numeric values only)
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... telecom:Fax SC0..*ContactPointA contact detail for the organization
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
..... value Σ0..1stringFax (10 digit numeric values only)
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... address SC0..*AddressAddress is required for Practice Organization and Site of Treatment
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
.... line Σ1..3stringMax 255 Characters
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ1..1stringMax 30 Characters
Example General: Erewhon
.... state Σ1..1stringStandard state 2 characters (Ex: CA, AZ, NC..)
.... postalCode Σ1..1stringMax 10 Characters
Example General: 9132
... contact S0..*BackboneElementContact is required for Practice Organization
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name 0..1HumanNameA name associated with the contact
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... family SΣ1..1stringMax 40 Characters
..... given SΣ1..1stringMax 80 Characters
This repeating element order: Given Names appear in the correct order for presenting the name
.... Slices for telecom S1..*ContactPointRequired for Practice Organization
Slice: Unordered, Closed by value:system
..... telecom:All Slices Content/Rules for all slices
...... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
...... value SΣ0..1stringThe actual contact point details
...... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... telecom:Phone S1..*ContactPointContact details (telephone, email, etc.) for a contact
...... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
...... value Σ0..1stringPhone (10 digit numeric values only)
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... telecom:Fax S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
...... value Σ0..1stringFax (10 digit numeric values only)
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... telecom:Email S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: email
...... value Σ0..1stringEmail format
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organization.identifier.userequiredIdentifierUse
Organization.typerequiredUapiValueSetOrganizationType
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.telecom:Phone.systemrequiredFixed Value: phone
Organization.telecom:Phone.userequiredContactPointUse
Organization.telecom:Fax.systemrequiredFixed Value: fax
Organization.telecom:Fax.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.contact.name.userequiredNameUse
Organization.contact.telecom.systemrequiredContactPointSystem
Organization.contact.telecom.userequiredContactPointUse
Organization.contact.telecom:Phone.systemrequiredFixed Value: phone
Organization.contact.telecom:Phone.userequiredContactPointUse
Organization.contact.telecom:Fax.systemrequiredFixed Value: fax
Organization.contact.telecom:Fax.userequiredContactPointUse
Organization.contact.telecom:Email.systemrequiredFixed Value: email
Organization.contact.telecom:Email.userequiredContactPointUse
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*OrganizationA grouping of people or organizations with a common purpose
... id Σ0..1idLogical 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..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣC1..*IdentifierIdentifier used by Genentech to determine insert vs update operation.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringUnique identifier for the organization
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... type SΣ1..1CodeableConceptOrganization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes


... name SΣC1..1stringMax 255 Characters
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom SC1..*ContactPointA contact detail for the organization
Slice: Unordered, Closed by value:system
.... telecom:All Slices Content/Rules for all slices
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value SΣ0..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:Phone SC1..*ContactPointA contact detail for the organization
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
..... value Σ0..1stringPhone (10 digit numeric values only)
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:Fax SC0..*ContactPointA contact detail for the organization
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
..... value Σ0..1stringFax (10 digit numeric values only)
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... address SC0..*AddressAddress is required for Practice Organization and Site of Treatment
.... id 0..1idUnique 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 (home / work / etc.).


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 Σ1..3stringMax 255 Characters
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ1..1stringMax 30 Characters
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ1..1stringStandard state 2 characters (Ex: CA, AZ, NC..)
.... postalCode Σ1..1stringMax 10 Characters
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"}
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact S0..*BackboneElementContact is required for Practice Organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... 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
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... text Σ0..1stringText representation of the full name
..... family SΣ1..1stringMax 40 Characters
..... given SΣ1..1stringMax 80 Characters
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... Slices for telecom S1..*ContactPointRequired for Practice Organization
Slice: Unordered, Closed by value:system
..... telecom:All Slices Content/Rules for all slices
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
...... value SΣ0..1stringThe actual contact point details
...... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
...... period Σ0..1PeriodTime period when the contact point was/is in use
..... telecom:Phone S1..*ContactPointContact details (telephone, email, etc.) for a contact
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
...... value Σ0..1stringPhone (10 digit numeric values only)
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
...... period Σ0..1PeriodTime period when the contact point was/is in use
..... telecom:Fax S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
...... value Σ0..1stringFax (10 digit numeric values only)
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
...... period Σ0..1PeriodTime period when the contact point was/is in use
..... telecom:Email S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: email
...... value Σ0..1stringEmail format
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
...... period Σ0..1PeriodTime period when the contact point was/is in use
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier.userequiredIdentifierUse
Organization.identifier.typeextensibleIdentifier Type Codes
Organization.typerequiredUapiValueSetOrganizationType
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.telecom:Phone.systemrequiredFixed Value: phone
Organization.telecom:Phone.userequiredContactPointUse
Organization.telecom:Fax.systemrequiredFixed Value: fax
Organization.telecom:Fax.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.contact.purposeextensibleContactEntityType
Organization.contact.name.userequiredNameUse
Organization.contact.telecom.systemrequiredContactPointSystem
Organization.contact.telecom.userequiredContactPointUse
Organization.contact.telecom:Phone.systemrequiredFixed Value: phone
Organization.contact.telecom:Phone.userequiredContactPointUse
Organization.contact.telecom:Fax.systemrequiredFixed Value: fax
Organization.contact.telecom:Fax.userequiredContactPointUse
Organization.contact.telecom:Email.systemrequiredFixed Value: email
Organization.contact.telecom:Email.userequiredContactPointUse

This structure is derived from Organization

Summary

Mandatory: 8 elements (12 nested mandatory elements)
Must-Support: 20 elements
Fixed Value: 5 elements

Slices

This structure defines the following Slices:

  • The element Organization.telecom is sliced based on the value of value:system (Closed)
  • The element Organization.contact.telecom is sliced based on the value of value:system (Closed)

Differential View

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*OrganizationA grouping of people or organizations with a common purpose
... identifier S1..*IdentifierIdentifier used by Genentech to determine insert vs update operation.
.... system 1..1uriThe namespace for the identifier value
.... value 1..1stringUnique identifier for the organization
... type S1..1CodeableConceptOrganization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes

... name S1..1stringMax 255 Characters
.... telecom:All Slices Content/Rules for all slices
..... system S0..1codephone | fax | email | pager | url | sms | other
..... value S0..1stringThe actual contact point details
..... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
.... telecom:Phone S1..*ContactPointA contact detail for the organization
..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
..... value 0..1stringPhone (10 digit numeric values only)
.... telecom:Fax S0..*ContactPointA contact detail for the organization
..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: fax
..... value 0..1stringFax (10 digit numeric values only)
... address S0..*AddressAddress is required for Practice Organization and Site of Treatment
.... line 1..3stringMax 255 Characters
.... city 1..1stringMax 30 Characters
.... state 1..1stringStandard state 2 characters (Ex: CA, AZ, NC..)
.... postalCode 1..1stringMax 10 Characters
... contact S0..*BackboneElementContact is required for Practice Organization
.... name
..... family S1..1stringMax 40 Characters
..... given S1..1stringMax 80 Characters
.... Slices for telecom S1..*ContactPointRequired for Practice Organization
Slice: Unordered, Closed by value:system
..... telecom:All Slices Content/Rules for all slices
...... system S0..1codephone | fax | email | pager | url | sms | other
...... value S0..1stringThe actual contact point details
...... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
..... telecom:Phone S1..*ContactPointContact details (telephone, email, etc.) for a contact
...... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
...... value 0..1stringPhone (10 digit numeric values only)
..... telecom:Fax S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: fax
...... value 0..1stringFax (10 digit numeric values only)
..... telecom:Email S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
...... value 0..1stringEmail format

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Organization.typerequiredUapiValueSetOrganizationType

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*OrganizationA grouping of people or organizations with a common purpose
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣC1..*IdentifierIdentifier used by Genentech to determine insert vs update operation.
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringUnique identifier for the organization
Example General: 123456
... type SΣ1..1CodeableConceptOrganization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes


... name SΣC1..1stringMax 255 Characters
... Slices for telecom SC1..*ContactPointA contact detail for the organization
Slice: Unordered, Closed by value:system
.... telecom:All Slices Content/Rules for all slices
..... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value SΣ0..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... telecom:Phone SC1..*ContactPointA contact detail for the organization
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
..... value Σ0..1stringPhone (10 digit numeric values only)
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... telecom:Fax SC0..*ContactPointA contact detail for the organization
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
..... value Σ0..1stringFax (10 digit numeric values only)
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... address SC0..*AddressAddress is required for Practice Organization and Site of Treatment
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).


Example General: home
.... line Σ1..3stringMax 255 Characters
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ1..1stringMax 30 Characters
Example General: Erewhon
.... state Σ1..1stringStandard state 2 characters (Ex: CA, AZ, NC..)
.... postalCode Σ1..1stringMax 10 Characters
Example General: 9132
... contact S0..*BackboneElementContact is required for Practice Organization
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name 0..1HumanNameA name associated with the contact
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... family SΣ1..1stringMax 40 Characters
..... given SΣ1..1stringMax 80 Characters
This repeating element order: Given Names appear in the correct order for presenting the name
.... Slices for telecom S1..*ContactPointRequired for Practice Organization
Slice: Unordered, Closed by value:system
..... telecom:All Slices Content/Rules for all slices
...... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
...... value SΣ0..1stringThe actual contact point details
...... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... telecom:Phone S1..*ContactPointContact details (telephone, email, etc.) for a contact
...... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
...... value Σ0..1stringPhone (10 digit numeric values only)
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... telecom:Fax S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
...... value Σ0..1stringFax (10 digit numeric values only)
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... telecom:Email S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: email
...... value Σ0..1stringEmail format
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organization.identifier.userequiredIdentifierUse
Organization.typerequiredUapiValueSetOrganizationType
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.telecom:Phone.systemrequiredFixed Value: phone
Organization.telecom:Phone.userequiredContactPointUse
Organization.telecom:Fax.systemrequiredFixed Value: fax
Organization.telecom:Fax.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.contact.name.userequiredNameUse
Organization.contact.telecom.systemrequiredContactPointSystem
Organization.contact.telecom.userequiredContactPointUse
Organization.contact.telecom:Phone.systemrequiredFixed Value: phone
Organization.contact.telecom:Phone.userequiredContactPointUse
Organization.contact.telecom:Fax.systemrequiredFixed Value: fax
Organization.contact.telecom:Fax.userequiredContactPointUse
Organization.contact.telecom:Email.systemrequiredFixed Value: email
Organization.contact.telecom:Email.userequiredContactPointUse

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*OrganizationA grouping of people or organizations with a common purpose
... id Σ0..1idLogical 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..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣC1..*IdentifierIdentifier used by Genentech to determine insert vs update operation.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ1..1stringUnique identifier for the organization
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... type SΣ1..1CodeableConceptOrganization type for enrollment
Binding: UAPI Value Set - Organization Type (required): Organization Type Codes


... name SΣC1..1stringMax 255 Characters
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom SC1..*ContactPointA contact detail for the organization
Slice: Unordered, Closed by value:system
.... telecom:All Slices Content/Rules for all slices
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value SΣ0..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:Phone SC1..*ContactPointA contact detail for the organization
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
..... value Σ0..1stringPhone (10 digit numeric values only)
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:Fax SC0..*ContactPointA contact detail for the organization
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
..... value Σ0..1stringFax (10 digit numeric values only)
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... address SC0..*AddressAddress is required for Practice Organization and Site of Treatment
.... id 0..1idUnique 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 (home / work / etc.).


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 Σ1..3stringMax 255 Characters
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ1..1stringMax 30 Characters
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ1..1stringStandard state 2 characters (Ex: CA, AZ, NC..)
.... postalCode Σ1..1stringMax 10 Characters
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"}
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact S0..*BackboneElementContact is required for Practice Organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... 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
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... text Σ0..1stringText representation of the full name
..... family SΣ1..1stringMax 40 Characters
..... given SΣ1..1stringMax 80 Characters
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... Slices for telecom S1..*ContactPointRequired for Practice Organization
Slice: Unordered, Closed by value:system
..... telecom:All Slices Content/Rules for all slices
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
...... value SΣ0..1stringThe actual contact point details
...... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
...... period Σ0..1PeriodTime period when the contact point was/is in use
..... telecom:Phone S1..*ContactPointContact details (telephone, email, etc.) for a contact
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
...... value Σ0..1stringPhone (10 digit numeric values only)
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
...... period Σ0..1PeriodTime period when the contact point was/is in use
..... telecom:Fax S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: fax
...... value Σ0..1stringFax (10 digit numeric values only)
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
...... period Σ0..1PeriodTime period when the contact point was/is in use
..... telecom:Email S0..*ContactPointContact details (telephone, email, etc.) for a contact
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: email
...... value Σ0..1stringEmail format
...... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
...... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
...... period Σ0..1PeriodTime period when the contact point was/is in use
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier.userequiredIdentifierUse
Organization.identifier.typeextensibleIdentifier Type Codes
Organization.typerequiredUapiValueSetOrganizationType
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.telecom:Phone.systemrequiredFixed Value: phone
Organization.telecom:Phone.userequiredContactPointUse
Organization.telecom:Fax.systemrequiredFixed Value: fax
Organization.telecom:Fax.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.contact.purposeextensibleContactEntityType
Organization.contact.name.userequiredNameUse
Organization.contact.telecom.systemrequiredContactPointSystem
Organization.contact.telecom.userequiredContactPointUse
Organization.contact.telecom:Phone.systemrequiredFixed Value: phone
Organization.contact.telecom:Phone.userequiredContactPointUse
Organization.contact.telecom:Fax.systemrequiredFixed Value: fax
Organization.contact.telecom:Fax.userequiredContactPointUse
Organization.contact.telecom:Email.systemrequiredFixed Value: email
Organization.contact.telecom:Email.userequiredContactPointUse

This structure is derived from Organization

Summary

Mandatory: 8 elements (12 nested mandatory elements)
Must-Support: 20 elements
Fixed Value: 5 elements

Slices

This structure defines the following Slices:

  • The element Organization.telecom is sliced based on the value of value:system (Closed)
  • The element Organization.contact.telecom is sliced based on the value of value:system (Closed)

 

Other representations of profile: CSV, Excel, Schematron