FHIR Implementation Guide for NJSAMS


0.1.0 - draft New Jersey

NJSAMS - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: NJSAMSOrganization

Official URL: http://dhs.nj.gov/njsams/StructureDefinition/NJSAMSOrganization Version: 0.1.0
Active as of 2022-09-13 Computable Name: NJSAMSOrganization

NJSAMS Organization

The NJSAMS Organization profile represents the care providers offering services to NJSAMS patients.

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 11 elements (6 nested mandatory elements)
Must-Support: 8 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

This structure is derived from USCoreOrganizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... Slices for identifier 1..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:agencyId S1..1IdentifierIdentifier for NJSAMS Provider Agency
..... system 0..1uriThe namespace for the identifier value
Required Pattern: http://dhs.nj.gov/njsams/agency-id
..... value 0..1stringThe value that is unique
.... identifier:federalId S0..1IdentifierFederal Identifier for NJSAMS Provider Agency
..... system 0..1uriThe namespace for the identifier value
Required Pattern: http://dhs.nj.gov/njsams/federal-id
..... value 0..1stringThe value that is unique
... active 1..1booleanWhether the organization's record is still in active use
... name 1..1stringName used for the organization
.... telecom:phone S1..1ContactPointA contact detail for the organization
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: phone
.... telecom:email S0..1ContactPointA contact detail for the organization
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: email
.... telecom:fax S0..1ContactPointA contact detail for the organization
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: fax
.... telecom:website S0..1ContactPointA contact detail for the organization
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: url
... address 1..1AddressAn address for the organization
.... line 1..2stringStreet name, number, direction & P.O. Box etc.
.... city 1..1stringName of city, town etc.
.... district S1..1stringDistrict name (aka county)
.... state 1..1stringSub-unit of country (abbreviations ok)
.... postalCode 1..1stringUS Zip Codes
... contact 0..2BackboneElementContact for the organization for a certain purpose
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... job-title S1..1stringExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactJobTitle
.... name 1..1HumanNameA name associated with the contact

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*USCoreOrganizationProfileA 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
... Slices for identifier SΣC1..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣC0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... id0..1idUnique 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 ΣC0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... id0..1idUnique 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:agencyId SΣC1..1IdentifierIdentifier for NJSAMS Provider Agency
..... id 0..1stringUnique 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): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ0..1uriThe namespace for the identifier value
Required Pattern: http://dhs.nj.gov/njsams/agency-id
..... value Σ0..1stringThe value that is unique
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)
.... identifier:federalId SΣC0..1IdentifierFederal Identifier for NJSAMS Provider Agency
..... id 0..1stringUnique 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): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ0..1uriThe namespace for the identifier value
Required Pattern: http://dhs.nj.gov/njsams/federal-id
..... value Σ0..1stringThe value that is unique
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 ?!SΣ1..1booleanWhether the organization's record is still in active use
... type Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example): Used to categorize the organization.


... name SΣC1..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
... Slices for telecom SC1..4ContactPointA contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... id 0..1stringUnique 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): Telecommunications form for contact point.

..... value SΣ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:phone SC1..1ContactPointA 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ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value SΣ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 SC0..1ContactPointA 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ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
..... value SΣ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:fax SC0..1ContactPointA 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ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: fax
..... value SΣ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:website SC0..1ContactPointA 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ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: url
..... value SΣ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 SC1..1AddressAn address for the organization
.... 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Σ1..2stringStreet 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Σ1..1stringName of city, town etc.
Example General: Erewhon
.... district SΣ1..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ1..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ1..1stringUS Zip Codes
Example General: 9132
.... country SΣ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 0..2BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... job-title S1..1stringExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactJobTitle
.... 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 1..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... Slices for identifier ΣC1..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI ΣC0..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:agencyId ΣC1..1IdentifierIdentifier for NJSAMS Provider Agency
.... identifier:federalId ΣC0..1IdentifierFederal Identifier for NJSAMS Provider Agency
... active ?!Σ1..1booleanWhether the organization's record is still in active use
... name ΣC1..1stringName used for the organization
.... telecom:All Slices Content/Rules for all slices
..... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value Σ0..1stringThe actual contact point details
.... telecom:phone C1..1ContactPointA contact detail for the organization
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value Σ0..1stringThe actual contact point details
.... telecom:email C0..1ContactPointA contact detail for the organization
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
..... value Σ0..1stringThe actual contact point details
.... telecom:fax C0..1ContactPointA contact detail for the organization
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: fax
..... value Σ0..1stringThe actual contact point details
.... telecom:website C0..1ContactPointA contact detail for the organization
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: url
..... value Σ0..1stringThe actual contact point details
... address C1..1AddressAn address for the organization
.... line Σ1..2stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
.... city Σ1..1stringName of city, town etc.
.... district Σ1..1stringDistrict name (aka county)
.... state Σ1..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode Σ1..1stringUS Zip Codes
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... contact 0..2BackboneElementContact for the organization for a certain purpose
.... job-title 1..1stringExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactJobTitle

