SD.6 StructureDefinition-dpc-profile-patient
The profile defines the required format for a Patient resource submitted by an Organization as a part of their patient rostering workflow. 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 Patient must have:
- an id
- a Medicare Beneficiary ID (MBI)
- a given name
- a family name
- a birth date
- a Managing Organization
Examples
SD.6.1 Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: https://dpc.cms.gov/api/v1/StructureDefinition/dpc-profile-patient
Published on Wed Apr 21 11:33:40 EDT 2021 as a draft by The DPC Team.
This profile builds on Patient
Summary
Mandatory: 7 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
- The element Patient.identifier is sliced based on the value of value:system
Differential View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() | 0..* | (Slice Definition) | An identifier for this patient Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() | 1..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-mbi | |
![]() ![]() ![]() | 1..* | HumanName | A name associated with the patient | |
![]() ![]() ![]() ![]() | 1..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() | 1..* | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() | 1..1 | code | male | female | other | unknown | |
![]() ![]() ![]() | 1..1 | date | The date of birth for the individual | |
![]() ![]() ![]() | 0..1 | Reference(DPC Organization) | Organization that is the custodian of the patient record | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | Patient | Information about an individual or animal receiving health care services |
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages | |
![]() ![]() ![]() | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 0..* | (Slice Definition) | An identifier for this patient Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() | Σ | 1..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-mbi |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() | Σ | 1..* | HumanName | A name associated with the patient |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the full name |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() | Σ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when name was/is in use |
![]() ![]() ![]() | Σ | 0..* | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() | Σ | 1..1 | date | The date of birth for the individual |
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() | Σ | 0..* | Address | Addresses for the individual |
![]() ![]() ![]() | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible) | |
![]() ![]() ![]() | 0..1 | Whether patient is part of a multiple birth | ||
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | integer | |||
![]() ![]() ![]() | 0..* | Attachment | Image of the patient | |
![]() ![]() ![]() | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | The kind of relationship Binding: v2 Contact Role (extensible) | |
![]() ![]() ![]() ![]() | 0..1 | HumanName | A name associated with the contact person | |
![]() ![]() ![]() ![]() | 0..* | ContactPoint | A contact detail for the person | |
![]() ![]() ![]() ![]() | 0..1 | Address | Address for the contact person | |
![]() ![]() ![]() ![]() | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | |
![]() ![]() ![]() ![]() | I | 0..1 | Reference(Organization) | Organization that is associated with the contact |
![]() ![]() ![]() ![]() | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
![]() ![]() ![]() | ?!ΣI | 0..1 | BackboneElement | This patient is known to be an animal (non-human) |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | E.g. Dog, Cow Binding: AnimalSpecies (example) |
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | E.g. Poodle, Angus Binding: AnimalBreeds (example) |
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | E.g. Neutered, Intact Binding: GenderStatus (example) |
![]() ![]() ![]() | I | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages (extensible) Max Binding: All Languages | |
![]() ![]() ![]() ![]() | 0..1 | boolean | Language preference indicator | |
![]() ![]() ![]() | 0..* | Reference(Organization | Practitioner) | Patient's nominated primary care provider | |
![]() ![]() ![]() | Σ | 0..1 | Reference(DPC Organization) | Organization that is the custodian of the patient record |
![]() ![]() ![]() | ?!ΣI | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() ![]() | Σ | 1..1 | code | replaced-by | replaces | refer | seealso - type of link Binding: LinkType (required) |
![]() |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron