2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile: USLabCCTarget

The official URL for this profile is: 

http://hl7.org/fhir/Profile/org-uslab-uslabcctarget

. Copy to Organization

This profile was published on Mon, Nov 17, 2014 00:00+1100 as a draft by HL7 International - Orders and Observations WG.

Generating text summary of fixed value not yet done for type org.hl7.fhir.instance.model.Identifier

Formal Views of Profile Content

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

Differential View

This structure is derived from Organization.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I1..1Copy to Organization
inv-1: Shall have Organization.name and/or Organization.identifier.
... text S1..1
.... status S1..1codeFixed Value: generated
... identifier S I0..1IdentifierRequired Pattern: {"use":"official","label":"NPI","assigner":{"reference":"https://nppes.cms.hhs.gov/NPPES/","display":"The Centers for Medicare and Medicaid Services (CMS) National Plan and Provider Enumeration System (NPPES"}}
.... value S1..1NPI organization Identifier
... name S I0..1
... telecom S1..*
.... system S1..1
.... value S1..1
... address S1..*
.... use S0..1
.... line S0..2
.... city S0..1
.... state S0..1Binding: USPSState (required, extensible)
.... postalCode S I0..1US Zip Codes
inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
.... country S0..1ISO 3166 3 letter Country Code
Binding: USLabCountry (required, extensible)
... contact S0..1Medical Director
.... name S0..1HumanName
..... family S1..1
..... given S0..2
..... prefix S0..1
..... suffix S0..1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I1..1Copy to Organization
org-1: The organization SHALL at least have a name or an id, and possibly more than one
inv-1: Shall have Organization.name and/or Organization.identifier.
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text S I1..1NarrativeText summary of the resource, for human interpretation
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... status S1..1codegenerated | extensions | additional
Binding: NarrativeStatus (required, not extensible)
Fixed Value: generated
.... div I1..1xhtmlLimited xhtml content
txt-2: The narrative SHALL have some non-whitespace content
txt-1: The narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
txt-3: The narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier S I0..1IdentifierIdentifies this organization across multiple systems
Required Pattern: {"use":"official","label":"NPI","assigner":{"reference":"https://nppes.cms.hhs.gov/NPPES/","display":"The Centers for Medicare and Medicaid Services (CMS) National Plan and Provider Enumeration System (NPPES"}}
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required, not extensible)
.... label 0..1stringDescription of identifier
.... system 0..1uriThe namespace for the identifier
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
.... value S1..1stringNPI organization Identifier
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... name S I0..1stringName used for the organization
... type 0..1CodeableConceptKind of organization
Binding: OrganizationType (example, extensible)
... telecom S I1..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S I1..1codephone | fax | email | url
Binding: ContactPointSystem (required, not extensible)
.... value S1..1stringThe actual contact point details
.... use M0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required, not extensible)
.... period 0..1PeriodTime period when the contact point was/is in use
... address S I1..*AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M S0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required, not extensible)
Example: home
.... text 0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line S0..2stringStreet name, number, direction & P.O. Box etc
Example: 137 Nowhere Street
.... city S0..1stringName of city, town etc.
Example: Erewhon
.... state S0..1stringSub-unit of country (abreviations ok)
Binding: USPSState (required, extensible)
.... postalCode S I0..1stringUS Zip Codes
inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
.... country S0..1stringISO 3166 3 letter Country Code
Binding: USLabCountry (required, extensible)
.... period 0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... partOf 0..1OrganizationThe organization of which this organization forms a part
... contact S0..1Medical Director
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactPartyType (preferred, extensible)
.... name S0..1HumanNameA name associated with the contact
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use M0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required, not extensible)
..... text 0..1stringText representation of the full name
..... family S1..1stringFamily name (often called 'Surname')
..... given S0..2stringGiven names (not always 'first'). Includes middle names
..... prefix S0..1stringParts that come before the name
..... suffix S0..1stringParts that come after the name
..... period 0..1PeriodTime period when name was/is in use
.... telecom 0..*ContactPointContact details (telephone, email, etc) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required, not extensible)
... location 0..*LocationLocation(s) the organization uses to provide services
... active M0..1booleanWhether the organization's record is still in active use

XML Template

JSON Template

todo

Differential View