doco Documentation for this format

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 11 elements (6 nested mandatory elements)
Must-Support: 8 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from USCoreOrganizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... Slices for identifier 1..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:agencyId S1..1IdentifierIdentifier for NJSAMS Provider Agency
..... system 0..1uriThe namespace for the identifier value
Required Pattern: http://dhs.nj.gov/njsams/agency-id
..... value 0..1stringThe value that is unique
.... identifier:federalId S0..1IdentifierFederal Identifier for NJSAMS Provider Agency
..... system 0..1uriThe namespace for the identifier value
Required Pattern: http://dhs.nj.gov/njsams/federal-id
..... value 0..1stringThe value that is unique
... active 1..1booleanWhether the organization's record is still in active use
... name 1..1stringName used for the organization
.... telecom:phone S1..1ContactPointA contact detail for the organization
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: phone
.... telecom:email S0..1ContactPointA contact detail for the organization
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: email
.... telecom:fax S0..1ContactPointA contact detail for the organization
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: fax
.... telecom:website S0..1ContactPointA contact detail for the organization
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: url
... address 1..1AddressAn address for the organization
.... line 1..2stringStreet name, number, direction & P.O. Box etc.
.... city 1..1stringName of city, town etc.
.... district S1..1stringDistrict name (aka county)
.... state 1..1stringSub-unit of country (abbreviations ok)
.... postalCode 1..1stringUS Zip Codes
... contact 0..2BackboneElementContact for the organization for a certain purpose
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... job-title S1..1stringExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactJobTitle
.... name 1..1HumanNameA name associated with the contact

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*USCoreOrganizationProfileA 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
... Slices for identifier SΣC1..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣC0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... id0..1idUnique 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 ΣC0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... id0..1idUnique 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:agencyId SΣC1..1IdentifierIdentifier for NJSAMS Provider Agency
..... id 0..1stringUnique 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): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ0..1uriThe namespace for the identifier value
Required Pattern: http://dhs.nj.gov/njsams/agency-id
..... value Σ0..1stringThe value that is unique
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)
.... identifier:federalId SΣC0..1IdentifierFederal Identifier for NJSAMS Provider Agency
..... id 0..1stringUnique 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): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ0..1uriThe namespace for the identifier value
Required Pattern: http://dhs.nj.gov/njsams/federal-id
..... value Σ0..1stringThe value that is unique
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 ?!SΣ1..1booleanWhether the organization's record is still in active use
... type Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example): Used to categorize the organization.


... name SΣC1..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
... Slices for telecom SC1..4ContactPointA contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... id 0..1stringUnique 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): Telecommunications form for contact point.

..... value SΣ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:phone SC1..1ContactPointA 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ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value SΣ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 SC0..1ContactPointA 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ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
..... value SΣ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:fax SC0..1ContactPointA 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ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: fax
..... value SΣ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:website SC0..1ContactPointA 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ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: url
..... value SΣ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 SC1..1AddressAn address for the organization
.... 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Σ1..2stringStreet 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Σ1..1stringName of city, town etc.
Example General: Erewhon
.... district SΣ1..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ1..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ1..1stringUS Zip Codes
Example General: 9132
.... country SΣ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 0..2BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... job-title S1..1stringExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactJobTitle
.... 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 1..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... 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

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Organization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Organization.identifier:agencyId.userequiredIdentifierUse
Organization.identifier:agencyId.typeextensibleIdentifier Type Codes
Organization.identifier:federalId.userequiredIdentifierUse
Organization.identifier:federalId.typeextensibleIdentifier Type Codes
Organization.typeexampleOrganizationType
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.telecom:phone.systemrequiredPattern: phone
Organization.telecom:phone.userequiredContactPointUse
Organization.telecom:email.systemrequiredPattern: email
Organization.telecom:email.userequiredContactPointUse
Organization.telecom:fax.systemrequiredPattern: fax
Organization.telecom:fax.userequiredContactPointUse
Organization.telecom:website.systemrequiredPattern: url
Organization.telecom:website.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes
Organization.contact.purposeextensibleContactEntityType

Constraints

IdGradePathDetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeOrganizationA resource should have narrative for robust management
: text.`div`.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
ele-1errorOrganization.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorOrganization.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorOrganization.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorOrganization.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorOrganization.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.identifier:NPIAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.identifier:CLIAAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.identifier:agencyIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.identifier:agencyId.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorOrganization.identifier:agencyId.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorOrganization.identifier:agencyId.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.identifier:agencyId.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.identifier:agencyId.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.identifier:agencyId.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.identifier:agencyId.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.identifier:agencyId.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.identifier:federalIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.identifier:federalId.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorOrganization.identifier:federalId.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorOrganization.identifier:federalId.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.identifier:federalId.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.identifier:federalId.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.identifier:federalId.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.identifier:federalId.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.identifier:federalId.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.aliasAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
ele-1errorOrganization.telecom.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorOrganization.telecom.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorOrganization.telecom.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:phoneAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
org-3errorOrganization.telecom:phoneThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
ele-1errorOrganization.telecom:phone.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorOrganization.telecom:phone.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorOrganization.telecom:phone.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:phone.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:phone.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:phone.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:phone.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:emailAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
org-3errorOrganization.telecom:emailThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
ele-1errorOrganization.telecom:email.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorOrganization.telecom:email.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorOrganization.telecom:email.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:email.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:email.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:email.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:email.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:faxAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
org-3errorOrganization.telecom:faxThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
ele-1errorOrganization.telecom:fax.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorOrganization.telecom:fax.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorOrganization.telecom:fax.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:fax.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:fax.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:fax.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:fax.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:websiteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
org-3errorOrganization.telecom:websiteThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
ele-1errorOrganization.telecom:website.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorOrganization.telecom:website.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorOrganization.telecom:website.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:website.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:website.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:website.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.telecom:website.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
ele-1errorOrganization.address.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorOrganization.address.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorOrganization.address.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.address.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.address.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.address.lineAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.address.cityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.address.districtAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.address.stateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.address.postalCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.address.countryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.address.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.contact.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorOrganization.contact.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorOrganization.contact.extension:job-titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorOrganization.contact.extension:job-titleMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorOrganization.contact.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorOrganization.contact.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorOrganization.contact.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.contact.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.contact.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.contact.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorOrganization.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())