Argonaut Provider Directory CI Build

SD.3 StructureDefinition-argo-organization

This profile sets minimum expectations for the Organization resource to searching for and fetching a Organization associated with a patient or provider. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Organization must have:

  1. A name
  2. An identifier
  3. A status of the organization
  4. A list of contact information
  5. Endpoint information

Profile specific implementation guidance:

  • A server SHALL support the _include parameter when retrieving a Location resource.
Examples

SD.3.1 Formal Views of Profile Content

The official URL for this profile is:

http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-organization

This profile builds on Organization.

This profile was published on Wed Nov 09 00:00:00 UTC 2016 as a draft by Argonaut Project.

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

Complete Summary of the Mandatory Requirements

  1. At least one identifier in Organization.identifier
    • NPI preferred
    • Tax id is allowed
    • Local id is allowed in addition to ‘authoritative’ identifier
  2. One status in Organization.active
  3. One name in Organization.name (MAY have additional names in Organization.alias)
  4. At least one contact in Organization.telecom
  5. At least one address in Organization.address
  6. At least one reference to Endpoint resource in Organization.endpoint
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*Argonaut Provider Directory Organization
... identifier S1..*Identifier
.... system S1..1uriExample General': NPI preferred, Tax id is allowed, Local id is allowed in addition to 'authoritative' identifier
... active S1..1boolean
... name S1..1string
... telecom S1..*ContactPoint
... address S1..*Address
.... line S0..*string
.... city S0..1string
.... state S0..1stringBinding: USPS Two Letter Alphabetic Codes (required)
.... postalCode S0..1stringUS Zip Codes
... endpoint S0..*Reference(http://fhir.org/guides/argonaut-pd/StructureDefinition-argo-endpoint)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*Argonaut Provider Directory Organization
... 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..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ΣI1..*IdentifierIdentifies this organization across multiple systems
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ1..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
Example General': NPI preferred, Tax id is allowed, Local id is allowed in addition to 'authoritative' identifier
.... 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)
... name SΣI1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SI1..*ContactPointA contact detail for the organization
... address SI1..*AddressAn address for the organization
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General': 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required)
.... postalCode SΣ0..1stringUS Zip Codes
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 I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringxml: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: ContactEntityType (extensible)
.... name 0..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 S0..*Reference(http://fhir.org/guides/argonaut-pd/StructureDefinition-argo-endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Complete Summary of the Mandatory Requirements

  1. At least one identifier in Organization.identifier
    • NPI preferred
    • Tax id is allowed
    • Local id is allowed in addition to ‘authoritative’ identifier
  2. One status in Organization.active
  3. One name in Organization.name (MAY have additional names in Organization.alias)
  4. At least one contact in Organization.telecom
  5. At least one address in Organization.address
  6. At least one reference to Endpoint resource in Organization.endpoint

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*Argonaut Provider Directory Organization
... identifier S1..*Identifier
.... system S1..1uriExample General': NPI preferred, Tax id is allowed, Local id is allowed in addition to 'authoritative' identifier
... active S1..1boolean
... name S1..1string
... telecom S1..*ContactPoint
... address S1..*Address
.... line S0..*string
.... city S0..1string
.... state S0..1stringBinding: USPS Two Letter Alphabetic Codes (required)
.... postalCode S0..1stringUS Zip Codes
... endpoint S0..*Reference(http://fhir.org/guides/argonaut-pd/StructureDefinition-argo-endpoint)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*Argonaut Provider Directory Organization
... 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..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ΣI1..*IdentifierIdentifies this organization across multiple systems
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ1..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
Example General': NPI preferred, Tax id is allowed, Local id is allowed in addition to 'authoritative' identifier
.... 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)
... name SΣI1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SI1..*ContactPointA contact detail for the organization
... address SI1..*AddressAn address for the organization
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General': 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required)
.... postalCode SΣ0..1stringUS Zip Codes
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 I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringxml: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: ContactEntityType (extensible)
.... name 0..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 S0..*Reference(http://fhir.org/guides/argonaut-pd/StructureDefinition-argo-endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron

 

SD.3.2 - Quick Start

Below is an overview of the required search and read operations for this profile. See the Conformance requirements for a complete list of supported RESTful operations and search parameters for this IG.


GET [base]/Organization?identifier=[system]|[code]

Example: GET [base]/Organization?identifier=http://hospital.smarthealthit.org/Organization|103270514

Support: Mandatory to search by identifier.

Implementation Notes: Search based on Organization identifier (how to search by token).


GET [base]/Organization?name=[string]

Example: GET [base]/Organization?name=Health system

Support: Mandatory to support search by Organization name.

Implementation Notes: Search based on text name (how to search by string).


GET [base]/Organization?address=[string]

Example: GET [base]/Organization?address=Arbor

Example: GET [base]/ORganization?address-postalcode=48104

Support: Mandatory to support search by address.

Implementation Notes: Search based on text address (how to search by string).

SHOULD support the following search parameters:

  • address-city
  • address-state
  • address-postalcode