This structure is derived from Organization.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I1..1Copy to Organization
inv-1: Shall have Organization.name and/or Organization.identifier.
... text S1..1
.... status S1..1codeFixed Value: generated
... identifier S I0..1IdentifierRequired Pattern: {"use":"official","label":"NPI","assigner":{"reference":"https://nppes.cms.hhs.gov/NPPES/","display":"The Centers for Medicare and Medicaid Services (CMS) National Plan and Provider Enumeration System (NPPES"}}
.... value S1..1NPI organization Identifier
... name S I0..1
... telecom S1..*
.... system S1..1
.... value S1..1
... address S1..*
.... use S0..1
.... line S0..2
.... city S0..1
.... state S0..1Binding: USPSState (required, extensible)
.... postalCode S I0..1US Zip Codes
inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
.... country S0..1ISO 3166 3 letter Country Code
Binding: USLabCountry (required, extensible)
... contact S0..1Medical Director
.... name S0..1HumanName
..... family S1..1
..... given S0..2
..... prefix S0..1
..... suffix S0..1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I1..1Copy to Organization
org-1: The organization SHALL at least have a name or an id, and possibly more than one
inv-1: Shall have Organization.name and/or Organization.identifier.
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text S I1..1NarrativeText summary of the resource, for human interpretation
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... status S1..1codegenerated | extensions | additional
Binding: NarrativeStatus (required, not extensible)
Fixed Value: generated
.... div I1..1xhtmlLimited xhtml content
txt-2: The narrative SHALL have some non-whitespace content
txt-1: The narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
txt-3: The narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier S I0..1IdentifierIdentifies this organization across multiple systems
Required Pattern: {"use":"official","label":"NPI","assigner":{"reference":"https://nppes.cms.hhs.gov/NPPES/","display":"The Centers for Medicare and Medicaid Services (CMS) National Plan and Provider Enumeration System (NPPES"}}
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required, not extensible)
.... label 0..1stringDescription of identifier
.... system 0..1uriThe namespace for the identifier
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
.... value S1..1stringNPI organization Identifier
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... name S I0..1stringName used for the organization
... type 0..1CodeableConceptKind of organization
Binding: OrganizationType (example, extensible)
... telecom S I1..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S I1..1codephone | fax | email | url
Binding: ContactPointSystem (required, not extensible)
.... value S1..1stringThe actual contact point details
.... use M0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required, not extensible)
.... period 0..1PeriodTime period when the contact point was/is in use
... address S I1..*AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M S0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required, not extensible)
Example: home
.... text 0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line S0..2stringStreet name, number, direction & P.O. Box etc
Example: 137 Nowhere Street
.... city S0..1stringName of city, town etc.
Example: Erewhon
.... state S0..1stringSub-unit of country (abreviations ok)
Binding: USPSState (required, extensible)
.... postalCode S I0..1stringUS Zip Codes
inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
.... country S0..1stringISO 3166 3 letter Country Code
Binding: USLabCountry (required, extensible)
.... period 0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... partOf 0..1OrganizationThe organization of which this organization forms a part
... contact S0..1Medical Director
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactPartyType (preferred, extensible)
.... name S0..1HumanNameA name associated with the contact
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use M0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required, not extensible)
..... text 0..1stringText representation of the full name
..... family S1..1stringFamily name (often called 'Surname')
..... given S0..2stringGiven names (not always 'first'). Includes middle names
..... prefix S0..1stringParts that come before the name
..... suffix S0..1stringParts that come after the name
..... period 0..1PeriodTime period when name was/is in use
.... telecom 0..*ContactPointContact details (telephone, email, etc) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required, not extensible)
... location 0..*LocationLocation(s) the organization uses to provide services
... active M0..1booleanWhether the organization's record is still in active use

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
Organization.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Organization.text.statusNarrativeStatusrequiredNarrativeStatus
Organization.identifier.useIdentifierUserequiredIdentifierUse
Organization.typeOrganizationTypeexample (extensible)OrganizationType
Organization.telecom.systemContactPointSystemrequiredContactPointSystem
Organization.telecom.useContactPointUserequiredContactPointUse
Organization.address.useAddressUserequiredAddressUse
Organization.address.stateUSPSStaterequired (extensible)USPS Two Letter Alphabetic Codes
Organization.address.countryUSLabCountryrequired (extensible)USLabCountry
Organization.contact.purposeContactPartyTypepreferred (extensible)ContactEntityType
Organization.contact.name.useNameUserequiredNameUse
Organization.contact.genderAdministrativeGenderrequiredAdministrativeGender

Constraints

IdPathNameDetails
org-1OrganizationAtLeastANameOrIdThe organization SHALL at least have a name or an id, and possibly more than one
XPath: count(f:identifier | f:name) > 0
inv-1OrganizationNameandorIDShall have Organization.name and/or Organization.identifier.
XPath: exists(f:name) or exists(f:identifier)
txt-2Organization.text.divThe narrative SHALL have some non-whitespace content
XPath: descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src]
txt-1Organization.text.divThe narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
XPath: not(descendant-or-self::*[not(local-name(.)=('a', 'abbr', 'acronym', 'b', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'colgroup', 'dd', 'dfn', 'div', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var'))])
txt-3Organization.text.divThe narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
XPath: not(descendant-or-self::*/@*[not(name(.)=('abbr', 'accesskey', 'align', 'alt', 'axis', 'bgcolor', 'border', 'cellhalign', 'cellpadding', 'cellspacing', 'cellvalign', 'char', 'charoff', 'charset', 'cite', 'class', 'colspan', 'compact', 'coords', 'dir', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', 'id', 'lang', 'longdesc', 'name', 'nowrap', 'rel', 'rev', 'rowspan', 'rules', 'scope', 'shape', 'span', 'src', 'start', 'style', 'summary', 'tabindex', 'title', 'type', 'valign', 'value', 'vspace', 'width'))])
org-3Organization.telecomNoHomeUseTelecomThe telecom of an organization can never be of use 'home'
XPath: count(f:use[@value='home']) = 0
org-2Organization.addressNoHomeUseAddressAn address of an organization can never be of use 'home'
XPath: count(f:use[@value='home']) = 0
inv-2Organization.address.postalCodeRegex for Zip(Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
XPath: f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )
.